Difference between revisions of "Category:API"
m (1版 をインポートしました) |
Beds24>Annette |
||
| Line 1: | Line 1: | ||
| − | |||
[[Category:Developers]] | [[Category:Developers]] | ||
| − | [[Category: | + | [[Category:Apps]] |
| − | + | <div class="heading">API</div> | |
| + | This page lists the available APIs and gives general information on how to use them. | ||
== Use of the API == | == Use of the API == | ||
The API functions are available at https://api.beds24.com | The API functions are available at https://api.beds24.com | ||
To use the API you need to allow API ACCES. | To use the API you need to allow API ACCES. | ||
| − | Go to SETTINGS -> ACCOUNT -> ACCOUNT ACCESS and allow API access. The API is available at https://api.beds24.com. The XML functions can be accessed with your Beds24 username and password. The JSON functions can be created with a API and prop key which you set yourself in the Beds24 control panel SETTINGS | + | Go to SETTINGS -> ACCOUNT -> ACCOUNT ACCESS and allow API access. The API is available at https://api.beds24.com. The XML functions can be accessed with your Beds24 username and password. 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 default limit is 60 API calls per 5 minutes for an account | The default limit is 60 API calls per 5 minutes for an account | ||
| Line 20: | Line 19: | ||
*getBookings will return the real time information about the bookings which are in the Beds24 system. | *getBookings will return the real time information about the bookings which are in the Beds24 system. | ||
*You can specify a date range. If you do not, the default is to return from now for 1 year. | *You can specify a date range. If you do not, the default is to return from now for 1 year. | ||
| + | |||
| + | === setBookings === | ||
| + | *You can import existing bookings up to 2 years back (json)/10 years back (.csv). | ||
| + | |||
| + | === getRates/putRates=== | ||
| + | You can download rates apply changes and import the changed rates (.csv). | ||
| + | |||
| + | <span style=color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> Uploading changes for linked rates is not possible. | ||
=== json/setRoomDates=== | === json/setRoomDates=== | ||
| Line 33: | Line 40: | ||
=== What do I need to do to receive credit card details though the API? === | === What do I need to do to receive credit card details though the API? === | ||
| − | |||
| − | |||
| − | |||
| − | Your systems must be PCI DSS compliant to receive credit card data. | + | Your systems must be PCI DSS compliant to receive credit card data. Please contact via support ticket for further information. |
===Can I delete bookings though the API? === | ===Can I delete bookings though the API? === | ||
You can cancel bookings though the API but not delete them. | You can cancel bookings though the API but not delete them. | ||
Revision as of 13:13, 15 July 2020
This page lists the available APIs and gives general information on how to use them.
Contents
Use of the API
The API functions are available at https://api.beds24.com
To use the API you need to allow API ACCES. Go to SETTINGS -> ACCOUNT -> ACCOUNT ACCESS and allow API access. The API is available at https://api.beds24.com. The XML functions can be accessed with your Beds24 username and password. 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 default limit is 60 API calls per 5 minutes for an account
You should design your interface to eliminate unnecessary calls.
If you put a delay of 5 seconds between calls you should have no problems.
Capabilities
getBookings
- getBookings will return the real time information about the bookings which are in the Beds24 system.
- You can specify a date range. If you do not, the default is to return from now for 1 year.
setBookings
- You can import existing bookings up to 2 years back (json)/10 years back (.csv).
getRates/putRates
You can download rates apply changes and import the changed rates (.csv).
{{#fas:exclamation-triangle}} Uploading changes for linked rates is not possible.
json/setRoomDates
- sets daily prices and inventory and min stay
The values will be sent to all channels which are activated for these values in the control panel.
getInvoicesCSV
- gets invoice items as a .csv file
API FAQ
Where can I find the API documentation?
The documentation can be found directly in the API.
What do I need to do to receive credit card details though the API?
Your systems must be PCI DSS compliant to receive credit card data. Please contact via support ticket for further information.
Can I delete bookings though the API?
You can cancel bookings though the API but not delete them.
This category currently contains no pages or media.
