|
|
| (13 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | [[Category:API]] | + | #REDIRECT [[Arrivals_API]] |
| − | | |
| − | ''This page explains how to connect a system which needs upcoming bookings via API''
| |
| − | __Toc__
| |
| − | == Introduction ==
| |
| − | | |
| − | | |
| − | | |
| − | == API setup ==
| |
| − | | |
| − | Create an API Key for your Beds24 account at Settings > Account > Account Access
| |
| − | | |
| − | For extra security also whitelabel your IP address to prevent access from unauthorized IP addresses.
| |
| − | | |
| − | Access to most API functions will require the API Key and the PROP Key for the property being accessed.
| |
| − | | |
| − | There are usage limits on the API so design your system to avoid unnecessary and minimize the frequency of API calls.
| |
| − | | |
| − | The JSON API functions are recommended https://api.beds24.com
| |
| − | | |
| − | | |
| − | | |
| − | | |
| − | == 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.
| |
| − | | |
| − | The notify push will contain the booking number of the affected booking, you can use this to read the full details of the booking.
| |
| − | | |
| − | The notify push expects an HTTP 200 response and will retry after a delay if this is not received.
| |
| − | | |
| − | | |
| − | == Booking Detail ==
| |
| − | | |
| − | 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.
| |
| − | | |
| − | | |
| − | == 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.
| |
| − | | |
| − | | |
| − | == Questionnaire ==
| |
| − | | |
| − | So we can best support you and if desired promote your system, please send us the answer to these questions.
| |
| − | | |
| − | 1) What is your Beds24 account number?
| |
| − | | |
| − | 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?
| |
| − | | |
| − | 6) Do you want to be listed as a Beds24 partner and promoted by us?
| |
| − | | |
| − | 7) Unique function or selling point to promote your system?
| |
