Authentication
Each customer gets one or more API keys, which look like efk_ followed by 32 characters. We store only a hash, so a lost key cannot be recovered; ask us for a new one.
Send the key in one of these ways (in order of preference):
| Where | Example |
|---|---|
Header Authorization |
Authorization: Bearer efk_… |
Header X-Api-Key |
X-Api-Key: efk_… |
| Query string | ?key=efk_… (for browsers' WebSocket, which cannot set headers) |
Keep keys on your servers. Anyone who has a key spends its limits. To show live data in a browser, proxy it through your backend, or use the pitch embed, which uses short-lived tokens instead of your key.
A revoked key gets 403 on REST and its open WebSockets are closed with code 4001.