GUIDE
Getting started with the Bedful API
Access to the Bedful API allows you to read information from the bedful property management system, and sync availability with another booking system.
About the API
The API uses REST style resource URLS, accepts url params or sometimes json formatted request bodies on post requests, and returns json-formatted responses. It uses standard HTTP codes, authentication and the HTTP verbs GET and POST.
Examples using curl are given in this documentation, but you should be able to connect to the system from any other system which can set headers and parse json.
Getting connected
All access is over https, which means the API requires only an access key to use. To obtain an API key please contact the developers. You can read more about our authentication with Bedful in our Authentication guide.
Development & testing
While testing the api you should get in touch with us to allow you to access the dev servers, so that you are not testing against live data, and don't have to worry about hitting the rate limits on the live service.
When you're happy that your integration is complete, you can start using the live api server url.
The home page of these services does not require authentication.
API usage
Examples
The examples given in this guide use the curl command line tool to fetch resources or post content. This is a good way to test out the api and get a feel for the responses your app will receive.
Rate limits
There are two limits on rates for accessing the api, detailed below:
- A limit of 100 requests per minute
- A limit of 5 requests per second
Stability Guarantee
We guarantee the Bedful API will remain stable over a time-frame of years, so you can write your integration today without worrying about whether things will change. This applies to all versions of the API, but not to fields marked for internal use only. This stability guarantee applies to:
- Existing Fields - existing data should not disappear, and fields will not be removed
- Data Formats - the data format of existing fields will not change
- Existing Behaviour - existing behaviour will not change (including error status codes, but not error messages)
Things which may change:
- Fields may be added to the API
- The order of fields in JSON may change
- Fields marked Internal only may change or be removed