Authentication
The Open API authenticates with scoped API keys sent as a Bearer token. Keys belong to an organization, are bound to an environment (test or live) and carry granular scopes.
Passing your key
Include the key in the Authorization header of every request:
Authorization: Bearer qk_live_9fK2mQ7xPw3Zr8TtYv1Bn4Kc6Ld0Hg5SKeep keys secret
Key anatomy
qk_live_…— production key; dispatches real riders, moves real money.qk_test_…— sandbox key; simulated riders, test credits, isolated data.- Keys are stored hashed. The plaintext value is shown exactly once at creation — store it in your secrets manager immediately.
- Optional hardening: expiry dates, IP allowlists, and per-key rate limits are configurable in the portal.
Scopes
Each key carries an explicit scope set. Requests outside a key's scopes fail with 403 SCOPE_MISSING and cost no tokens.
account:read Read org, usage, wallet
deliveries:read List & track deliveries
deliveries:write Estimate, create & cancel deliveries
products:read Read catalogue, categories, stock
products:write Create, update, publish, bulk-import
orders:read Read marketplace orders & settlements
orders:write Accept, reject, mark ready
locations:write Manage outlets & service areas
recipients:write Manage the address book
messaging:write Send SMS & emailPractice least privilege: give your tracking service deliveries:read only; give your fulfilment worker deliveries:write; keep messaging:write on a dedicated key.
Portal authentication
The web portal (this dashboard) uses email + password with JWT access/refresh tokens — the same rotation pattern used across Quickli's business products. Portal sessions are independent of API keys: revoking a key does not sign anyone out, and vice versa.
Signature verification for webhooks
Webhooks use a separate HMAC secret (not your API key). See the webhooks guide for verification examples.