Authentication

You'll need to authenticate your requests to access any of the endpoints in the Orchestrate API. Orchestrate uses OAuth2 with bearer tokens for all API authentication.

Obtaining your API key

To get your API key, head over to your Orchestrate dashboard and create a new API key. Once generated, copy the key and store it in a secure place—for security reasons, the key will not be shown again in the dashboard.

If you ever lose or suspect that your API key has been compromised, you can revoke it and generate a new one at any time from the dashboard.

Authenticating with your API key

To authenticate with the Orchestrate API, include your API key as a bearer token in the Authorization header of your requests. You can generate and view your API key in the Orchestrate dashboard under Developer settings. Below are examples of how to add the token to your request headers:

curl -X POST "$ORCHESTRATE_BASE_URL/api/v1/payments" \
  -H "Authorization: Bearer $ORCHESTRATE_API_KEY" \
  -d '{}'

Always keep your API key safe and reset it if you suspect it has been compromised.