Connect Access System with API

From Beds24 Wiki
Revision as of 16:31, 28 October 2019 by Markkinchin (talk | contribs)
Jump to navigation Jump to search


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

With the merchant key and property access key the following functions can be called.


3 Get Bookings

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



4 Set Booking

Booking can be read with JSON getBookings by specifying the booking number from the notify push.

We recommend periodically polling JSON getBookings (circa once per 30 minutes should be adequate) specifying the modifiedSince time as the time a few seconds before your last poll.

This will allow you to check for any bookings which are new or modified where the notify push was missed.


5 Commercial

We can list your integration and product at shop.beds24.com

Contact us for details.