318
edits
Changes
Jump to navigation
Jump to search
If you wish to access properties that are not in your account you must tick the "Allow linked properties" checkbox when selecting the scopes for the token.
Note: Properties must be linked under Account Management > Manage Account > Manage Property. Other methods of linking properties are not supported in API V2.
== Subcategory scopes ==
A room can have up to 16 prices.
In the control panel, these can be set under Prices -> Daily Price SetupRules.
In the API these can be accessed through GET and POST /inventory/calendar
]
}
= Webhooks =
== Booking webhooks ==
To access booking webhooks for API V2 please contact support. They can then be enabled under Settings > Properties > Access > Booking webhooks.
== Other webhooks ==
Information about other webhooks (including non API V2 webhooks) can be found here [https://wiki.beds24.com/index.php/Category:Webhooks Webhooks]
= Best Practices =
== Token Management ==
Tokens last 24 hours. This means that you do not need to retrieve a new token for each request. Getting a new token costs credits so it is best to use an existing one when possible.
== Retrieving information at high frequencies ==
If you need to get data such as new messages or bookings when they come in you do not need to perform frequent GET requests. Instead, you can use webhooks to be notified as soon as a new message/booking etc arrives.
== Sending information at high frequencies ==
If you need to send large amounts of information such as messages at high frequencies it is best to send them grouped in bulk POST requests instead of sending one request per message. For example, you could send one POST request every 30 seconds containing all messages sent in the past 30 seconds.
== Sending or getting information in one call ==
If you need to retrieve information about multiple different things, such as information about several properties, you can retrieve that in one call by specifying multiple IDs in the one request instead of performing one GET request per property. The same principle applies when POSTing information, for example, you can create or update multiple properties in one call.
= Examples =
=FAQ=
==How do I access API V2?==
Create an invite code under Settings -> {{#fas:cog}} (SETTINGS) Apps & Integrations -> API.
Exchange this invite code for a refresh token and token using the POST /authentication/setup endpoint.
Include the token in your requests to authenticate them.
You can try this out using our interactive UI here [https://beds24.com/api/v2 beds24.com/api/v2].
==What are scopes?==
==How big are tokens?==
Tokens will be between 152 and 172 characters long.
==What is the API credit limit?==
This means that tokens under the same account share the same credit limit.
==How do I make a new booking/property/room /booking etc?==
Simply do not include an id in your POST request.
Examples for how to do this can be found here:
[https://beds24.com/api/v2/#/Properties/post_properties Properties/Rooms]
[https://beds24.com/api/v2/#/Bookings/post_bookings Bookings]
==Where can I see or set price rules?==
You can retrieve offers (i.e. calculated prices for specific dates) through the /inventory/rooms/offers endpoint.
==How can I see or set prices, min stay, availability etc for specific dates like in the UI calendar?==
These per date values can be read and set through the /inventory/rooms/calendar endpoint.
==Where can I see examples for how to use the API?==
Examples can be found here [https://beds24.com/api/v2 beds24.com/api/v2].
==Can I use API V2 to send pictures or webhooks?==
Currently no, however these features are coming soon.
==How can I see if a date is available for check-in/out?==
The GET /inventory/rooms/availability returns information about if dates are available or not. If a date is false, it means it is not available for check-in. However, if the previous date is available, it means the date is available for check-out.
For example, with the following a booking cannot check-in on 2024-01-03 because that date is unavailable. However, because the previous date 2024-01-04 is available, it means 2024-01-03 is available for check-out.
"availability": {
"2024-01-01": true,
"2024-01-02": true,
"2024-01-03": false
}
==What is the maximum amount of data I can send in a POST request?==
The API has a limit of approximately 1MB per POST payload.
In addition, there is a limit of 10000 top level JSON array item per POST request.
==Where can I see the possible values for a booking's apiSourceId (API Source ID)==
[[/API_V2.0_apisourceids | apiSourceId values can be found here.]]
