Інтеграції
REST API
Токени, Bearer-доступ, приклад запиту та посилання на OpenAPI-референс.
Розділи документації
REST API доступний за адресою /api/v1 і підходить для скриптів, внутрішніх сервісів, CI,
вивантажень та іншої серверної автоматизації.
Для захищених endpoints потрібен персональний API-токен. Запит виконується від імені користувача, який випустив токен, і проходить ті самі перевірки ролей та прав.
Авторизація
Передавайте токен в HTTP-заголовку:
Authorization: Bearer <token>
Як створювати, зберігати та відкликати токени, описано в статті API-токени.
Приклад запиту
curl -sS "$TEALBAND_BASE_URL/api/v1/{org}/surveys" \
-H "Accept: application/json" \
-H "Authorization: Bearer $TEALBAND_API_TOKEN"
Замініть {org} на ID організації. Параметри конкретного endpoint, формат відповіді та коди
помилок дивіться в повній специфікації.
Повна документація
- OpenAPI reference — інтерактивна документація щодо endpoints, параметрів та схем відповідей.
- OpenAPI JSON — машинозчитувана схема для генераторів клієнтів, Postman, Insomnia та перевірок контрактів.