|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| [[Category:API]] | | #REDIRECT [[Arrivals_API]] |
| <div class="heading">Dashboard</div>
| |
| This page explains how to connect a system which needs upcoming bookings via API
| |
| __Toc__
| |
| == 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.
| |
| | |
| == API setup ==
| |
| | |
| Contact Beds24 for a merchant Key for the Arrivals API
| |
| | |
| Each property can generate an access Key at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Access Key'
| |
| | |
| With the merchant key and the access key the following functions can be called on the property.
| |
| | |
| Only data from room types that have their synchronise tick box enabled will be included.
| |
| | |
| == 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 {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Days in Advance'''
| |
| | |
| Personal information like name, email etc. can be included in the data at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Allow Personal Info'''
| |
| | |
| This function is suitable to call once per hour per property.
| |
| | |
| == Set Booking ==
| |
| | |
| https://api.beds24.com/arrivals/setBooking
| |
| | |
| This function can write Booking Info Items 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 like sending email.
| |
| | |
| The room note and status can be set on the room containing the booking
| |
| | |
| == Commercial ==
| |
| | |
| We can list your integration and product at https://shop.beds24.com
| |
| | |
| Contact us for details.
| |