Issue an access token

Exchanges integrator client credentials for a bearer access token. Public (no bearer required). Proxies the Zeam Auth Service token endpoint.

POST /auth/token

Issue an access token

cURL

curl --request POST \
  --url https://api.zeam.app/v1/auth/token \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "11111111-1111-1111-1111-111111111111",
  "clientSecret": "s3cr3t-value"
}
'

200

{
  "accessToken": "eyJ0eXAiOiJKV1Qi...",
  "tokenType": "Bearer",
  "expiresIn": 3599
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Body

application/json

clientId · string<uuid> · required

clientSecret · string · required

Response

200

application/json

Token issued.

accessToken · string · required

tokenType · string · required

Example:

"Bearer"

expiresIn · integer · required

Seconds until expiry

Example:

3599

associationId · string<uuid> · required

Zeam association the credentials map to.