Формула ИИ для разработчиков Справочник API Каталог ошибок OpenAPI
Разделы

Начало

Чаты и ИИ-продажник

Аналитика и дашборды

CRM и лиды

Статьи

Стратег

Дополнительно

Шаблоны и примеры

Справочник API

Справочник API

Методы публичного API. Полная машинночитаемая спецификация OpenAPI 3.1 доступна для скачивания; в справочнике нет «попробовать»: ключи интеграций не вводятся на странице.

Базовые адреса

Три независимые ячейки. Ключ работает только в той ячейке, где выпущен; в ином случае вернётся wrong_cell.

Ячейка RUhttps://formula-cream.pro/api/public/v1

Авторизация

Заголовок Authorization: Bearer <ключ>. Все запросы только по HTTPS.

Скачать OpenAPI

Методы

Аккаунт 3

МетодПутьОписаниеОбластиСтатус
GET/meКто я—Доступно
GET/walletКошелёк и состояние обмена—Доступно
GET/operations/{id}Состояние операции—Доступно

Диалоги 5

МетодПутьОписаниеОбластиСтатус
GET/conversationsСписок диалоговconversations:readДоступно ПДн
POST/conversationsНайти или завести диалогconversations:writeДоступно ПДн
GET/conversations/{id}Получить диалогconversations:readДоступно ПДн
GET/conversations/{id}/messagesСообщения диалогаconversations:readДоступно ПДн
POST/conversations/{id}/messagesСообщение клиента и ответ ИИconversations:writeДоступно ПДн

Аналитика 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}/testТестовая доставкаwebhooks:manageДоступно
GET/webhooks/{id}/deliveriesЖурнал доставокwebhooks:manageДоступно
GET/.well-known/jwks.jsonОткрытые ключи подписи вебхуков—Доступно

Каналы 2

МетодПутьОписаниеОбластиСтатус
GET/channels/{id}/widgetНастройки чат-виджетаchannels:readДоступно
PATCH/channels/{id}/widgetИзменить настройки чат-виджетаchannels:writeДоступно

Карточки товаров 6

МетодПутьОписаниеОбластиСтатус
GET/cardsСписок карточекcards:readДоступно
POST/cardsСоздать карточкуcards:writeДоступно
GET/cards/{code}Получить карточкуcards:readДоступно
PATCH/cards/{code}Изменить карточкуcards:writeДоступно
DELETE/cards/{code}Удалить карточкуcards:writeДоступно
POST/conversations/{id}/cardsОтправить карточки в диалогconversations:writeДоступно ПДн