myHotel API Frequently Asked Questions
What is an API?
API is the acronym for “Application Programming Interface”. An “interface” is the way two applications or services communicate with each other. They do so by exposing to the other applications the set of services available in each one and how they are to be accessed. The set of these services is called API. Therefore, they are used so that one application can interact with another.
What does the myHotel API deliver?
The API exports key platform data generated across the various modules of the Fidelity Suite in JSON format. Your team can use this data payload to build custom dashboards in your preferred Business Intelligence (BI) tools (such as Power BI or Tableau). It is important to know that not everything that is in the platform is available in the API, only the main KPI's.
What kind of API does myHotel deliver?
This API is only for data query. That is to say, the hotel will not have the possibility to write information in our system or change any data that has been generated.
What does the hotel need to activate the API?
API Key: It must be requested through a support ticket from the myHotel platform. In case of a hotel group, this API Key works for all the hotels in the chain.
Documentation: You can review it here. It can also be obtained from Company Adjusts in Fidelity.
Fidelity user and password: We highly recommend creating a unique, dedicated system user profile purely for this API connection. If you connect using a standard staff member's account and that employee leaves the company or changes their password, the automated API data sync will break. For hotel groups, ensure this dedicated API user has master access permissions for all properties in the chain.
Access Key: It can be obtained from the hotel profile in Fidelity, it is unique per hotel. In case it is a hotel group, it must be considered that each hotel has a different Access key.
What to do if you have a problem connecting to the API?
You must send a support ticket from Fidelity indicating how they are making the API call, send evidence of the information you are using to connect and so our IT support team replicates the error to find the solution. In case it is a bigger problem, or you don't understand the API parameters, a meeting with myHotel team is arranged.