|
|
| (35 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
|
| |
| [[Category:Developers]] | | [[Category:Developers]] |
| [[Category:Apps_Plugins_and_Extentions]] | | [[Category:Marketplace]] |
| | | Developers can use our API to set up custom connections to third party systems. We provide a range of different APIs for different use cases. Please refer to the API documentation and the link below for more detailed information. |
| == 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 SETTINGS->ACCOUNT and 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===
| | For most projects we recommend using [https://wiki.beds24.com/index.php/Category:API_V2 API V2]. |
| 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.
| | </div> |
| | __NOTOC__ |
| | = FAQ = |
| | ==Where can I find general information on how Beds24 works?== |
| | Click here for an [[Introduction]] to Beds24. |
|
| |
|
| === json/setRoomDates=== | | ==Which API version should I use?== |
| *sets daily prices and inventory and min stay
| | We generally recommend using [https://wiki.beds24.com/index.php/Category:API_V2 API V2]. |
| The values will be sent to all channels which are activated for these values in the control panel.
| |
|
| |
|
| === getInvoicesCSV === | | ==Where can I find API documentation?== |
| *gets invoice items as a .csv file
| | ===API V2=== |
| | Help pages for API V2 can be found here [https://wiki.beds24.com/index.php/Category:API_V2 API V2] |
|
| |
|
| == API FAQ ==
| | We have interactive Swagger documentation for API V2 available here https://beds24.com/api/v2/. |
| === 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? === | | ===API V1=== |
| | <div class="warning">{{#fas:exclamation-triangle}} API V1 is depreciated. We do not recommend using it for new projects.</div> |
| | The main help page for API V1 is available here [https://wiki.beds24.com/index.php/Category:API_V1_deprecated API V1 (deprecated)] |
|
| |
|
| Your systems must be PCI DSS compliant to receive credit card data. Please contact via support ticket for further information.
| | ==Can I use a mix of API V1 and V2== |
| | We recommend not mixing API V1 and API V2. |
|
| |
|
| ===Can I delete bookings though the API? === | | ==What do I do if I need functions which are not available in API V2== |
| You can cancel bookings though the API but not delete them.
| | Reach out to us via a support ticket so we can check if the function you need can be added. |