This Clock handbook provides all the necessary information to onboard a hotel using Clock PMS for the Stay Data API. The topics include the onboarding process, specifications, the supported version, etc.
This handbook for Clock PMS covers the following topics:
Specifications around requirements for the integration
Reports scheduler (timings/latency)
What is the difference between the two API versions?
What kind of help/support will I have?
How is the data transmitted from the PMS to me?
Supported endpoints
- The best way to review which endpoints are supported by our API is by having a look through our documentation. By hovering over the highlighted fields you can see which specific data field is supported by Clock. If you are looking for specific endpoints our support table is also a handy tool for quickly being able to find supported resources. Please click on the plus sign on the top right and scroll through there to select the different PMS you would like to view.
Onboarding process
- The onboarding process is completed by the Impala team, no need to connect to the hotel via remote session.
- Once you request the hotel through our management console you will be sent an email to send on to the hotel which will include a short self onboarding guide for the hotel to complete, this should take the hotel a maximum of 10 minutes, and requires no technical knowledge.
- As soon as the hotel has completed they will have the following information which must be sent back to us:
- Hotel Name
- User Name
- API access key
- User Base Api Url
- Once we have received this information, we will take care of the rest and the integration should be live within 1 working day.
- The service to the hotel is not interrupted in any way.
Specifications around requirements for the integrations
- The user completing the self onboarding guide should have admin rights - the ability to add new users. (Generally Front Desk Managers, IT Managers, Revenue Managers, or General Managers)
Reports scheduler (timings/latency)
- Push notification:
- We receive a push notification from Clock PMS when resources are updated. As a result, we can receive almost instant (1-3 min) updates to the bookings.
- Once a day:
- Bookings that have been created or updated in the last 7 days.
- Rate plans
- Every 15 mins
- Rates
What is the difference between the two API versions?
- You have the option of choosing which API version you would like when you create an application in the management console.
- 2018-11-27 - This is the default version and available for all integrations.
- 2019-04-23 - Available to all integrations with the exception of Infor.
- Please note that you are unable to downgrade your API version, you can find the differences between the two versions outlined here.
Versions supported
- We support Clock PMS Suite.
What kind of help/support will I have?
- The Impala support team will be on hand to assist you with any questions or concerns; technical, commercial, and throughout the onboarding process. We can be reached through support@impala.travel between 8:30am and 5:30pm (UK business hours) Monday through Friday.
How is the data transmitted from the PMS to me? GDPR/security
- We have built a direct integration with Clock, and we use their official APIs to transmit hotel data.
- Impala is fully GDPR compliant and dedicated to data security.
- Please find further detail here regarding our GDPR compliance and data minimisation methods.
One or two way integration?
- Our integration will allow you to read data from Clock PMS. Please contact support if you require two way integration for Clock.
Certification
- We work directly with the Clock PMS to provide your API integration.
Additional costs?
- There are no additional costs from the side of Clock.
PMS involvement
- Once the hotel has completed the self onboarding guide and sent us the information we need, we reach out to Clock to complete the integration.