Clinic API keys to connect other applications
The actions described in this lesson require a Manager permission on your clinic.
Do not share your API key publicly or embed it in front-end/client-side code. Treat it like a password.
What are Clinic API keys?
A Clinic API key lets another application (your clinic's website, a scheduling widget, an internal tool) talk directly to your Embodia account. Once you generate a key, that application can use it to look up your practitioners, addresses, and services, check available time slots, and submit online booking requests on a patient's behalf, all without a person logging into Embodia.
Nerd alert: this is a REST API secured with a token. Every request the other application sends must include your API key in its headers so Embodia knows which clinic it's acting on behalf of.
Managing your API keys
The API keys page lists every key you've created, along with when it was last used. This is a useful way to spot keys that are no longer active and can be safely removed. To create a new API key:
- Go to Settings, then open the API keys tab.
- Click New API key.
- Give the key a name that identifies where it will be used (e.g. "Clinic website booking widget"). The name is just for your own reference, it doesn't affect how the key works.
- Click Submit.
Your new key will appear in the list along with the full API key value.
Keep this value secure and only share this value only with the developer or application that actually need it. Anyone who has it can act as your clinic through the API!
To remove a key, click the delete action next to it. This will deactivated it immediately, so any API calls that use this API key will stop working and the connected application will no longer be able to authenticate.
What the Clinic API can do
The Clinic API is aimed at online booking use cases: letting an external application check what's available and submit a booking request on a patient's behalf.
| Resource | What it's for |
|---|---|
| Practitioners | List the practitioners in your clinic |
| Addresses | List the clinic addresses that accept online booking |
| Services | List the services that accept online booking |
| Time slots | List the available time slots for a given day, service, and practitioner |
| Online booking requests | Submit a booking request for a patient — this does not create an appointment directly, it notifies your clinic that a patient wants to book, the same way a request submitted through your online booking page would |
For the full list of endpoints, request parameters, and response formats, see the technical reference.