Connect PMS with API

From Beds24 Wiki
Jump to navigation Jump to search

This page explains how to connect a PMS to the Beds24 API for Channel Management

1 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

2 Create Properties

Use JSON createProperties to create properties and their rooms via API.

Set a PROP Key for the property when creating it so it can be accessed later via API.

Once created, the property and it's rooms can be modified with JSON modifyProperty

Descriptive content can optionally be added to a property and it's rooms with JSON setPropertyContent

3 Setup Price and Channel Mapping

Prices are defined in up to 16 daily price rows per room type.

Each row can be defined with an occupancy and minimum stay and sent to any combination of channels.

This means for each date can have up to 16 different prices for combinations of occupancy, minimum stay and channel.

Use JSON setDailyPriceSetup to create the daily price rows and map them to channels, including any rate codes.

4 Send Price and Availability

Price and availability can be set per room type with JSON setRoomDates

For each date, up to 16 prices (daily price rows), number of rooms available, minimum stay (room level), maximum stay (room level) and check-in check-out restrictions can be sent.

5 Booking Notification

6 Booking Detail

7 Booking Modification