Справочник API
Методы публичного API. Полная машинночитаемая спецификация OpenAPI 3.1 доступна для скачивания; в справочнике нет «попробовать»: ключи интеграций не вводятся на странице.
Базовые адреса
Три независимые ячейки. Ключ работает только в той ячейке, где выпущен; в ином случае вернётся wrong_cell.
| Ячейка RU | https://formula-cream.pro/api/public/v1 |
| Ячейка EN | https://wfacademy.org/api/public/v1 |
| Ячейка ID | https://wfacademy.id/api/public/v1 |
Авторизация
Заголовок Authorization: Bearer '<'ключ>. Все запросы только по HTTPS.
Методы
Ни один метод не подходит под фильтр.
Аккаунт 2
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /me | Кто я | — | Доступно |
| GET | /wallet | Кошелёк и состояние обмена | — | Доступно |
Диалоги 3
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /conversations | Список диалогов | conversations:read | Доступно ПДн |
| GET | /conversations/{id} | Получить диалог | conversations:read | Доступно ПДн |
| GET | /conversations/{id}/messages | Сообщения диалога | conversations:read | Доступно ПДн |
Аналитика 4
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /analytics/timeseries | Временные ряды | analytics:read | Доступно |
| GET | /analytics/traffic-sources | Источники трафика | analytics:read | Доступно |
| GET | /analytics/funnel | Воронка | analytics:read | Доступно |
| GET | /analytics/visibility | Видимость | analytics:read | Доступно |
Дашборды 2
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /dashboards/overview | Дашборд «Обзор» | dashboards:read | Доступно |
| GET | /dashboards/pulse | Дашборд «Пульс» | dashboards:read | Доступно |
Лиды 2
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /leads | Список лидов | leads:read | Доступно ПДн |
| GET | /leads/{id} | Получить лид | leads:read | Доступно ПДн |
Статьи 2
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /articles | Список статей | articles:read | Доступно |
| GET | /articles/{id} | Получить статью | articles:read | Доступно |
Стратег 6
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /strategist/reports | Список отчётов стратега | strategist:read | Доступно |
| GET | /strategist/reports/{id} | Получить отчёт стратега | strategist:read | Доступно |
| GET | /strategist/topics | Очередь тем | strategist:read | Доступно |
| GET | /strategist/topics/{id} | Получить тему | strategist:read | Доступно |
| GET | /strategist/actions | Действия стратега из ваших сессий | strategist:read | Доступно |
| GET | /strategist/actions/{id} | Получить действие стратега | strategist:read | Доступно |
Вебхуки 8
| Метод | Путь | Описание | Области | Статус |
|---|---|---|---|---|
| GET | /webhooks | Список подписок | webhooks:manage | Доступно |
| POST | /webhooks | Создать подписку | webhooks:manage | Доступно |
| GET | /webhooks/{id} | Получить подписку | webhooks:manage | Доступно |
| PATCH | /webhooks/{id} | Изменить подписку | webhooks:manage | Доступно |
| DELETE | /webhooks/{id} | Удалить подписку | webhooks:manage | Доступно |
| POST | /webhooks/{id}/rotate-secret | Заменить секрет | webhooks:manage | Доступно |
| POST | /webhooks/{id}/test | Тестовая доставка | webhooks:manage | Доступно |
| GET | /webhooks/{id}/deliveries | Журнал доставок | webhooks:manage | Доступно |