API keys let your own systems talk to Veribl through the REST API. For each key you choose what it can do in each area: products (including manuals and files), passports (including battery data), articles, registrations and contacts.
The REST API is part of the API & webhooks add-on ($79 a month, included in Enterprise). Keys created before October 16, 2026 keep working on any plan. Without the add-on, newer keys get a 403 with the code plan_required. The battery passport data endpoint works on every plan.
Create an API key
- In the dashboard, go to Settings, then API keys
- Click New API key
- Give it a clear name, like "ERP sync" or "Staging"
- Under Access, turn on each area the key needs, then choose Read or Read and write. Read-only key and Full access key set every area at once.
- Click Create and copy the key right away
The key starts with vdpp_. Veribl shows it once. If you lose it, revoke it and create a new one.
Tip: Give each system only what it needs. A PIM sync needs Read and write on products, not access to your customers' contacts.
Registrations and contacts can only be read through the API, so they offer No access or Read.
Keys created before access per area keep the access they had: Read only or Read and write in every area.
Use your API key
Send the key in the Authorization header of every request:
Authorization: Bearer vdpp_your_key_here
A request outside the key's access gets a 403 error with the code insufficient_scope. See the REST API article for all endpoints.
Tip: Store keys in a secret manager or environment variable. Never put them in source code, front-end code or chat messages.
Change what a key can do
- Go to Settings, then API keys
- Open the key's menu and click Edit access, or click the key and then Edit access
- Change its name or access, then click Save
The change applies from the key's next request. You don't need a new key.
Rotate a key
Rotating replaces a key without breaking the systems that use it. Do it regularly, or when someone who had the key leaves.
- Go to Settings, then API keys, and click the key
- Click Rotate, then Rotate key
- Copy the new key. It has the same name and access.
- Put the new key in your systems
The old key keeps working for 7 days. Its status shows the day it stops. When its Last used date no longer changes, nothing uses it anymore. To end it before the 7 days are up, open the old key and click Stop now.
After the 7 days, the old key gets a 401 error with the code key_expired.
Revoke a key
If a key is leaked or no longer needed:
- Go to Settings, then API keys
- Open the key's menu and click Revoke key
- It stops working right away
A revoked key can't be turned back on. Create a new one instead. If the key was leaked, revoke it rather than rotating it: rotating keeps the old key working for 7 days.
See a key's API calls
Click API activity on Settings › API keys to see every call your keys made in the last 14 days: total calls, error rate, a chart, and a log with the time, key, request and status of each call. Filter by key or show only errors. Click a call to see its error message, IP address and client.
Each key's page also shows its most recent calls.
See what a key changed
Keys belong to your company, not to the person who created them, so they keep working when that person leaves. Every change a key makes is in the audit log under its name.
On Settings › API keys, the Changes column shows how many changes each key made. Click the number to see them in the audit log.
Connect Claude
Give Claude your PDF manuals and it writes them out as the help articles on your product pages. See Connect Claude.
Was this article helpful?