We’re improving the API experience
07-Dec-2022
Takeaway
- Introducing the New API experience improvement project, built with our providers in mind
- We recently migrated all our existing products to a newer architecture – resulting in more consistent, secure and stable APIs
- We’ll introduce the updated APIs in stages, with each phase dedicated to one API
- There will be no changes to how your properties function but you might need to adjust minor things in the API on your end
As part of our efforts to provide the best possible experience to you and our mutual property partners, we’ve undertaken the API experience improvement project. As part of this, we’re making sure that our APIs perform consistently, securely, simply and in a modular and stable way, as well as fixing any bugs.. This overarching project includes API modernisation and API behaviour improvement initiatives, the details of which are outlined in this article.
API modernisation
Within the overarching API experience improvement project, the API modernisation initiative resulted in migrating all our existing products to a newer architecture. You’ll now experience more consistent, secure and stable APIs.
We undertook the effort of modernising our APIs with the intent of making them:
- Consistent – will behave the same for all providers using the same version
- Secure – will have token-based or security-supported authentication
- Simple – will be easy to implement and integrate with your systems quicker
- Modular – will be easier to add new features and move to other services
- Stable – will have clearly defined and upheld ‘Service Level Objectives’
The API modernisation initiative will cover all existing APIs and apply to new APIs released in the future.
API behaviour improvement
This ongoing initiative analyses the behaviour of existing APIs and makes changes wherever necessary to improve the overall experience. Essentially, it identifies incorrect behaviour observed in APIs and changes it to reflect what’s in the technical documentation. We’ll introduce the updated APIs in stages, with each phase dedicated to one API.
Firstly, we’ll send you an email informing you of the live date (when the API change will come into effect). On each live date, you’ll be able to implement the new endpoint, but we’ll also offer you a test endpoint which you can use to test the new behaviour. This testing period will run for 45 working days, during which you can flag any issues or if you’ve spotted any errors.
To start, we will be rolling out updates to the Room and Rate Availability (RRA) endpoint. This update will only affect you if you are a user of the RRA endpoint. The timeline of this is as follows:
- Announcement of updates: 28 November 2022
- Test endpoint availability date: 14 November 2022
- Final updates rollout date: 13 February 2023
If you’re a user of the RRA endpoint, details of the changes and the actions you might have to take are explained in this migration guide. Please note that if you are not a user of the RRA endpoint, the updates will not impact any of your other APIs.
What the API experience improvement project means for you
The outcome of this project will not impact how your properties function, but you might need to adjust minor things in each updated API. We will share detailed documentation on how to do this when introducing each update.
After reviewing the email announcing the endpoint and its changes, you can either choose to adapt to the new endpoint (once live) or you can trial the API beforehand using the test endpoint, flagging any concerns you have.
Please contact your Partner Business Manager or our Connectivity Support team if you have any issues or questions on the above by filling out this form.