Introduction
If you've ever connected Bookboost to an external tool or heard your technical team mention "API keys", you might be wondering what they actually are. This article explains what an API key is, how it works, and gives a practical example of how it's used within Bookboost.
Main Concept or Feature Explanation
An API key is a unique alphanumeric code that acts as a secure identifier when two software systems communicate with each other.
To understand it simply: imagine you're entering a members-only club 🏨. The doorman doesn't know your face, but he recognises your membership card. An API key works the same way — it tells one system, "This request is coming from a trusted, authorised source."
Two terms worth knowing:
API (Application Programming Interface) — a set of rules that allows two software systems to talk to each other and exchange data.
API Key — the secret token used to prove that the request is coming from a legitimate, authorised source.
Use Cases
Allowing an external system to pull guest data from Bookboost automatically
Enabling a third-party tool to trigger actions in Bookboost (e.g. sending a message) without a manual login
Giving a developer or integration partner secure, controlled access to your Bookboost account
How It Works — A Bookboost Example
Here's a simple, real-world example 💡:
Imagine your hotel uses a guest review platform to collect and manage post-stay feedback. You want that platform to automatically receive guest information from Bookboost right after checkout — so it can send a review request at exactly the right moment, without your team having to do anything manually.
To make this happen, the review platform needs to "talk" to Bookboost. You give it your Bookboost API key, which tells Bookboost: "This review platform is authorised to retrieve guest data on behalf of this hotel."
Every time the review platform sends a request — such as fetching guests who recently checked out — it includes the API key. Bookboost recognises it, verifies it, and shares the relevant data. Review requests go out automatically, right on time. ✅
⚠️ Important: Your API key is like a password. Never share it publicly or store it in unsecured places. If you believe it has been compromised, contact Bookboost Support immediately.
Conclusion
An API key is essentially your hotel's secure digital pass for connecting Bookboost to the outside world. It keeps integrations safe, automated, and reliable — without requiring manual logins or data entry every time two systems need to exchange information. 🔐
For instructions on how to find and manage your API key inside Bookboost, refer to the dedicated article: How to Generate and Manage API Keys in Bookboost.
Support
Please contact us through the 'Talk to Us' option on the left menu in the platform, or through the Bookboost Support email at support@bookboost.io if you have questions or need additional support.