Authentication

Get OAuth access token

Obtain an access token using OAuth 2.0 client credentials flow. This token is required for all other API endpoints.

Rate Limiting: 100 requests per minute per IP address.

post/api/v1/external/auth/token

Request

Request body

grant_type'client_credentials' required
client_idstring required
client_secretstring required
scopestring

Space-separated list of scopes. Available scopes include shipments:read, shipments:write, customs:read, customs:write, documents:read, documents:write, documents:delete and analytics:read.

Example request

{
  "grant_type": "client_credentials",
  "client_id": "wove_prod_abc123...",
  "client_secret": "sk_...",
  "scope": "shipments:read documents:read validation:create"
}

Response

Access token generated successfully

access_tokenstring
token_typestring
expires_ininteger

Token lifetime in seconds

scopestring

Example response

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "shipments:read documents:read validation:create"
}

Changes

No recorded changes to this operation across all 1 revision of this API.