#Журнал изменений
Статус: Доступно. Журнал ведётся с момента первой публикации документации.
Назначение: фиксировать изменения контракта публичного API и документации. Любое несовместимое изменение и любое устаревание объявляется здесь не менее чем за 90 суток до вступления в силу (заголовки Deprecation и Sunset дублируют запись в ответах API; см. Соглашения).
#Политика версий
| Правило | Описание |
|---|---|
| Версия в адресе | /api/public/v1 |
| Внутри версии | Только добавляющие изменения (новые точки, необязательные параметры, поля ответа) |
| Несовместимое изменение | Выходит как новая версия (v2); v1 продолжает работать в течение срока устаревания |
| Срок уведомления | Не менее 90 суток до отключения |
| Как узнать | Запись здесь + заголовки Deprecation, Sunset в ответах |
| Статусы страниц | «Доступно», «Бета», «Планируется» — см. README |
#Формат записи
Каждая запись содержит дату, затронутую область и тип изменения: добавлено, изменено, устарело, удалено, исправлено, безопасность.
#2026-10-11 — серверный API: чтение, кошелёк, вебхуки v2
API
- Добавлено:
GET /me,GET /wallet; вебхуки v2 (подписки, подпись, повторы, журнал доставок). - Добавлено: чтение диалогов и сообщений (
GET /conversations,GET /conversations/{id},GET /conversations/{id}/messages). - Добавлено: чтение аналитики (
/analytics/timeseries,/analytics/traffic-sources,/analytics/funnel,/analytics/visibility) и дашбордов (/dashboards/overview,/dashboards/pulse). - Добавлено: чтение лидов (
GET /leads,GET /leads/{id}), статей (GET /articles,GET /articles/{id}), отчётов, тем и действий стратега. - Остаются «Планируется»: запись (ответы в диалогах, правка лидов и статей, решения по темам и действиям), события и офлайн-конверсии, генерация статей, чат со стратегом, карта статусов, JS API виджета v2, тестовые ключи и песочница,
GET /disclosures.
Документация
- Изменено: статусы страниц переведены с «Планируется» на «Доступно» для выпущенных точек; поля ответов сверены с реализацией.
- Статус «Доступно» действует с выкладкой на ячейку и применением её миграций; чтение, зависящее от миграции, до этого отвечает
503.
#2026-10-11 — первая редакция документации
Документация
- Добавлено: структура документации и сквозные разделы — введение, быстрый старт, аутентификация, ячейки и данные, соглашения, вебхуки, журнал изменений, глоссарий.
- Добавлено: описание существующих клиентских интерфейсов — виджета чата, Chat API, загрузчика, JS-трекера, серверного маяка и модулей для CMS, публикатора статей через коннектор (статус «Доступно»; подробности — в разделах
chat/,analytics/,articles/). - Добавлено: описание серверного API по секретному ключу (статус «Планируется»): интеграции и ключи, области, диалоги и ИИ-продажник, лиды и внешняя CRM, аналитика и дашборды, статьи, стратег, вебхуки v2.
API
Серверный API версии v1 ещё не выпущен: изменений контракта не было. До выхода спецификации OpenAPI примеры ответов носят иллюстративный характер.
#Запланированные изменения платформы, влияющие на интеграторов
Записи ниже — предупреждения о том, что изменится, а не журнал выполненных изменений.
| Что | Тип | Кого касается |
|---|---|---|
Исходящие вебхуки прежней версии (v1) заменяются вебхуками v2: конверт {id, type, api_version, created_at, livemode, data}, подпись Sapport-Signature, повторы, журнал доставок, ротация секрета. Событие передачи оператору handoff.requested заменено на conversation.handoff_requested | изменено | Тот, кто принимает вебхуки прежней версии. Из нагрузки прежней версии убирается текст сообщения клиента (content) |
Кошелёк и остановка обмена: GET /wallet, блок wallet в GET /me (state, exchange, topup_url), код 402 wallet_suspended на всех маршрутах при отрицательном балансе или блокировке кошелька, отложенная доставка вебхуков (подробнее) | добавлено | Все клиенты серверного API |
Единый формат ошибок application/problem+json с errors[] по JSON Pointer | добавлено | Все клиенты серверного API |
Курсорная пагинация, Idempotency-Key, заголовки RateLimit-*, асинхронные операции (operation) | добавлено | Все клиенты серверного API |
| Тестовые ключи и песочница | добавлено | Все, кто хочет проверять интеграцию без боевых данных |
#Как следить за изменениями
- Подписывайтесь на уведомления кабинета: владельцу арендатора приходят сообщения о выпуске, ротации и скором истечении ключей; событие
api_key.expiringприходит за 30 и за 7 суток до срока. - Читайте заголовки
DeprecationиSunsetв ответах API: автоматизируйте их журналирование на своей стороне. - Периодически проверяйте этот журнал.