Getting Started

WELCOME TO THE HOSTFULLY GUIDEBOOK PLATFORM API!
This API is always under development. If you need help with implementing the API for your system, please contact us and we'll help you with your project.

If you notice the docs are out of date or are unclear, please don't be shy about clicking the "Suggest Edits" link! We're working to keep these docs up to date, however sometimes we get behind – and we'd love your help.

PREREQUISITES
Access to the Hostfully Guidebook Platform API is granted to users manually on a case to case basis. If you want to apply for API access please send an email with a description of your use case to [email protected].

AUTHENTICATION
Authentication requires a Bearer Token, which can be acquired from a special API Access page in your Guidebook Platform Dashboard. You will need to include your key in every request made to the API. The API key has have to be provided as an HTTP request header called Authorization with the value Bearer {{token}}

STAGING VS PRODUCTION
We do have a staging (sandbox) environment you can use to develop your API connection. This documentation will focus on instructions for testing in this staging environment. When you're ready to move your implementation to production we'll help you out.

RATE LIMIT
The Guidebook Platform has two rate limits:
500 calls within a 1 hour window per calling client (per IP address).
15 calls within a 1 minute window

Blacklisting
If a client application abuses the rate limits, it will be blacklisted. Blacklisted client apps are unable to get a response from the Hostfully API. If you or your application has been blacklisted and you think there has been a mistake, you can email us at [email protected] to request assistance.

SUPPORT AND FEEDBACK
Please feel free to send us suggestions or issues either through our Intercom channel or at [email protected].