Difference between revisions of "Category:API"

From Beds24 Wiki
Jump to navigation Jump to search
 
(15 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Apps]]
 
[[Category:Apps]]
 
<div class="heading">API</div>
 
<div class="heading">API</div>
−
This page lists the available APIs and gives general information on how to use them.  
+
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.  
  
 +
For most projects we recommend using [https://wiki.beds24.com/index.php/Category:API_V2 API V2].
  
−
<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>   
+
</div>   
−
== Use of the API ==
+
__NOTOC__
−
The API functions are available at https://api.beds24.com
+
= FAQ =
 +
==Where can I find general information on how Beds24 works?==
 +
Click here for an [[Introduction]] to Beds24.  
  
−
To use the API you need to allow API ACCESS.
+
==Which API version should I use?==
−
Go to SETTINGS -> ACCOUNT  -> ACCOUNT ACCESS and allow API access. The API is available at https://api.beds24.com.  
+
We generally recommend using [https://wiki.beds24.com/index.php/Category:API_V2 API V2].
−
*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.
+
==Where can I find API documentation?==
 +
===API V2===
 +
Help pages for API V2 can be found here [https://wiki.beds24.com/index.php/Category:API_V2 API V2]
  
−
You should design your interface to eliminate unnecessary calls.
+
We have interactive Swagger documentation for API V2 available here https://beds24.com/api/v2/.
  
−
If you put a delay of 5 seconds between calls you should have no problems.
+
===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/API_V1.0_deprecated API V1 (depreciated)]
 +
==Can I use a mix of API V1 and V2==
 +
We recommend not mixing API V1 and API V2.
  
−
== Capabilities ==
+
==What do I do if I need functions which are not available in API V2==
−
=== getBookings ===
+
Reach out to us via a support ticket so we can check if the function you need can be added.
−
*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===
 
−
*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 ==
 
−
=== 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.
 

Latest revision as of 00:52, 24 October 2024

API

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.

For most projects we recommend using API V2.

1 FAQ

1.1 Where can I find general information on how Beds24 works?

Click here for an Introduction to Beds24.

1.2 Which API version should I use?

We generally recommend using API V2.

1.3 Where can I find API documentation?

1.3.1 API V2

Help pages for API V2 can be found here API V2

We have interactive Swagger documentation for API V2 available here https://beds24.com/api/v2/.

1.3.2 API V1

API V1 is depreciated. We do not recommend using it for new projects.

The main help page for API V1 is available here API V1 (depreciated)

1.4 Can I use a mix of API V1 and V2

We recommend not mixing API V1 and API V2.

1.5 What do I do if I need functions which are not available in API V2

Reach out to us via a support ticket so we can check if the function you need can be added.

Subcategories

This category has the following 3 subcategories, out of 3 total.

A

W

Pages in category "API"

The following 3 pages are in this category, out of 3 total. download this selection of articles as a PDF book

A

O

P

Retrieved from "https://wiki.beds24.com/index.php?title=Category:API&oldid=25983"