Connect Access System with API - Revision history

Annette: Redirected page to Arrivals API

2021-09-24T08:04:36Z

Redirected page to Arrivals API

← Older revision		Revision as of 08:04, 24 September 2021
Line 1:		Line 1:
	[[~~Category:API~~]]		#REDIRECT [[Arrivals_API]]
	~~<div class="heading">API access to upcoming bookings</div>~~
	~~This page explains how to connect a system which needs upcoming bookings via API~~
	~~__Toc__~~
	~~== Introduction ==~~

	~~This API will allow you to read upcoming bookings for a property and to write or modify Booking Info Items in those bookings.~~

	~~For example, a door access system could read details of upcoming bookings and store a door unlock code in each booking so the code can be communicated to the guest.~~

	~~== API setup ==~~

	~~Contact Beds24 for a merchant Key for the Arrivals API~~

	~~Each property can generate an access Key at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Access Key'~~

	~~With the merchant key and the access key the following functions can be called on the property.~~

	~~Only data from room types that have their synchronise tick box enabled will be included.~~

	~~== Get Bookings ==~~

	~~https://api.beds24.com/arrivals/getBookings~~

	~~This function will return all upcoming arrivals in the property as a JSON array.~~

	~~The number of days in advance of check-in date that bookings are available is set at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Days in Advance'''~~

	~~Personal information like name, email etc. can be included in the data at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Allow Personal Info'''~~

	~~This function is suitable to call once per hour per property.~~

	~~== Set Booking ==~~

	~~https://api.beds24.com/arrivals/setBooking~~

	~~This function can write Booking Info Items into a booking.~~

	~~If the booking info item already exists it will be modified.~~

	~~Booking Info Items can be used for reporting and for triggering auto actions to perform further operations like sending email.~~

	~~The room note and status can be set on the room containing the booking~~

	~~== Commercial ==~~

	~~We can list your integration and product at https://shop.beds24.com~~

	~~Contact us for details.~~

Annette at 08:45, 9 July 2020

2020-07-09T08:45:36Z

← Older revision		Revision as of 08:45, 9 July 2020
Line 1:		Line 1:
	[[Category:API]]		[[Category:API]]
	<div class="heading">~~Dashboard~~</div>		<div class="heading">API access to upcoming bookings</div>
	This page explains how to connect a system which needs upcoming bookings via API		This page explains how to connect a system which needs upcoming bookings via API
	__Toc__		__Toc__

Annette at 08:38, 9 July 2020

2020-07-09T08:38:51Z

← Older revision		Revision as of 08:38, 9 July 2020
Line 1:		Line 1:
	[[Category:API]]		[[Category:API]]
			<div class="heading">Dashboard</div>
	''This page explains how to connect a system which needs upcoming bookings via API''		This page explains how to connect a system which needs upcoming bookings via API
	__Toc__		__Toc__
	== Introduction ==		== Introduction ==
Line 13:		Line 13:
	Contact Beds24 for a merchant Key for the Arrivals API		Contact Beds24 for a merchant Key for the Arrivals API

	Each property can generate an access Key at the menu ~~'''Settings >~~ Apps & Integrations > Arrivals > Access Key'''		Each property can generate an access Key at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Access Key'

	With the merchant key and the access key the following functions can be called on the property.		With the merchant key and the access key the following functions can be called on the property.
Line 25:		Line 25:
	This function will return all upcoming arrivals in the property as a JSON array.		This function will return all upcoming arrivals in the property as a JSON array.

	The number of days in advance of check-in date that bookings are available is set at the menu ~~'''Settings >~~ Apps & Integrations > Arrivals > Days in Advance'''		The number of days in advance of check-in date that bookings are available is set at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Days in Advance'''

	Personal information like name, email etc. can be included in the data at the menu ~~'''Settings >~~ Apps & Integrations > Arrivals > Allow Personal Info'''		Personal information like name, email etc. can be included in the data at the menu {{#fas:cog}} (SETTINGS) Apps & Integrations > Arrivals "Allow Personal Info'''

	This function is suitable to call once per hour per property.		This function is suitable to call once per hour per property.

