API keys
The Flixer Pro API uses API keys for authentication. Every request must include a valid API key in theX-API-Key header.
Creating a key
- Go to Settings > API keys in your Flixer dashboard
- Click Create new key
- Give the key a descriptive name
- Select the required scopes (see below)
- Click Create
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:- Go to Settings > API keys
- Find the key in the list
- Click Revoke
Security tips
Never store keys in code
Never store keys in code
Use environment variables or a secrets manager:
Use server-side calls
Use server-side calls
Always make API calls from your backend, never directly from the browser. API keys in frontend code are visible to everyone.
Rotate keys regularly
Rotate keys regularly
Periodically create new keys and revoke old ones. This limits the impact if a key is accidentally leaked.
Use minimal scopes
Use minimal scopes
Give each key only the scopes it needs. A contact form does not need
full access.Error codes
See Error handling for more details.