Before you begin

You need:

  • A developer account on this portal. Sign up if you don't have one yet.
  • A terminal with curl, or Node.js 18+ or Python 3.9+ if you'd rather use code.
  • About five minutes.

1. Register an application

Applications hold your credentials and decide which APIs you can call.

  1. Open My applications and select New application.
  2. Name it after the project you're building, such as order-sync.
  3. Register the application with each API it needs to call.
Waiting for approval?

Some APIs approve registrations right away; others need an administrator. You'll get an email as soon as yours is approved. Until then, requests to that API return 403 Forbidden.

2. Generate credentials

Open your application and generate credentials. Which kind you use depends on the API:

CredentialBest forHow to send it
API keyServer-to-server callsAuthorization: Bearer <API_KEY>
OAuth 2.0 client credentialsShort-lived, scoped tokensExchange them for an access token, then send Authorization: Bearer <token>
Keep your key secret

You can see the full key only once. Store it in a secrets manager or an environment variable, never in source control or client-side code.

Export the key so the examples below can use it:

export API_KEY="paste-your-key-here"

3. Make your first request

List your most recent order:

curl "https://api.example.com/v1/orders?limit=1" \
  -H "Authorization: Bearer $API_KEY"

A successful request returns 200 OK and a JSON body:

{
  "data": [
    {
      "id": "ord_1042",
      "status": "shipped",
      "total": 129.00
    }
  ],
  "has_more": false
}

4. Check the response

If you didn't get a 200 OK, the status code tells you what to fix:

StatusMeaningWhat to do
401 UnauthorizedThe key is missing, revoked, or mistyped.Check the Authorization header and the key.
403 ForbiddenYour application isn't registered with this API yet.Register it, or wait for approval.
429 Too Many RequestsYou're over your rate limit.Wait for the time in the Retry-After header, then retry.

Next steps