Introduction
Information on Booker's two APIs, what they do, and how to choose which to use.
Booker offers two APIs
Customer API
Designed for customers to book appointments
Documentation: http://apidoc.booker.com/Endpoint/7
Merchant API
Designed for merchants to manage their business
Documentation: http://apidoc.booker.com/Endpoint/8
A few things you can do with the APIs
Customer API
- Search for available appointment times
- Book an appointment
- Cancel an appointment
- Customer can view past appointments
Merchant API
- View merchant's appointment schedule
- Schedule a new appointment
- Block out time on the merchant's schedule
- Cancel an appointment
- Check-in a customer for an appointment
- Process payment for an appointment
Which API should I use?
The API you use will depend on your audience.Customer API
Use the Customer API if you are building an application for customers to search for availability and book appointments.Merchant API
Use the Merchant API if you are building an application for a merchant to view their appointment schedule, schedule new appointments, check-in guests, process payments, etc. To ensure the privacy and security of our merchants' data, most methods in this API require a merchant user to supply his username and password for authorization.Technical Note
It is important to note that while methods with the same name exist in both APIs,
it does not mean they have identical functionality.
For example "CancelAppointment" exists in both APIs. However, the customer API only allows the customer to cancel an appointment within the cancellation policy period designated by the location. The merchant API does not impose this restriction. CreateAppointment also exists in both APIs. However, the customer API limits appointment booking according to various settings configurable by the location. The merchant API does not impose these restrictions.
Also, keep in mind that data returned by both APIs may appear similar but will also have important differences.
For example, when an "appointment" is returned from the merchant API, it will have additional fields exposing internal data such as internal customer notes. The DTOs in the customer API are generally a subset of the DTOs in the merchant API. This is done to secure internal data.
For example "CancelAppointment" exists in both APIs. However, the customer API only allows the customer to cancel an appointment within the cancellation policy period designated by the location. The merchant API does not impose this restriction. CreateAppointment also exists in both APIs. However, the customer API limits appointment booking according to various settings configurable by the location. The merchant API does not impose these restrictions.
Also, keep in mind that data returned by both APIs may appear similar but will also have important differences.
For example, when an "appointment" is returned from the merchant API, it will have additional fields exposing internal data such as internal customer notes. The DTOs in the customer API are generally a subset of the DTOs in the merchant API. This is done to secure internal data.