What is an API?
An API (Application Programming Interface) acts as an intermediary that allows two systems to communicate with each other. In other words, it enables one application to request data or perform specific actions in another, allowing both systems to work together.
📝
Requirement: To use the API, you need to have a Pro Plan or an Elite Plan.
Not intended for standard third-party integrations: This API should not be used to connect portals, smart locks, or other third-party applications. In these cases, AvaiBook already offers integrations developed with partners and official portals.
Custom development: AvaiBook does not develop the integration. Our role is to provide the API Key and technical documentation. The implementation must be carried out by your own IT team.
Its purpose is simple: to connect applications so they can exchange information securely and automatically.
When might I need an API?
In most cases, using an API is not essential. AvaiBook already provides a customisable booking engine that can be adapted to your website or social media channels without the need for programming.
However, you may need the API if you have:
Your own management or invoicing software.
A specific PMS or CRM.
Your own booking engine.
Or any internal tool that you need to connect to AvaiBook to exchange data.
How does an API integration work?
AvaiBook will provide your developer with an API Key, which will allow them to securely access your account and set up communication between both platforms. We will also provide the necessary technical documentation in advance, explaining what information can be exchanged and how to do so correctly, helping to ensure that the integration process runs smoothly.
API Key generation
AvaiBook will provide your developer with an API Key, which will serve as the access credential for your account and allow them to set up communication between both platforms.Technical documentation
Before getting started, AvaiBook provides the necessary documentation so that the developer can understand what information can be exchanged and how to do so correctly.Testing environment
Once the feasibility of the integration has been confirmed, we will give your IT team access to our testing environment, where they can start setting up the connection and carry out the necessary tests.Certification and activation
Once the tests have been successfully completed, AvaiBook's technical team will certify the integration and activate it on your live account.
How can I request access to the API?
Fill in the form available in your account: Integrations > API > Form.
Our team will review your request and confirm whether the integration is feasible. Once validated, we will provide access to a testing environment so that your developer can begin the development process. Finally, once testing has been completed, the technical certification will be carried out and the integration will be activated on your live account.
With the AvaiBook API, you can further customise the way you manage your business by securely and efficiently connecting your own tools.