API Authentication

Basic Authentication

Basic authentication works by creating Basic Credentials which have access to specific scopes, and then using those crendentials base64 encoded in the Authorization header to grant the caller access to the API endpoints.

Step By Step

  1. Create Basic Credentials in the dashboard, ensure that you securely store the client_id and client_secret that are created as you will not be able to retrieve the client_secret after it's initially created.

The scopes that are assigned to the credential are the only scopes that will be allowed in any subsequent API calls, so ensure to select all the scopes that you will require the credentials to have access to.

  1. All subsequent calls to the API should have an Authorization header added with the value set to a base64 encoded string of client_id:client_secret as a Basic token, e.g. Basic xxxxx.

For examples on how to base64 encode and add the client_id and client_secret as the Basic Authorization header, please see the Code Examples or check out the Playground in the dashboard.