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.
- Review the Setup Guide to configure your development and production environments.
- Obtain your API Key from your CLC representative.
- Use the Sandbox Environment to test your integration before going live.
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.
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.
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 section for troubleshooting steps. You can also check the status of any pending request using the GET /api/v1/reservation/status/{requestId} endpoint.
The API uses an API Key for authentication. Include your X-Api-Key in the request header for every API call:
-H "X-Api-Key: your-api-key-here"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.
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.
The PMS API is designed to handle requests within a few seconds. However, response times may vary depending on the network and system load.
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 section.
For technical assistance, contact our support team at support@yourcompany.com. Include your API key, the endpoint in question, and any relevant error messages.
Yes, our Live Chat is available during business hours. Visit the Support Page for more details.
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.
A "Pending" status means the request is being processed. You can poll the GET /api/v1/reservation/status/{requestId} endpoint to check for updates.
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.
If your question isn’t listed here, feel free to contact our support team. We’re here to help!