Difference between revisions of "Connect Access System with API"
Markkinchin (talk | contribs) |
Markkinchin (talk | contribs) |
||
Line 23: | Line 23: | ||
== Get Bookings == | == Get Bookings == | ||
− | api.beds24.com/arrivals/getBookings | + | https://api.beds24.com/arrivals/getBookings |
This function will return all upcoming arrivals in the property as a JSON array. | This function will return all upcoming arrivals in the property as a JSON array. | ||
Line 32: | Line 32: | ||
This function is suitable to call once per hour per property. | This function is suitable to call once per hour per property. | ||
− | |||
== Set Booking == | == Set Booking == |
Revision as of 15:37, 28 October 2019
This page explains how to connect a system which needs upcoming bookings via API
1 Introduction
This API will allow you to read upcoming bookings for a property and to write or modify Booking Info Items in those bookings.
For example, a door access system could read details of upcoming bookings and store a door unlock code in each booking so the code can be communicated to the guest.
2 API setup
Contact Beds24 for a merchant Key for the Arrivals API
Each property can generate an access Key at the menu Settings > Apps & Integrations > Arrivals > Access Key
With the merchant key and property access key the following functions can be called.
Only data from room types that have their synchronise tick box enabled will be included.
3 Get Bookings
https://api.beds24.com/arrivals/getBookings
This function will return all upcoming arrivals in the property as a JSON array.
The number of days in advance of check-in date that bookings are available is set at the menu Settings > Apps & Integrations > Arrivals > Days in Advance
Personal information like name, email etc. can be included in the data at the menu Settings > Apps & Integrations > Arrivals > Allow Personal Info
This function is suitable to call once per hour per property.
4 Set Booking
https://api.beds24.com/arrivals/setBooking
This function can write a Booking Info Item into a booking.
If the booking info item already exists it will be modified.
Booking Info Items can be used for reporting and for triggering auto actions to perform further operations.
5 Commercial
We can list your integration and product at shop.beds24.com
Contact us for details.