Разработчикам

Изменения API

Версионирование, политика устаревания и журнал изменений REST API, вебхуков и интеграции с Телеграм.

Журнал изменений платформы для разработчиков: REST API, вебхуки и интеграция с Телеграм. Здесь же публикуются анонсы устаревания — следите за этой страницей, если ваша интеграция работает в продакшене.

Версионирование

REST API v1 — текущая стабильная версия. Все эндпоинты живут под префиксом пути /v1/ (/v1/pages/create, /v1/search/pages, …).
Конверт вебхука версионируется отдельно: номер версии передаётся в поле version конверта и в заголовке X-AnyNote-Payload-Version каждой доставки. Текущая версия — 1. Если формат конверта когда-либо изменится несовместимо, новая версия получит новый номер, а существующие подписки продолжат получать ту версию, на которой созданы.

Политика устаревания

Несовместимые изменения выпускаются только в составе новой версии (API v2, конверт версии 2 и т. д.) — существующие версии при этом продолжают работать.
Прекращение поддержки версии или эндпоинта анонсируется на этой странице не менее чем за 90 дней.
Аддитивные изменения не считаются несовместимыми и могут появляться без смены версии: новые эндпоинты, новые необязательные поля в ответах и конвертах, новые типы событий. Пишите клиенты устойчиво: игнорируйте незнакомые поля и незнакомые типы событий.

Журнал

Июнь 2026 — интеграция с Телеграм

Подключение собственного бота к пространству: уведомления командных разделов в чаты Телеграм с фильтром событий.
Команды /help, /link, /search, /get с лестницей прав и журналом аудита.
Подробности — на странице «Телеграм».

Июнь 2026 — исходящие вебхуки

Подписки на события страниц и комментариев с доставкой на HTTPS-адрес: подпись HMAC-SHA256, проверка адреса, повторные доставки, журнал.
Конверт версии 1, каталог из 8 типов событий; collection.created, collection.updated и database.row_changed объявлены и появятся позже.
Подробности — на странице «Вебхуки».

REST API v1 — базовая версия

Аутентификация по персональным API-ключам (ank_…) с настраиваемым сроком действия.
Эндпоинты пространств, страниц, файлов и поиска под /v1/*; Swagger UI по пути /docs на сервере Engines.
Подробности — на странице «REST API».

Версионирование

REST API v1 — текущая стабильная версия. Все эндпоинты живут под префиксом пути /v1/ (/v1/pages/create, /v1/search/pages, …).

Конверт вебхука версионируется отдельно: номер версии передаётся в поле version конверта и в заголовке X-AnyNote-Payload-Version каждой доставки. Текущая версия — 1. Если формат конверта когда-либо изменится несовместимо, новая версия получит новый номер, а существующие подписки продолжат получать ту версию, на которой созданы.

Политика устаревания

Несовместимые изменения выпускаются только в составе новой версии (API v2, конверт версии 2 и т. д.) — существующие версии при этом продолжают работать.

Прекращение поддержки версии или эндпоинта анонсируется на этой странице не менее чем за 90 дней.

Аддитивные изменения не считаются несовместимыми и могут появляться без смены версии: новые эндпоинты, новые необязательные поля в ответах и конвертах, новые типы событий. Пишите клиенты устойчиво: игнорируйте незнакомые поля и незнакомые типы событий.

Журнал

Июнь 2026 — интеграция с Телеграм

Подключение собственного бота к пространству: уведомления командных разделов в чаты Телеграм с фильтром событий.

Команды /help, /link, /search, /get с лестницей прав и журналом аудита.

Подробности — на странице «Телеграм».

Июнь 2026 — исходящие вебхуки

Подписки на события страниц и комментариев с доставкой на HTTPS-адрес: подпись HMAC-SHA256, проверка адреса, повторные доставки, журнал.

Конверт версии 1, каталог из 8 типов событий; collection.created, collection.updated и database.row_changed объявлены и появятся позже.

Подробности — на странице «Вебхуки».

REST API v1 — базовая версия

Аутентификация по персональным API-ключам (ank_…) с настраиваемым сроком действия.

Эндпоинты пространств, страниц, файлов и поиска под /v1/*; Swagger UI по пути /docs на сервере Engines.

Подробности — на странице «REST API».