Connect PMS with API: Difference between revisions
Jump to navigation
Jump to search
Markkinchin (talk | contribs) |
No edit summary |
||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category: | [[Category:API_V1_deprecated]] | ||
<div class="heading">API V1: Connect PMS or OTA</div> | |||
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> This page is about API V1 which is depreciated. We recommend using [https://wiki.beds24.com/index.php/Category:API_V2 API V2] instead. | |||
This page explains how to connect a PMS or OTA to Beds24 using API V1 for Channel Management | |||
__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 16: | ||
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 27: | Line 27: | ||
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 38: | Line 36: | ||
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 49: | Line 45: | ||
Use JSON setDailyPriceSetup to create the daily price rows and map them to channels, including any rate codes. | Use JSON setDailyPriceSetup to create the daily price rows and map them to channels, including any rate codes. | ||
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 67: | Line 61: | ||
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 76: | Line 68: | ||
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 85: | Line 75: | ||
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. | |||
= OTA channel = | |||
The OTA channel can be used to connect an OTA to Beds24. | |||
It functions like any other OTA connected to the Beds24 channel manager. | |||
The OTA API functions can be used by the OTA system to read prices and availability assigned to the OTA channel from Beds24 and to push bookings back into the rooms in Beds24. | |||
https://wiki.beds24.com/index.php/OTA | |||