Difference between revisions of "Category:API"

From Beds24 Wiki
Jump to navigation Jump to search
Line 7: Line 7:
  
 
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->ACCOUNT and SETTINGS->PROPERTIES->LINK
+
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->LINK
  
  

Revision as of 14:49, 7 September 2018


1 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->LINK


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.

2 Capabilities

2.1 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.

2.2 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.

2.3 getInvoicesCSV

  • gets invoice items as a .csv file

3 API FAQ

3.1 Where can I find the API documentation?

The documentation can be found directly in the API.

3.2 What do I need to do to receive credit card details though 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

Your systems must be PCI DSS compliant to receive credit card data.

3.3 Can I delete bookings though the API?

You can cancel bookings though the API but not delete them.

Subcategories

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