API V2.0 - Revision history

Annette: Redirected page to Category:API V2

2024-10-09T10:54:56Z

Sorenjensen at 14:53, 7 October 2024

2024-10-07T14:53:48Z

@@ Line 11: / Line 11: @@
 More information can be found here [https://beds24.com/api/v2 beds24.com/api/v2]
 = Invite codes =
@@ Line 108: / Line 141: @@
 The "all" method may be used as a shortcut to grant access to all methods. For example "all:bookings" would allow for the reading, updating, creating and deleting of bookings.
 = POST requests =

Sorenjensen at 14:53, 7 October 2024

2024-10-07T14:53:16Z

@@ Line 11: / Line 11: @@
 More information can be found here [https://beds24.com/api/v2 beds24.com/api/v2]
 = Invite codes =
@@ Line 141: / Line 108: @@
 The "all" method may be used as a shortcut to grant access to all methods. For example "all:bookings" would allow for the reading, updating, creating and deleting of bookings.
 = POST requests =

Sorenjensen: /* POST /bookings/messages */

2024-08-28T11:25:26Z

POST /bookings/messages

← Older revision		Revision as of 11:25, 28 August 2024
Line 287:		Line 287:
	=== POST /bookings/messages ===		=== POST /bookings/messages ===

	Send messages or mark them as read.		Send messages or mark them as read, this endpoint only works for messages for an OTA booking, not bookings made directly from the booking page.

	=== PATCH /bookings/messages ===		=== PATCH /bookings/messages ===

Sorenjensen: /* POST /bookings */

2024-08-28T11:23:29Z

POST /bookings

← Older revision		Revision as of 11:23, 28 August 2024
Line 267:		Line 267:

	Create or update bookings.		Create or update bookings.


			How to Add/remove bookings from a group booking

			You can add or remove a booking from a group booking by using the parameter "masterId" without having to use the action "makeGroup"

			To add a booking to a group booking, you set the master id of the group booking in the "masterId" parameter so it would look like this in your request: "masterId": 1234567, that will modify the booking to add it to the group.

			To remove a booking from a group booking, you set the "masterId" parameter to null so it will look like this in your request: "masterId": null,

	=== DELETE /bookings ===		=== DELETE /bookings ===

Asher: /* Is the API limited per token or per account? */

2024-08-13T02:49:40Z

Is the API limited per token or per account?

← Older revision		Revision as of 02:49, 13 August 2024
Line 544:		Line 544:

	This means that tokens under the same account share the same credit limit.		This means that tokens under the same account share the same credit limit.

			Different accounts, including sub accounts, have separate credit limits.

	==How do I make a new property/room/booking etc?==		==How do I make a new property/room/booking etc?==

Sorenjensen: /* GET /properties */

2024-06-27T13:01:24Z

GET /properties

← Older revision		Revision as of 13:01, 27 June 2024
Line 311:		Line 311:

	Get properties matching specified criteria.		Get properties matching specified criteria.

			==== Prices ====

			To get price setup rules, include the "includePriceRules" parameter in GET /properties like this
			/api/v2/properties?includePriceRules=true

			A room can have up to 16 prices.

			In the control panel, these can be set under Prices -> Daily Price Rules.

			In the API these can be accessed through GET and POST /inventory/calendar
			{
			"data": [
			{
			"calendar": [
			{
			"price1": 100,
			"price2": 300,
			"price3": 200,
			...
			}
			]
			}
			]
			}

	=== POST /properties ===		=== POST /properties ===

Asher: /* Authentication */

2024-06-19T08:48:10Z

Authentication

← Older revision		Revision as of 08:48, 19 June 2024
Line 15:		Line 15:
	There are two kinds of tokens, long life tokens which have read only access, and refresh tokens which generate tokens that can read and make changes.		There are two kinds of tokens, long life tokens which have read only access, and refresh tokens which generate tokens that can read and make changes.

	To use most API endpoints you will need to include a token header.		To use most API endpoints you will need to include a token header in the format "token: {token}"

	== Invite codes and refresh tokens ==		== Invite codes and refresh tokens ==

Asher: /* How long do invite codes/tokens last? */

2024-06-03T09:30:26Z

How long do invite codes/tokens last?

← Older revision		Revision as of 09:30, 3 June 2024
Line 490:		Line 490:

	==How long do invite codes/tokens last?==		==How long do invite codes/tokens last?==
	Invite codes expire after ~~15 minutes~~.		Invite codes expire after 24 hours.

	Refresh tokens last forever so long as they are being used. Unused refresh tokens expire after 30 days.		Refresh tokens last forever so long as they are being used. Unused refresh tokens expire after 30 days.

	Tokens expire after 24 hours.		Long life tokens last forever so long as they are being used. Unused long life tokens expire after 90 days.

			Tokens generated from refresh tokens expire after 24 hours.

	==How big are tokens?==		==How big are tokens?==

Asher: /* Authentication */

2024-06-03T09:29:36Z

Authentication

← Older revision		Revision as of 09:29, 3 June 2024
Line 13:		Line 13:

	= Authentication =		= Authentication =
			There are two kinds of tokens, long life tokens which have read only access, and refresh tokens which generate tokens that can read and make changes.

	To use most API endpoints you will need to include a token header.		To use most API endpoints you will need to include a token header.

	~~'''Step 1: Get an invite code'''~~		== Invite codes and refresh tokens ==

	Invite codes can be generated here [https://beds24.com/control3.php?pagetype=apiv2 Invite Codes]		'''Step 1: Get an invite code or long life token'''

			Invite codes and long life tokens can be generated here [https://beds24.com/control3.php?pagetype=apiv2 Invite Codes]

	For more information about invite codes, [[API_V2.0#Invite_codes\|see here]].		For more information about invite codes, [[API_V2.0#Invite_codes\|see here]].
Line 23:		Line 27:
	This step is the only one that must be done manually, all other steps can be performed and automated programmatically.		This step is the only one that must be done manually, all other steps can be performed and automated programmatically.

	'''Step 2: ~~Get~~ a refresh token ~~using the invite code~~'''		'''Step 2: If using an invite code, get a refresh token'''
			Skip this step if using a long life token
	You can use the invite code generated in step one with GET /authentication/setup.		You can use the invite code generated in step one with GET /authentication/setup.

	This will return a ''token'' and a ''refresh token''.		This will return a ''token'' and a ''refresh token''.

			<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}} </span> ''Tokens'' generated from refresh tokens expire after 24 hours.

	'''Step 3: Use the token to authenticate calls'''		'''Step 3: Use the token to authenticate calls'''

	The ''token'' ~~returned in step 2~~ can be included as a header to authenticate calls to other API endpoints.		The ''token'' (either a long life token or a token generated using a refresh token) can be included as a header to authenticate calls to other API endpoints.

	~~<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}} </span> ''Tokens'' expire after 24 hours~~.

	'''Step 4: Use the refresh token to generate new tokens'''		'''Step 4: Use the refresh token to generate new tokens'''

API V2.0 - Revision history

Annette: Redirected page to Category:API V2

Sorenjensen at 14:53, 7 October 2024

Sorenjensen at 14:53, 7 October 2024

Sorenjensen: /* POST /bookings​/messages */

Sorenjensen: /* POST /bookings */

Asher: /* Is the API limited per token or per account? */

Sorenjensen: /* GET /properties */

Asher: /* Authentication */

Asher: /* How long do invite codes/tokens last? */

Asher: /* Authentication */

Sorenjensen: /* POST /bookings/messages */