API Keys
Create and manage API keys
API keys allow your server-side applications to securely communicate with Betazu BOS.
What is a BOS API key?
A BOS API key is a credential that identifies and authenticates your application when it makes requests to the BOS API.
Each key belongs to an application and can be configured with specific permissions.
Create an API key
From your BOS application, open the API keys section and choose Create API key.
Enter a key name
Use a name that helps you identify where the key is used, such as Production, Staging, or Website.
Select permissions
Choose the BOS resources and actions that the application needs.
Generate the key
BOS generates the API credential and displays the secret.
Copy the secret
Copy the secret immediately and store it securely. It will not be shown again.
The API key secret
Your secret is displayed only once immediately after the key is created.
bz_live_...Copy it immediately
BOS cannot display the secret again after you leave the creation screen. If you lose it, create a new API key.
Store your key in an environment variable
We recommend storing your BOS API key in your server environment rather than directly in your source code.
BETAZU_BOS_API_KEY=bz_live_...Permissions
API keys can be restricted to specific actions. Grant only the permissions your application actually needs.
Read
Read lead information.
bos:leads:readCreate
Create new leads.
bos:leads:createUpdate
Update existing leads.
bos:leads:updateDelete
Delete leads.
bos:leads:deleteRevoke an API key
If a key is no longer needed or may have been exposed, revoke it from your BOS application.
A revoked API key can no longer be used to authenticate requests.
Security best practices
Use separate API keys for different applications or environments.
Give each key only the permissions it requires.
Store secrets in environment variables or a secrets manager.
Never put API keys in frontend JavaScript.
Never commit API keys to Git repositories.
Revoke a key immediately if it may have been exposed.