Category:API V1 deprecated: Difference between revisions
Jump to navigation
Jump to search
Created page with "Category:API" |
No edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:API]] | [[Category:API]] | ||
<div class="heading">(Deprecated)</div> | |||
<div class="warning">{{#fas:exclamation-triangle}} API V1 is depreciated and will not be developed further. For new projects use [[API_V2.0 |API V2]]</div> | |||
== Use of the API V1== | |||
These API functions are available at https://api.beds24.com | |||
To use the API you need to allow API ACCESS. | |||
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 Fixed Prices apply changes and import the changed Fixed Prices (.csv). | |||
<span style=color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> Uploading changes for linked Fixed Prices 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 | |||
=== getProperty === | |||
*access property setup data | |||
=== setProperty === | |||
*manage property setup data | |||
=== getPropertyContent === | |||
*access property descriptive content | |||
=== setPropertyContent === | |||
*manage descriptive content and pictures | |||
For pictures you can set the URL to external pictures and you can map these to properties and rooms. | |||
You cannot upload to our picture hosting via API, you must use your own hosting. | |||
Use JSON getPropertyContent to see the JSON data structure required to be sent to setPropertyContent. | |||
== 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. | |||