API V2.0: Difference between revisions
Created page with "Category:Apps Category:API Category:Automation <div class="heading">API Version 2.0</div> This page explains the capabilities of the API Version 2.0 and explain..." |
No edit summary |
||
| Line 13: | Line 13: | ||
Go to SETTINGS -> ACCOUNT -> ACCOUNT ACCESS and allow API access. | Go to SETTINGS -> ACCOUNT -> ACCOUNT ACCESS and allow API access. | ||
*The JSON functions can be created with a API and prop key which you set yourself in the Beds24 control panel {#fas:cog}} (SETTINGS)ACCOUNT and {{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS | *The JSON functions can be created with a API and prop key which you set yourself in the Beds24 control panel {#fas:cog}} (SETTINGS)ACCOUNT and {{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS | ||
= Scopes = | |||
Each category of API endpoint (except /authentication) requires the corrosponding scope to access. | |||
Some categories have additional scopes that allow access to personal or financial information. For example, the "bookings" scope would grant access to a booking's basic information such as the check-in and checkout dates. To access personal information such as the name of a guest, the "bookings-personal" scope would be required. Similarly, to access the invoice of a bookings, the "bookings-financial" scope would be required. | |||
Each scope must also have an acompanying method. For example "get:bookings" would grant read access to bookings, but in order to create a new booking "post:bookings" would be required. | |||
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. | |||
Revision as of 05:39, 1 December 2021
This page explains the capabilities of the API Version 2.0 and explains how to use it.
Capabilities
API Access
To use the API you need to allow API ACCESS. Go to SETTINGS -> ACCOUNT -> ACCOUNT ACCESS and allow API access.
- The JSON functions can be created with a API and prop key which you set yourself in the Beds24 control panel {#fas:cog}} (SETTINGS)ACCOUNT and (SETTINGS) PROPERTIES > ACCESS
Scopes
Each category of API endpoint (except /authentication) requires the corrosponding scope to access.
Some categories have additional scopes that allow access to personal or financial information. For example, the "bookings" scope would grant access to a booking's basic information such as the check-in and checkout dates. To access personal information such as the name of a guest, the "bookings-personal" scope would be required. Similarly, to access the invoice of a bookings, the "bookings-financial" scope would be required.
Each scope must also have an acompanying method. For example "get:bookings" would grant read access to bookings, but in order to create a new booking "post:bookings" would be required.
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.