REST API и аутентификация

ImpactBot предоставляет публичный REST API для интеграции с вашими сервисами.

Интеграции и доступ к API
Интеграции и доступ к API

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

  1. Откройте проект → «Настройки» → раздел «Публичный API»
  2. Отметьте нужные права, при необходимости задайте срок жизни ключа
  3. Нажмите «Создать ключ»
  4. Скопируйте ключ — он показывается только один раз, мы храним лишь его хеш

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

Передавайте ключ в заголовке X-API-Key:

curl -X GET https://api.impactbot.ru/public/v1/clients \
  -H "X-API-Key: ваш_ключ"

Идентификатор проекта нигде передавать не нужно: проект определяется ключом.

Основные endpoints

  • GET /public/v1/clients — список клиентов
  • GET /public/v1/clients/{id} — карточка клиента
  • POST /public/v1/clients/{id}/message — отправить сообщение клиенту
  • POST /public/v1/clients/{id}/tag — поставить метку
  • GET /public/v1/flows — список воронок
  • POST /public/v1/flows/{id}/trigger — запустить воронку для клиента
  • POST /public/v1/broadcasts — создать рассылку
  • GET /public/v1/tables — таблицы проекта

Создания клиента через API нет: клиент появляется, когда человек пишет боту.

Повторные запросы

У всех запросов, которые что-то меняют, есть заголовок Idempotency-Key. Пришлите с ним произвольную строку — и повтор после таймаута вернёт сохранённый ответ вместо второго действия.

Rate limits

  • 100 запросов в минуту на ключ

При превышении сервер вернёт 429 Too Many Requests и заголовок Retry-After.

Документация

Полная документация с примерами, правами и кодами ошибок — /api-docs. Там же есть песочница для проверки запросов.