API keys

An API key lets your own code use the Summerbase API, usually to send data through a custom source.

Each key belongs to one project, and everything it sends is recorded as coming from one custom source. So create the custom source first, then the key.

Create a key

Admins and the owner create keys in Settings, then API keys, or on a custom source’s page. Give the key a name that says where it’s used, such as “Production backend”, and pick the source it sends to.

Caution

The secret is shown once. Copy it straight away and keep it on your server: anyone who has it can do what the key can.

Using a key

Send the key’s secret with every request to the API. The API reference explains how, and lists everything you can do with a key.

Lost or leaked keys

A secret can’t be shown again. If you lose it, or it may have leaked, create a new key, switch your code over, and delete the old one. Deleting a key stops it working immediately.