Страница документации API
FeedbackPulse предоставляет интерактивную страницу документации API, чтобы арендаторы могли изучать и тестировать доступные эндпоинты.
Доступ к документации API
Перейдите на /api-docs из дашборда арендатора для просмотра полного справочника API.
Группировка эндпоинтов
Эндпоинты организованы по ресурсам:
| Ресурс | Описание |
|---|---|
| Отзывы | Создание, чтение, обновление и управление отзывами |
| Продукты | Управление продуктами и их конфигурациями |
| Кампании | Создание и управление кампаниями обратной связи |
| Webhook | Настройка и управление подписками на webhook |
Детали эндпоинтов
Каждый эндпоинт отображает следующую информацию:
| Поле | Описание |
|---|---|
| HTTP-метод | Метод запроса (GET, POST, PUT, DELETE) |
| URL | Полный путь эндпоинта |
| Параметры | Обязательные и необязательные параметры с типами и описаниями |
| Пример запроса | Пример тела запроса или параметров запроса |
| Пример ответа | Пример JSON-ответа с кодом статуса |
Аутентификация
Страница документации API включает инструкции по аутентификации. Все API-запросы требуют API-ключ, передаваемый в заголовке запроса:
Authorization: Bearer {your-api-key}
API-ключи можно сгенерировать на странице Настройки арендатора.
Копирование в буфер обмена
Каждый эндпоинт включает готовую команду cURL, которую можно скопировать в буфер обмена одним нажатием, что упрощает тестирование эндпоинтов из терминала.