Generate an API Key
How to generate a BookVAULT API key from the portal Apps page.
Before you begin
Every request to the Bookvault API must be authenticated with an API key. Your key identifies you as an individual Bookvault user and grants access based on your account's permissions. Keys are generated and managed from the Apps page of the Bookvault portal.
Generating a key
Follow these steps to generate a new API key from the Bookvault portal.
1. Open the Apps page
Sign in to the Bookvault portal and navigate to Apps.
2. Open your API credentials
Select Get Credentials to open the API credentials dialog.
3. Generate a new key
Choose Generate New Key. Your key is created with a
bv_ prefix.
4. Copy and store your key
Your key is only shown once. Copy it immediately and store it somewhere secure. If you
lose it, simply generate a new one — this replaces any existing key.
Using your key
Send your API key with every request in the x-bookvault-api-key header.
GET /api/orders HTTP/1.1
Host: your-bookvault-api-host
x-bookvault-api-key: bv_your_api_key_hereKeeping your key safe
API keys grant full access to your account. Anyone with your key can interact with your account as if
they were you. Protect your key as you would any sensitive credential.
- Keep your key private. Never share it publicly or expose it in client-side code or version control.
- Use environment variables. Store keys securely rather than hard-coding them.
- Rotate keys regularly. Generate a new key periodically, and immediately if a key is compromised.
- Delete unused keys. Remove a key from the Apps page as soon as it is no longer needed.