Difference between revisions of "Connect Access System with API"

From Beds24 Wiki
Jump to navigation Jump to search
Line 14: Line 14:
 
Contact Beds24 for a merchant Key for the Arrivals API
 
Contact Beds24 for a merchant Key for the Arrivals API
  
−
Each property can generate an access Key at the menu '''Settings  >  Apps & Integrations  > Arrivals'''
+
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.
 
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.
  
  
Line 27: Line 29:
 
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'''  
 
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.
  
  
 
== Set Booking ==
 
== Set Booking ==
  
−
Booking can be read with JSON getBookings by specifying the booking number from the notify push.
+
api.beds24.com/arrivals/setBooking
 +
 
 +
This function can write a Booking Info Item into a booking.
  
−
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.
+
If the booking info item already exists it will be modified.
  
−
This will allow you to check for any bookings which are new or modified where the notify push was missed.
+
Booking Info Items can be used for reporting and for triggering auto actions to perform further operations.
  
  

Revision as of 15:36, 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

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

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.

Retrieved from "https://wiki.beds24.com/index.php?title=Connect_Access_System_with_API&oldid=14960"