Getting started
Authentication
Every request to the developer API is made from your server with a secret key in the Authorization header.
The header
Authorization: Bearer <secret key>Requests without the header, or with a key that is revoked, expired or belongs to an inactive organisation, get 401.
Secret keys
- Created in the maker console under Settings → API keys, by an organisation Owner or Admin.
- Each key has a name and an environment,
testorlive, and can have an expiry date. - The full key is shown once, when you create or regenerate it. Ploba stores only a hash.
- Regenerate a key to replace it, or revoke it to stop it working.
Test and live
Build and test against a test key, then switch to a live key in production. Keep separate keys per environment so you can revoke one without touching the other.
Keeping keys safe
- Call the API only from your server. A key in a browser or app bundle is public.
- Store keys in environment variables or a secret manager, never in source control.
- Revoke a key straight away if it leaks, and regenerate keys when someone with access leaves the team.