Authentication

Our API uses OAuth2 to authenticate and authorize customers. The following credentials will be provided by our support team.

Environment: UAT
Client internal name: {client_internal_name}
Client Id: {client_id}
Client Secret: {client_secret}
Authentication token url: https://uat.auth.circulor.io/oauth2/token

Here is a sample of how you can get a JWT bearer token from our server.

curl --location 'https://uat.auth.circulor.io/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=123abc' \
--data-urlencode 'client_secret=123abcd' \
--data-urlencode 'grant_type=client_credentials'

You will receive an access token that will be valid for 1 hour. Please reuse token for subsequent calls.

Note

The above example is for the UAT environment. The production environment will have different credentials and endpoints.

Endpoints

See the Endpoints page for a list of available endpoints for each environment.