You can build your external website to manage guest bookings and integrate it with the Guesty Booking Engine via an API connection. The API integration allows you to pull data from the Booking Engine, such as checking your listing availability and creating reservations. See our full Booking Engine API documentation.
You can have an unlimited number of Booking Engines and up to five Booking Engine API instances. For a sandbox environment, you may only create one Booking Engine API instance.
To set up an API integration with the Guesty Booking Engine, start by creating a Booking Engine API instance.
Create an API instance
Follow the instructions below.
Step by step:
- Sign in to your Guesty account.
- In the side navigation menu, click
Marketing and sales to open the dropdown menu. - Under Channel management, select Distribution.
- Click the Guesty Booking Engine API card.
- At the top right, click Create a new API key.
- Enter a nickname for the instance and select Requests to book, Instant bookings, or Both. Then, click Next.
- Click Select properties to select the properties you want to include in the Booking Engine, then click Next.
- Click Save new API key.
- In the pop-up, click
to copy the "Client Secret credentials" and "Client ID credentials" and share them with your developer.
The "Client Secret" and "Client ID" allow external developers to access the selected content on the specific Booking Engine API. Share these keys only with trusted partners.
Edit an API instance
Step by step:
- Sign in to your Guesty account.
- In the side navigation menu, click Marketing and sales to open the dropdown menu.
- Under Channel management, select Distribution.
- Click the Guesty Booking Engine API card.
- To the right of the relevant instance, click
and then select Edit API key. - Edit the relevant fields.
- Click Save.
Frequently asked questions
Can you set up a test account and populate it for us to test the Booking Engine API?
A test account is a paid add-on that may be available. Contact your account manager to discuss whether it is an option for you. A test account is separate from your existing account, and data is not copied from the existing account to the test account. You will need to set up and test it for your specific test scenarios.
Your existing Guesty account lets you create test listings, so you may not need a test account.
Can you reset our Booking Engine API access token limits?
Guesty does not reset token limits. To keep things running smoothly, cache your token and monitor your response headers to track token expiration dates and the time remaining until expiration. If you have a spare Booking Engine API slot, create a new API key pair and configure it accordingly. You can use it as a backup until the limits on your primary key are reset.
Expired access tokens are different from token limits. Once a token expires, it cannot be reactivated. More detailed and helpful information is available on our developer portal. Start with the following articles: