Getting an API key

The Covram API lets other software read the data in your projects, such as your sites, visits and photopoints. For example, you could use it to feed Covram data into a report or another system.

The API is read-only: it can't add, change or delete anything. It is documented in full at api.covram.com.au, including every route, the details you can send and the responses you get back. These pages cover only how to get access and manage your keys.

Get API access

API access is turned on for your account by Covram.

1. Email support@covram.com.au and say that you would like API access.
2. Include the email address of your Covram account. You need an account first. See creating an account.

Once Covram has turned it on, the API Keys page in the Covram Dashboard lets you create keys. Until then it says API access hasn't been granted for this account yet. After access is granted, reload the page.

Create a key

1. Sign in to the Covram Dashboard in your web browser using your laptop or desktop computer.
2. In the sidebar, open Settings, then choose API Keys.
3. Click Generate New Key.
4. Optionally, enter a Label to remind you what the key is for, such as Reporting script. Click Generate.
5. Click Copy and save the key somewhere safe, such as a password manager.
6. Click Done.

Use the key

Send your key with each request to the API, in a header called X-Api-Key. Keys start with cvpk_.

What a key can read

A key can only read data from projects you belong to. If you are removed from a project, the key stops working for it.

To look after your keys, see managing API keys.