​

Authentication

​

Setup

1. Create an API key in the Firmium dashboard under API / Schnittstelle. The full key is shown only once, at creation.
2. Attach it to your requests.
3. To revoke a key, delete it in the same dashboard section. Deleted keys stop working immediately.

​

Header

Authorization: Token <your_api_key>

Note: The scheme is Token, not Bearer.

​

Key format

• The key is an opaque string issued by Firmium.
• Firmium stores only a hash of the key and cannot show it again.
• Treat it like a password: store it securely and do not share it.
• API access depends on your plan. Requests with a key from a plan without API access are rejected.

​

Example request

curl -X POST https://www.firmium.de/api/v1/companies/search/ \
  -H "Authorization: Token <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{"name": "Beispiel GmbH"}'

​

Errors

{
  "detail": "Invalid token"
}

​

Best practices

1. Storage: Keep keys out of git.
2. Rotation: Rotate keys and delete unused ones.
3. Errors: Handle 403 explicitly.
4. Rate limits: Back off when you hit rate limits.

​

Next steps

• Rate limits
• Error codes