REST API

REST API доступний за /api/v1 і підходить для скриптів, внутрішніх сервісів, CI, вивантажень та іншої серверної автоматизації.

Для захищених endpoints потрібен персональний API-токен. Запит виконується від імені користувача, який випустив токен, і проходить ті самі перевірки ролей і прав.

Авторизація

Передавайте токен в HTTP-заголовку:

Authorization: Bearer <token>

Як випускати, зберігати та відкликати токени, описано у статті API-токени.

Приклад запиту

curl -sS "$PLATFORM_BASE_URL/api/v1/{org}/surveys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PLATFORM_API_TOKEN"

Замініть {org} на ID організації. Параметри конкретного endpoint, формат відповіді та коди помилок дивіться в повній специфікації.

Ліміти запитів

API захищено від перевантаження обмеженням частоти:

• Авторизований API застосунку: 300 запитів на хвилину на користувача або IP.
• Webhook платіжного провайдера: 600 запитів на хвилину.
• Публічні endpoints (/status, картки бази знань): 300 запитів на хвилину за IP.

При перевищенні ліміту сервер повертає HTTP 429 Too Many Requests із заголовком Retry-After (кількість секунд до повтору) та тілом помилки:

{
  "status": 429,
  "message": "Забагато запитів. Спробуйте за 30 сек.",
  "errors": {}
}

Повна документація

• OpenAPI reference — інтерактивна документація щодо endpoints, параметрів і схем відповідей.
• OpenAPI JSON — машиночитана схема для генераторів клієнтів, Postman, Insomnia і перевірок контрактів.