Connect PMS with API: Difference between revisions
Jump to navigation
Jump to search
Markkinchin (talk | contribs) No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
This page explains how to connect a PMS or OTA to the Beds24 API Version 1 for Channel Management | This page explains how to connect a PMS or OTA to the Beds24 API Version 1 for Channel Management | ||
__Toc__ | __Toc__ | ||
= Introduction = | |||
To better understand the operation of Beds24 it is good to start by setting up a test property including prices and other data you will be using manually in the Beds24 control panel. | To better understand the operation of Beds24 it is good to start by setting up a test property including prices and other data you will be using manually in the Beds24 control panel. | ||
| Line 15: | Line 15: | ||
See the notes at each endpoint for more information. | See the notes at each endpoint for more information. | ||
= API setup = | |||
Create an API Key for your Beds24 account at Settings > Account > Account Access | Create an API Key for your Beds24 account at Settings > Account > Account Access | ||
| Line 26: | Line 26: | ||
The JSON API functions are recommended https://api.beds24.com | The JSON API functions are recommended https://api.beds24.com | ||
= Create Properties = | |||
Use JSON createProperties to create properties and their rooms via API. | Use JSON createProperties to create properties and their rooms via API. | ||
| Line 35: | Line 35: | ||
Descriptive content can optionally be added to a property and it's rooms with JSON setPropertyContent | Descriptive content can optionally be added to a property and it's rooms with JSON setPropertyContent | ||
= Setup Price and Channel Mapping = | |||
Prices are defined in up to 16 daily price rows per room type. | Prices are defined in up to 16 daily price rows per room type. | ||
| Line 46: | Line 46: | ||
We recommend using only Daily Prices for this type of connection. | We recommend using only Daily Prices for this type of connection. | ||
= Send Price and Availability = | |||
Price and availability can be set per room type with JSON setRoomDates | Price and availability can be set per room type with JSON setRoomDates | ||
For each date, up to 16 prices, the number of rooms available, minimum stay (room level), maximum stay (room level) and check-in check-out restrictions can be sent. | For each date, up to 16 prices, the number of rooms available, minimum stay (room level), maximum stay (room level) and check-in check-out restrictions can be sent. | ||
= Bookings = | |||
There is no need to send bookings to Beds24, it is better to manage inventory by setting number of rooms available with JSON setRoomDates | There is no need to send bookings to Beds24, it is better to manage inventory by setting number of rooms available with JSON setRoomDates | ||
| Line 60: | Line 60: | ||
Make sure to adjust your inventory levels to account for the channel booking in Beds24. | Make sure to adjust your inventory levels to account for the channel booking in Beds24. | ||
= 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. | When a booking is created, modified or cancelled by a channel, we will send a notification push to a URL specified by you. | ||
| Line 67: | Line 67: | ||
The notify push expects an HTTP 200 response and will retry after a delay if this is not received. | 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. | Booking can be read with JSON getBookings by specifying the booking number from the notify push. | ||
| Line 74: | Line 74: | ||
This will allow you to check for any bookings which are new or modified where the notify push was missed. | 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. | 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. | It is up to your system to compare the new booking detail with the original and determine what actually changed. | ||
=Retrieve Content= | |||
Use JSON getProperties to retrieve properties and their rooms via API. | Use JSON getProperties to retrieve properties and their rooms via API. | ||
= OTA channel = | |||
The OTA channel can be used to connect an OTA to Beds24. | The OTA channel can be used to connect an OTA to Beds24. | ||
It functions like any other OTA connected to the Beds24 channel manager. | It functions like any other OTA connected to the Beds24 channel manager. | ||