How to create and manage API keys
API keys let a third-party tool read this venue's bookings, transactions and customer details from Alba. Access is read-only: an integration cannot change or cancel anything in Alba.
Where to find it
Open Settings, then API keys. The page is marked Early access while we roll the API out.
Who can manage keys
Account Owner, Account Admin and Location Admin for the venue can use this page. Other roles do not see it.
Before the first key
When you choose Create API key for the first time at a venue, you need to accept the API terms in the same flow. Read the summary, open Read more for the full text, tick I have read and accept the API terms, then choose Accept terms. After that you can name the key and create it.
Create an API key
- Choose Create API key.
- Enter a name (for example the tool you are connecting).
- Choose Create key.
- Copy the key when it is shown. For security, Alba cannot show the full key again. If you lose it, revoke the key and create a new one.
Each venue can have up to ten active keys at once. Revoke an old key before creating another if you hit the limit.
Revoke a key
On an active key, choose Revoke and confirm. The integration loses access right away. Revoked keys stay listed under Revoked keys for reference.
What data is shared
A key gives read access to this venue only. That includes bookings, transactions and customer contact details (name, email, phone, date of birth and newsletter opt-in). Card numbers are never included.
You are responsible for using that data lawfully, keeping the key secure, and having a data-processing agreement with the vendor if they process data for you. Accepting the API terms is not the same as getting consent from your customers.
API documentation
On the API keys page, choose View documentation to open the technical guide in Alba Docs. You can also share the Partner API article with whoever builds or maintains the integration. It covers authentication, endpoints and pagination.
The API is in early access and free to use for now. Alba will give notice before any pricing change.