Головна API документація Правила поточної реалізації API LMS

Правила поточної реалізації API LMS

Востаннє оновлено Mar 28, 2026

Public API використовує схему:

company API key -> short-lived Bearer token

Правила поточної реалізації:

  • API key належить компанії, а не окремому користувачу.

  • Для v1 дозволено один активний API key на компанію.

  • Керує ключем тільки користувач із роллю HRADMIN у cab > Settings > Company.

  • Повний секрет показується лише один раз — одразу після генерації або ротації.

  • Після ротації попередній ключ стає невалідним одразу.

  • Інтегратор отримує access token через POST /v1/auth/token і далі використовує Authorization: Bearer <token>.

  • Refresh token для інтегратора у v1 не використовується: після завершення TTL access token інтегратор повторно викликає POST /v1/auth/token.

Base URL і загальні правила виклику

1. Base URL

Поточний base URL:

  • https://smartway.pro/api

2. Загальні правила

  • Формат бізнес-відповідей: application/json

  • Формат помилок: application/problem+json

  • Версіонування: major-версія в URI (/v1/...)

  • Для кореляції запитів рекомендовано передавати traceparent