Интеграции
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 и проверок контрактов.