Set up and manage API credentials

  • Updated

Organizations can use the Secaro API (application programming interface) to connect their emissions data in Secaro to their own systems. This article explains how to create, regenerate and revoke API credentials. It is written for the technical, data or platform teams who manage system integrations.

For help during setup, contact the Secaro team.

Create API credentials

Creating credentials needs a Secaro user account with permission to manage API credentials for the organization.

  1. Sign in to Secaro and open API credentials from the user settings menu.
  2. Select Create API credentials.
  3. Copy the Client ID and Client secret and store them securely. Both are needed to authenticate with the API.
  4. Select I have saved my credentials.

Important: The client secret is shown only once and can't be retrieved later. The client ID stays visible on the API credentials page.

Regenerate the client secret

Important: Regenerating the client secret stops the old secret from working straight away. Any integration using the old secret stops working until it is updated.

  1. Sign in to Secaro and open API credentials from the user settings menu.
  2. Select Regenerate secret and confirm.
  3. Copy the new client secret and store it securely. It is shown only once.
  4. Update every system or integration that uses the API with the new client secret.

Revoke API credentials

Important: Revoking credentials turns off all API access for the organization straight away. This can't be undone. Integrations stop working until new credentials are created and set up.

  1. Sign in to Secaro and open API credentials from the user settings menu.
  2. Select Revoke credentials and confirm.

New credentials can be created at any time by following the steps in Create API credentials.

How access tokens work

When credentials are used to authenticate with the Secaro API, an access token may already have been issued. Secaro uses short-lived access tokens, which limit the impact if credentials are exposed.

After credentials are regenerated or revoked, existing tokens can't be refreshed and expire automatically. This means access can be controlled quickly when credentials are changed or removed.

API documentation

Full technical documentation for the Secaro API is available in the OpenAPI specification. Technical teams can use it to explore the available data and build and maintain integrations.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request