### Quick Start Guide for Roomex PMS API

### Step 1: Get API Access

1. **Sign Up**: Contact Roomex to request API credentials and access to the sandbox environment.
2. **Obtain Credentials**: You will receive:
  - Client ID
  - Client Secret


### Step 2: Authentication

Before using the API, you need to authenticate and obtain a bearer token.

##### Endpoint: POST /auth/token

##### Request Headers:


```json
{ "Content-Type": "application/json" }
```

##### Request Body:


```json
{   
  "client_id": "your-client-id",
  "client_secret": "your-client-secret" 
}
```

##### Response:


```json
{   
  "access_token": "your-access-token",   
  "expires_in": 3600 
}
```

##### Usage:

Include the access_token in the Authorisation header for subsequent requests:


```json
{   
  "Authorization": "Bearer your-access-token" 
}
```

### Step 3: Implement Core Workflows

##### Create a Check-In

##### Endpoint: POST /reservation/checkin

##### Request Body:


```json
{   
  "reservation_id": "12345",   
  "check_in_date": "2024-12-18",   
  "check_in_time": "15:00",   
  "room_number": "101",   
  "folio_number": "FN123" 
}
```

##### Response:


```json
{   
  "status": "success",   
  "message": "Check-in recorded successfully." 
}
```

#### Create a Check-Out

##### Endpoint: POST /reservation/checkout

##### Request Body:


```json
{   
  "reservation_id": "12345",   
  "check_out_date": "2024-12-20",   
  "check_out_time": "11:00" 
}
```

##### Response:


```json
{   
  "status": "success",   
  "message": "Check-out recorded successfully." 
}
```

#### Handle Errors

##### Endpoint: GET /errors/{errorId}

##### Purpose

Retrieve details about a specific error to resolve it effectively.

##### Response:


```json
{   
  "error_id": "E123",   
  "error_type": "Validation Error",   
  "description": "Invalid reservation ID." 
}
```

### Step 4: Testing Your Integration

**Use the Sandbox Environment**: All API endpoints are available in a sandbox environment for testing without impacting live data.

- Base URL: *https://sandbox.roomex.com/api/v1*


**Run Test Scenarios**:

- Simulate valid and invalid requests.
- Validate error handling and success responses.


### Step 5: Move to Production

**Certification**:

- Complete integration tests using Roomex’s **Integration Test Suite**.
- Submit test results for certification.


**Switch to Production**:

- Update your base URL to the production environment: *https://api.roomex.com/v1*
- Use live API credentials.


### Helpful Tips

- **Monitor Usage**: Set up logs to monitor API usage and ensure you meet rate limits.
- **Error Handling**: Always handle errors gracefully and retry failed requests where appropriate.
- **Keep Tokens Secure**: Store tokens securely and refresh them before expiration.


### Example Postman Setup

1. Download the Roomex PMS API [Postman Collection](https://roomex.atlassian.net/wiki/spaces/DT/pages/4428103811/Quick+Start+Guide#).
2. Import the collection into Postman.
3. Configure your environment variables:
  - {{base_url}}: https://sandbox.roomex.com/api/v1
  - {{access_token}}: Your generated token.


### Support

If you encounter any issues:

- Visit the [API Documentation](https://roomex.atlassian.net/wiki/spaces/DT/pages/4428103811/Quick+Start+Guide#).
- Reach out to Roomex support at [support@roomex.com](mailto:support@roomex.com).


By following this guide, you’ll have your PMS integrated with the Roomex API in no time. Happy coding!