Jump to navigation Jump to search

Connect PMS with API

2,887 bytes added, 10:20, 12 November 2021
<div class="heading">API: Connect PMS or OTA</div>
This page explains how to connect a PMS or OTA to the Beds24 API for Channel Management
== Introduction ==
''This page explains how To better understand the operation of Beds24 it is good to connect start by setting up a PMS to test property including prices and other data you will be using manually in the Beds24 for Channel Management''control panel.
Then to understand the API and it's functions and fields, read the test property data using the various JSON functions to learn which data is available via API.
Once you understand the data format there are corresponding functions to write the JSON data back to Beds24.
The write data format is usually the same as the data read.
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 Properties ==
Use JSON createProperties to create properties and their rooms via API.
== Setup Price and Channel Mapping ==
Prices are defined in up to 16 daily price rows per room type.
Use JSON setDailyPriceSetup to create the daily price rows and map them to channels, including any rate codes.
We recommend using only daily prices instead of rates for this type of connection and for simplicity not using both daily prices and rates. == Send Price and Inventory Availability ==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. ==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 Bookings from channels will import into Beds24 and automatically reduce the available inventory. The Bookings should be left in Beds24 so modification/cancellation can be accepted. 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.
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.
==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.

Navigation menu