For the complete documentation index, see llms.txt. This page is also available as Markdown.

Авторизація

Згенерувати тимчасовий JWT-токен

get
/clients/authorization

Генерує тимчасовий JWT-токен для виконання авторизованих API-запитів. Як query-параметр необхідно передати валідний apiKey.

Як отримати apiKey:

  • У Sandbox використайте POST /test-api-keys із зареєстрованим номером телефону з Client Portal (EBC): https://my.novapost.com/

  • У PROD використовуйте персональний apiKey, наданий вашим менеджером

Використання:

  • Виконайте GET /clients/authorization?apiKey={apiKey}

  • У разі успіху скопіюйте jwt із відповіді

  • Відкрийте діалог Authorize у цій документації, виберіть схему JWT і вставте jwt

  • Після цього всі Try-it-out запити автоматично включатимуть Authorization: {jwt}

Примітки:

  • JWT дійсний приблизно 1 годину; після завершення строку дії потрібно запросити новий

  • Не зберігайте jwt довше за його TTL

  • Маршрут /test-api-keys недоступний у PROD

Query parameters
apiKeystringRequired

Для використання цього методу потрібен персональний API-ключ.

Responses
200

JWT-token

application/json
jwtstring · jsonOptional

Персональний JWT-токен, дійсний протягом 1 години для запобігання шахрайству. Після завершення терміну дії потрібно згенерувати новий токен.

Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJucCIsImlhdCI6MTY4NTYyNzQxNCwiZXhwIjoxNjg1NjMxMDE0LCJjaWQiOiI1YzQxMmUzYS01ODY4LTQ4YjktYTYwYS0wZTAzOTI4NGVjNDYiLCJyZWYiOiI2NDI0NmRkMzg0ZWI3Yzg2MmMwMzg3YzAifQ.MmhM9rHCYItjA5a7B9PtrdKUKRiHhN43UotWKtKjt78
get/clients/authorization
GET /v.1.0/clients/authorization?apiKey=text HTTP/1.1
Host: api-stage.novapost.com/
Accept: */*
{
  "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJucCIsImlhdCI6MTY4NTYyNzQxNCwiZXhwIjoxNjg1NjMxMDE0LCJjaWQiOiI1YzQxMmUzYS01ODY4LTQ4YjktYTYwYS0wZTAzOTI4NGVjNDYiLCJyZWYiOiI2NDI0NmRkMzg0ZWI3Yzg2MmMwMzg3YzAifQ.MmhM9rHCYItjA5a7B9PtrdKUKRiHhN43UotWKtKjt78"
}

Останнє оновлення