eBooking API Documentation

Key Features

	eBooking API allows to have access to our garages' online calendars on both Equity and Franchisee network all accross Europe :		eBooking API also provides endpoints to enhance the partner's experience :
	Real-time visibility on garages' agenda Create appointment Modify appointment Cancel appointment		Get the list of centers with all appropriate information Check the status of the appointment Get the list of services and their Euromaster ids Centers First Availability

Robustness and Resiliency (R&R)

The eBooking API v2 is using the robustness and resiliency mechanism to manage calendars's downtimes. When calendars are not available, this feature allows to secure the appointment process on several aspects :

• Appointments are enqueued in a pile of messages, they are no longer lost
• Appointments are dequeued when the calendar is back online

All this process is made possible because the slot availability list is periodically retrieved from calendars in order to be able to use it when calendar is down. When the application detects a calendar failure, or when a preconfigured downtime period is triggered, it will use the retrieved availabilities and make it work like an offline calendar. The API is therefore able to :

• Provide availabilities for slots endpoints, without asking the calendar
• Accept or refuse book appointment if slot is not available, without checking the calendar

The main feature of R&R is to periodically retrieve availabilities from calendars, in order to be able to use it when calendar is not available.

Planned downtime periods

When we are informed of a planned downtime period for a calendar, it is possible for us to declare this period into our application. This period will then be triggered at the desired time and duration, and during this time, calendar will no longer be called. Appointments messages will be enqueued and slots endpoints will retrieve availabilities from offline database. When the period ending will be triggered, the API will be able to call the calendar again and dequeue the messages.

Unplanned downtime periods

When a calendar unavailability period occurs unexpectedly, the API is able to detect and manage it in order to temporarily switch to offline mode for this calendar. During this temporarily time, the calendar is no longer called except for a small sample of calls, in order to regularly check calendar availability. Appointments messages will be enqueued and slots endpoints will retrieve availabilities from offline database. When the API detects that the calendar is stable and back online, it switches back to normal mode and will be able to call the calendar again and dequeue the messages.

Recommendations

GetCentre endpoint

You have to use the /centres endpoint to retrieve all available centers with their Id.

Then, you can use them to call the different endpoints provided by API v2.

In order to obtain an up-to-date list of centers, we recommend our partners to call this endpoint every day. We also recommend making this call at night, when activity is low.

GetStatus endpoint

It is mandatory to call the getStatus endpoint after booking an appointment, in order to get its status. The appointment can have :

• The status PENDING : The state means the appointment is not created yet in the centre calendar. To be sure the appointment has been created, the GetStatus endpoint has to be called until the status is CONFIRMED or REJECTED (We recommand to run a batch every 15 minutes...).
• The status REJECTED : The state means the appointment has been rejected by the centre calendar.
• The status CONFIRMED : The state means the appointment has been accepted by the centre calendar.
• The status ENDED : The state means the appointment has been confirmed and his date is in the past
• The status CANCELED : The state means the appointment has been canceled

graph LR A((( )))-->B B[CONFIRMED]-->D D[CANCELED] B-->E E[ENDED] A-->C C[PENDING]-->B C-->F F[REJECTED]

Operational Countries List