Markkinchin: /* Set Booking */

2019-11-14T17:29:06Z

Set Booking

← Older revision		Revision as of 17:29, 14 November 2019
Line 40:		Line 40:

	Booking Info Items can be used for reporting and for triggering auto actions to perform further operations like sending email.		Booking Info Items can be used for reporting and for triggering auto actions to perform further operations like sending email.

			The room note and status can be set on the room containing the booking

	== Commercial ==		== Commercial ==

Annette at 14:58, 28 October 2019

2019-10-28T14:58:14Z

← Older revision		Revision as of 14:58, 28 October 2019
Line 8:		Line 8:

	For example, a door access system could read details of upcoming bookings and store a door unlock code in each booking so the code can be communicated to the guest.		For example, a door access system could read details of upcoming bookings and store a door unlock code in each booking so the code can be communicated to the guest.


	== API setup ==		== API setup ==

Markkinchin: /* API setup */

2019-10-28T14:39:45Z

API setup

← Older revision		Revision as of 14:39, 28 October 2019
Line 16:		Line 16:
	Each property can generate an access Key at the menu '''Settings > Apps & Integrations > Arrivals > Access Key'''		Each property can generate an access Key at the menu '''Settings > Apps & Integrations > Arrivals > Access Key'''

	With the merchant key and ~~property~~ access key the following functions can be called.		With the merchant key and the access key the following functions can be called on the property.

	Only data from room types that have their synchronise tick box enabled will be included.		Only data from room types that have their synchronise tick box enabled will be included.


	== Get Bookings ==		== Get Bookings ==

Markkinchin: /* Commercial */

2019-10-28T14:38:46Z

Commercial

← Older revision		Revision as of 14:38, 28 October 2019
Line 45:		Line 45:
	== Commercial ==		== Commercial ==

	We can list your integration and product at shop.beds24.com		We can list your integration and product at https://shop.beds24.com

	Contact us for details.		Contact us for details.

Markkinchin: /* Set Booking */

2019-10-28T14:38:31Z

Set Booking

← Older revision		Revision as of 14:38, 28 October 2019
Line 37:		Line 37:
	https://api.beds24.com/arrivals/setBooking		https://api.beds24.com/arrivals/setBooking

	This function can write a Booking Info ~~Item~~ into a booking.		This function can write Booking Info Items into a booking.

	If the booking info item already exists it will be modified.		If the booking info item already exists it will be modified.

	Booking Info Items can be used for reporting and for triggering auto actions to perform further operations.		Booking Info Items can be used for reporting and for triggering auto actions to perform further operations like sending email.

	== Commercial ==		== Commercial ==

Markkinchin: /* Get Bookings */

2019-10-28T14:37:51Z

Get Bookings

← Older revision		Revision as of 14:37, 28 October 2019
Line 23:		Line 23:
	== Get Bookings ==		== Get Bookings ==

	api.beds24.com/arrivals/getBookings		https://api.beds24.com/arrivals/getBookings

	This function will return all upcoming arrivals in the property as a JSON array.		This function will return all upcoming arrivals in the property as a JSON array.
Line 32:		Line 32:

	This function is suitable to call once per hour per property.		This function is suitable to call once per hour per property.


	== Set Booking ==		== Set Booking ==

Markkinchin: /* Set Booking */

2019-10-28T14:37:40Z

Set Booking

← Older revision		Revision as of 14:37, 28 October 2019
Line 36:		Line 36:
	== Set Booking ==		== Set Booking ==

	api.beds24.com/arrivals/setBooking		https://api.beds24.com/arrivals/setBooking

	This function can write a Booking Info Item into a booking.		This function can write a Booking Info Item into a booking.
Line 43:		Line 43:

	Booking Info Items can be used for reporting and for triggering auto actions to perform further operations.		Booking Info Items can be used for reporting and for triggering auto actions to perform further operations.


	== Commercial ==		== Commercial ==