Authorization

Generate a temporary JWT-token

get

/clients/authorization

Issues a temporary JWT-token for making authorized API requests. A valid apiKey must be provided as a query parameter.

How to obtain an apiKey:

• In Sandbox, use POST /test-api-keys with a registered phone number from the Client Portal (EBC): https://my.novapost.com/
• In PROD, use your personal apiKey provided by your manager

Usage:

• Call GET /clients/authorization?apiKey={apiKey}
• On success, copy the jwt from the response
• Open the Authorize dialog in this documentation, select the JWT scheme, and paste the jwt
• All Try-it-out requests will then automatically include Authorization: {jwt}

Notes:

• The jwt is valid for ~1 hour; request a new one after expiry
• Do not store jwt beyond its TTL
• The /test-api-keys route is not available in PROD

Query parameters

apiKeystringRequired

To utilize this method, a personal API key is required.

Responses

200

JWT-token

application/json

jwtstring · jsonOptional

Personal JWT-token, expires after one hour to prevent any fraud, requiring a new request to generate a fresh token.

Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJucCIsImlhdCI6MTY4NTYyNzQxNCwiZXhwIjoxNjg1NjMxMDE0LCJjaWQiOiI1YzQxMmUzYS01ODY4LTQ4YjktYTYwYS0wZTAzOTI4NGVjNDYiLCJyZWYiOiI2NDI0NmRkMzg0ZWI3Yzg2MmMwMzg3YzAifQ.MmhM9rHCYItjA5a7B9PtrdKUKRiHhN43UotWKtKjt78

401

Unauthorized

application/json

422

Validation error

application/json

503

Connection time-out

application/json

get/clients/authorization

GET /v.1.0/clients/authorization?apiKey=text HTTP/1.1
Host: api-stage.novapost.com/
Accept: */*

{
  "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJucCIsImlhdCI6MTY4NTYyNzQxNCwiZXhwIjoxNjg1NjMxMDE0LCJjaWQiOiI1YzQxMmUzYS01ODY4LTQ4YjktYTYwYS0wZTAzOTI4NGVjNDYiLCJyZWYiOiI2NDI0NmRkMzg0ZWI3Yzg2MmMwMzg3YzAifQ.MmhM9rHCYItjA5a7B9PtrdKUKRiHhN43UotWKtKjt78"
}