Платформа для разработчиков
REST API, вебхуки и интеграция с Телеграм: подключайте AnyNote к своим сервисам и автоматизируйте работу пространства.
Платформа AnyNote для разработчиков — это три поверхности интеграции:
- REST API — программный доступ к страницам, файлам и поиску
по рабочим пространствам (
/v1/*, аутентификация по API-ключам). - Вебхуки — исходящие HTTP-уведомления о событиях пространства (страницы, комментарии) с HMAC-подписью и журналом доставок.
- Телеграм — подключение собственного бота: уведомления
командных разделов в чаты и команды
/search,/getдля участников.
Версионирование и политика поддержки описаны на странице «Изменения API».
Быстрый старт
1. Создайте API-ключ
Откройте Настройки → API-ключи (/settings/api) и создайте ключ. Ключ имеет вид
ank_ + 24 символа base62 и показывается полностью только один раз — при
создании. В списке ключей остаются только первые 8 и последние 4 символа. Срок
действия выбирается при создании: 7d, 30d, 90d, 1y или never.
2. Определите базовый адрес
API обслуживает сервер AnyNote Engines — отдельный от веб-приложения хост:
| Установка | Базовый адрес |
|---|---|
| Облако anynote.ru | https://api.anynote.ru |
| Self-hosted | адрес сервера AnyNote Engines вашей установки (по умолчанию порт 8082) |
Все пути в документации указаны относительно базового адреса: /healthz,
/v1/meta, /v1/search/pages и т. д.
3. Выполните первый запрос
Семантический поиск по страницам пространства:
curl -X POST https://api.anynote.ru/v1/search/pages \
-H "Authorization: Bearer ank_ВАШ_КЛЮЧ" \
-H "Content-Type: application/json" \
-d '{"workspaceId": "00000000-0000-0000-0000-000000000000", "query": "план релиза", "k": 5}'
Проверить доступность сервера можно без ключа: GET /healthz возвращает
{"status":"ok"}, а GET /v1/meta — версию и пути сервисов.
Разделы документации
| Страница | Содержание |
|---|---|
| REST API | Аутентификация, полный справочник эндпоинтов /v1/*, примеры запросов и обработка ошибок |
| Вебхуки | Каталог событий, формат конверта, проверка подписи, повторные доставки, безопасность |
| Телеграм | Подключение бота, подписки разделов на чаты, привязка аккаунта, команды |
| Изменения API | Версии, политика обратной совместимости и устаревания, журнал изменений |
Для self-hosted установок на сервере Engines также доступен интерактивный
Swagger UI по пути /docs.
Дорожная карта
Перечисленное ниже — в планах и сейчас недоступно. Мы анонсируем готовность на странице «Изменения API»:
- OAuth-авторизация для сторонних приложений (сейчас — только персональные API-ключи).
- Маркетплейс публичных приложений и процесс их ревью.
- API v2.
- Машиночитаемый экспорт OpenAPI-спецификации (сейчас — справочник в этой документации и self-hosted Swagger UI).
- Предпросмотр ссылок (link previews) и коннекторы внешних сервисов.