Skip to main content

API keys

The Flixer Pro API uses API keys for authentication. Every request must include a valid API key in the X-API-Key header.

Creating a key

  1. Go to Settings > API keys in your Flixer dashboard
  2. Click Create new key
  3. Give the key a descriptive name
  4. Select the required scopes (see below)
  5. Click Create
The full API key is shown only once. Copy it right away and store it securely.

Scopes

API keys have scopes that determine which endpoints are accessible. Always use the minimum scopes required.

Choosing a scope

  • Website contact form: leads:write
  • CRM synchronization: leads:read + work-items:read
  • Full integration: full

Managing keys

Revoking a key

If a key is compromised or no longer needed:
  1. Go to Settings > API keys
  2. Find the key in the list
  3. Click Revoke
Revoked keys stop working immediately. Make sure your application uses a new key before you revoke the old one.

Security tips

Use environment variables or a secrets manager:
Always make API calls from your backend, never directly from the browser. API keys in frontend code are visible to everyone.
Periodically create new keys and revoke old ones. This limits the impact if a key is accidentally leaked.
Give each key only the scopes it needs. A contact form does not need full access.

Error codes

See Error handling for more details.