Difference between revisions of "Connect Access System with API"

From Beds24 Wiki
Jump to navigation Jump to search
Line 4: Line 4:
 
__Toc__
 
__Toc__
 
== Introduction ==
 
== Introduction ==
−
 
−
 
−
 
−
== API setup ==
 
−
 
−
Contact Beds24 for a merchant Key for the Arrivals API
 
  
 
This API will allow you to read upcoming bookings for a property and to write or modify Booking Info Items in those bookings.
 
This API will allow you to read upcoming bookings for a property and to write or modify Booking Info Items in those bookings.
Line 15: Line 9:
 
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.
 
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.
  
−
== Booking Notification ==
 
  
−
When a booking is created, modified or cancelled by a channel, we will send a notification push to a URL specified by you.
+
== API setup ==
  
−
The notify push will contain the booking number of the affected booking, you can use this to read the full details of the booking.
+
Contact Beds24 for a merchant Key for the Arrivals API
  
−
The notify push expects an HTTP 200 response and will retry after a delay if this is not received.
+
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.
  
−
== Booking Detail ==
 
  
−
Booking can be read with JSON getBookings by specifying the booking number from the notify push.
+
== Get Bookings ==
  
−
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.
+
api.beds24.com/arrivals/getBookings
  
−
This will allow you to check for any bookings which are new or modified where the notify push was missed.
+
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'''
  
−
== Booking Modification ==
 
  
−
If a booking is modified by a channel, you will receive a notify push and you can read the new booking detail.
 
  
−
It is up to your system to compare the new booking detail with the original and determine what actually changed.
 
  
 +
== Set Booking ==
  
−
== Questionnaire ==
+
Booking can be read with JSON getBookings by specifying the booking number from the notify push.
  
−
So we can best support you and if desired promote your system, please send us the answer to these questions.
+
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.
  
−
1) What is your Beds24 account number?
+
This will allow you to check for any bookings which are new or modified where the notify push was missed.
−
 
 
−
2) What is the name of your system?
 
−
 
 
−
3) Main contact person at your system for technical issues?
 
  
−
4) Number of properties you intend to connect?
 
  
−
5) Names of the API functions you are using and estimated number of unique calls per hour?
+
== Commercial ==
  
−
6) Do you want to be listed as a Beds24 partner and promoted by us?
+
We can list your integration and product at shop.beds24.com
  
−
7) Unique function or selling point to promote your system?
+
Contact us for details.

Revision as of 16:31, 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

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.

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