17,164
edits
Changes
Jump to navigation
Jump to search
[[Category:Channel_Manager_and_API]]
=== Where can I find the API documentation? ===
The documentation can be found directly in the API.
Go to ACCOUNT and set:
*API Access = Allow IP whitelist only
*Enter your IP address's. Separate multiple address's with a space
no edit summary
[[Category:Developers]]
[[Category:Apps_Plugins_and_ExtentionsApps]]<div class="heading">API</div> This page lists the available APIs and gives general information on how to use them.
<div class="warning">{{#fas:exclamation-triangle}} This API version will not be developed further. For new projects use [[API_V2.0 |API V2.0]]</div>
== Use of the API ==
The API functions are available at https://api.beds24.com
To use the API you need to allow API ACCESACCESS. 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->LINKACCESS
The default limit is 60 API calls per 5 minutes for an account.
You should design your interface to eliminate unnecessary calls.
*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).
<span style=color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> Uploading changes for linked rates is not possible.
=== json/setRoomDates===
=== 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 ==
=== 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.
