Clerk data API allows a program to perform many of the operations offered in a Clerk hotel account. It is possible to search for available rooms, reservations, room types and also to visualize all the hotel basic information. Keeping in touch with Clerk features will be easier due to the instant access provided by web platforms, mobile phones and portable devices.
The data API is for developers who want to integrate Clerk functionalities in a desktop or a web application. This API is built based on the REST (Representational State Transfer) software architecture style. Methods can return data using the XML or JSON data formats.
How to use Clerk API?
If you want to create an application using Clerk API, first you need to be identified with your Hotel. After this step, you need to go to your profile located in the right top corner. You will see a menu called “Extras”. There you can get your API Key. You must always keep this code with you to develop your app.
Response Status Code
- 200: OK
- 401: Unauthorized. Returned when trying to execute an authenticated method without valid credentials.
- 405: Method not allowed. Returned when trying to execute with a wrong method (Example: using GET when you should be using POST)
- 404: Not Found. No method, or no data found.
- 500: API Error. There was an error when executing a method. The message field contains details of the error.