# Frequently Asked Questions

## General Questions

### What is the purpose of the PMS API?

The **PMS API** is designed to streamline the process of managing CLC guest reservations. It allows Property Management Systems (PMS) to seamlessly communicate check-in, check-out, and reservation data to CLC systems, reducing manual entry and improving data accuracy.

## Integration Questions

### How do I get started with the PMS API?

1. Review the [Setup Guide](#setup-guide) to configure your development and production environments.
2. Obtain your **API Key** from your CLC representative.
3. Use the **Sandbox Environment** to test your integration before going live.


### What endpoints are available in the PMS API?

The API includes the following key endpoints:

- `POST /api/v1/card/authorize` – Authorises membership cards.
- `POST /api/v1/reservation/checkin` – Records a guest check-in.
- `POST /api/v1/reservation/checkout` – Records a guest check-out.
- `GET /api/v1/reservation/status/{requestId}` – Retrieves the status of a reservation request.


For more details, visit the [API Reference](#api-reference).

## Functional Questions

### Can I check in a guest without a reservation in the PMS?

Yes, but it requires manual data entry. For such scenarios, the front desk will need to use the `POST /api/v1/card/authorize` endpoint to validate the guest’s membership and then create a check-in record.

### What happens if a request fails?

If a request fails, the API will return an appropriate error code (e.g., `400 Bad Request`, `404 Not Found`, or `500 Internal Server Error`). Refer to the [Error Codes](#error-codes) section for troubleshooting steps. You can also check the status of any pending request using the `GET /api/v1/reservation/status/{requestId}` endpoint.

## Technical Questions

### How does the API handle authentication?

The API uses an **API Key** for authentication. Include your `X-Api-Key` in the request header for every API call:


```bash
-H "X-Api-Key: your-api-key-here"
```

### Can I simulate errors in the sandbox environment?

Yes, the sandbox environment supports error simulation. You can use specific headers like `x-sandbox-status` to simulate different HTTP status codes and test your error-handling logic.

### How are requests linked in the API?

Each request is linked via a unique `authId` generated during card authorisation. This ensures that only valid, authorised guests can proceed to check-in and check-out operations.

## Operational Questions

### What is the expected response time for API calls?

The PMS API is designed to handle requests within a few seconds. However, response times may vary depending on the network and system load.

### How often should I poll the reservation status endpoint?

Polling frequency depends on your operational needs. For real-time updates, polling every 10-30 seconds is recommended. Be mindful of rate limits outlined in the [Rate Limits](#rate-limits) section.

## Support Questions

### Who should I contact for support?

For technical assistance, contact our support team at **`support@yourcompany.com`**. Include your **API key**, the **endpoint** in question, and any relevant error messages.

### Is there a live chat available for urgent issues?

Yes, our **Live Chat** is available during business hours. Visit the [Support Page](#support) for more details.

## Troubleshooting Questions

### I’m getting a 401 error. What should I do?

A `401 Unauthorized` error typically indicates an issue with your API key. Ensure:

- The API key is correct and has not expired.
- The key is included in the request header as `X-Api-Key`.


### My check-in request returns a "Pending" status. What does this mean?

A "Pending" status means the request is being processed. You can poll the `GET /api/v1/reservation/status/{requestId}` endpoint to check for updates.

## Future Enhancements

### Will additional endpoints be added in the future?

Yes, we plan to extend the API to support new functionalities, such as:

- Enhanced error logging and reporting.
- Direct integration with additional PMS systems.
- Expanded authentication scenarios for cardless reservations.


Stay tuned for updates in the [Change Log](#change-log).

If your question isn’t listed here, feel free to contact our support team. We’re here to help!