Обзор REST API v2

FeedbackPulse SaaS предоставляет RESTful API (v2) для программного доступа к данным арендатора. Используйте его для интеграции обратной связи в свои приложения, создания дашбордов или автоматизации рабочих процессов.

---

Базовый URL

https://yourdomain.com/api/v2

---

Аутентификация

Все запросы к API требуют Bearer-токена (API-ключа):

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://yourdomain.com/api/v2/submissions

Получение API-ключа

1. Войдите в дашборд арендатора
2. Перейдите в Настройки > API-ключи
3. Нажмите Создать API-ключ
4. Скопируйте ключ немедленно (он показывается только один раз!)

API-ключи хранятся как хэши SHA256. Исходный ключ не может быть восстановлен.

Требование к плану: Доступ к API требует флага функции api_access в вашем плане.

---

Ограничение запросов

Лимит	Значение
Запросов в минуту на арендатора	60

Заголовки лимита запросов включены в каждый ответ:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57

---

Доступные эндпоинты

Метод	Эндпоинт	Описание
GET	/api/v2/submissions	Список обращений
GET	/api/v2/submissions/{id}	Получить одно обращение
POST	/api/v2/submissions	Создать обращение
GET	/api/v2/products	Список продуктов
POST	/api/v2/products	Создать продукт
GET	/api/v2/campaigns	Список кампаний
POST	/api/v2/campaigns	Создать кампанию
GET	/api/v2/webhooks/config	Получить конфигурацию вебхука
PUT	/api/v2/webhooks/config	Обновить конфигурацию вебхука
GET	/api/v2/webhooks/logs	Просмотреть логи доставки вебхуков

---

Формат ответа

Все ответы в формате JSON:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42
  }
}

Ответы об ошибках

{
  "error": "Unauthenticated.",
  "status": 401
}

Код статуса	Значение
200	Успех
201	Создано
400	Неверный запрос (ошибка валидации)
401	Не авторизован (неверный/отсутствующий API-ключ)
403	Доступ запрещён (недостаточно прав)
404	Не найдено
429	Слишком много запросов (лимит превышен)
500	Ошибка сервера

---

Подробнее

• Аутентификация — детали API-ключа
• API обращений — создание и список обратной связи
• API продуктов — управление продуктами
• API кампаний — управление кампаниями
• Вебхуки — уведомления о событиях в реальном времени