latestOpenAPI 3.0.02026-08-10234193.3 KB

60e380005037

Authorization

Create or renew a test API key (Sandbox only)

Public endpoint available only in non-production environments (Sandbox) to create or renew a test API key for a client identified by phone.

Requirements:

  • The phone number must be registered in the Client Portal (EBC): https://my.novapost.com/
  • UA key generation is currently not supported

Behavior:

  • If a key already exists and is Active, a repeated call within the same day will return the same key
  • If expired, the key will be reactivated with a new expiration date
  • If deleted by cleanup, a new key will be created
  • Only one active key is allowed per phone, limited to one request per day

Next step: After receiving the apiKey, you must generate a temporary JWT by calling GET /clients/authorization. The JWT is required for all authorized requests. Paste the jwt into the Authorize dialog under the JWT scheme in this documentation to enable Try-it-out.

post/test-api-keys

Request body

phonestring required

Phone number registered in EBC. Format like 49XXXXXXXXX (no '+'). UA keys generation is currently not supported.

Response

Test API key created or returned

apiKeystring required

Test API key for Stage usage only.

createdAtstring date-time required
expDatestring date-time required
status'Active' | 'Expired' required