RKDash API

История версий

Машиночитаемая версия — /api/changelog. Сейчас контракт: v1, дата-версия 2026-09-15.

Правила совместимости

  • Мажор (v2) — только ломающие изменения: удаление полей, смена типов, другой смысл значений.
  • Минор — новые поля, фильтры и маршруты; старый клиент их просто не замечает.
  • Патч — исправления без изменения формы ответа.
  • Дата-версия в заголовке X-Api-Version включает изменения внутри мажора. Перед отключением версии клиент получает заголовки Deprecation и Sunset (RFC 8594).

v1.3.0

2026-09-17События платформы наружу: получатель-агент, реплей, живой поток
ДобавленоПодписка может вести к агенту: targetKind, agentProfile, deliveryMode

deliveryMode `wake` запускает профиль Hermes с текстом события, `card` ставит задачу на доску тому же профилю. Профиль проверяется по реестру исполнителей.

ДобавленоШторм-контроль и защита от петель

Не более 6 пробуждений агента в минуту на подписку; однотипные события по одному объекту за 5 минут сворачиваются в одну доставку; событие, порождённое действием самого агента, ему не возвращается.

ДобавленоРеплей: POST /webhooks/{id}/deliveries/{deliveryId}/replay

Запись журнала возвращается в очередь и доставляется сразу, без новой записи.

ДобавленоЖивой поток: GET /events/stream (SSE)

Событие появляется в панели и сессии агента без перезагрузки; тот же момент, что и доставка подписчикам.

v1.2.0

2026-09-17Доска задач и исполнители в публичном API
ДобавленоРесурс «Доска»: GET/POST /cards, GET/PATCH/DELETE /cards/{id}

Карточки живут в том же kanban.db, что и панель: задача, заведённая агентом, сразу видна на доске и подхватывается диспетчером цифровых сотрудников. Движение карточки — смена status (in_progress — «взял в работу», done — закрыта), удаление — архивация.

ДобавленоРесурс «Агенты»: GET /agents

Исполнители, на которых можно назначить задачу: цифровые сотрудники (employee) и профили разработки платформы (developer). Значение id подставляется в assigneeId карточки.

ДобавленоMCP: инструменты get_cards, get_card, create_card, update_card, delete_card, get_agents

Агент ведёт работу по доске теми же правами read:kanban / write:kanban, что и человек: 24 инструмента собираются из реестра маршрутов.

ДобавленоЛента карточки: GET/POST /cards/{id}/comments

Комментарии людей и итоговые отчёты агентов в одном порядке. Автор по умолчанию — исполнитель карточки: отчёт агента виден в ленте задачи, а не теряется в чате сессии.

ДобавленоСобытия доски: card.created, card.moved, card.done, card.commented

Уходят подписчикам вебхуков с подписью X-Rkdash-Signature и журналом доставки, как события меню и склада.

ДобавленоОбласти доступа read:kanban, write:kanban, read:agents

Выдаются ключу в «Настройки → API» вместе с остальными правами.

v1.1.0

2026-09-17MCP-сервер и слой адаптеров агента
ДобавленоMCP-сервер: POST /api/mcp (Streamable HTTP, JSON-RPC 2.0)

18 инструментов собираются из реестра эндпоинтов, поэтому не расходятся с REST. Авторизация — тот же ключ rk_live_/rk_test_, права проверяются на каждом вызове. По умолчанию сервер выключен: включение — «Настройки → API».

ДобавленоСлой адаптеров агента: hermes_local и hermes_gateway

Единый контракт запуска прогона (AdapterExecutionContext → AdapterExecutionResult) с событиями прогона, сессиями и проверкой окружения. Реестр изменяемый: внешний транспорт подключается регистрацией, без правки типов.

ДобавленоНовые области доступа: доска, агенты, операции, журнал

read:kanban, write:kanban, write:dashboards, read:agents, write:agents, run:ops, read:audit, adapter:control.

ИзмененоИнструменты изменения данных включаются отдельным флагом

По умолчанию агент получает только чтение; цены, склад и интеграции открываются осознанно и требуют Idempotency-Key.

v1.0.0

2026-09-16Первая публичная версия API
ДобавленоРесурсы: заведения, меню, чеки, персонал, склад, дашборды, интеграции, AI

22 операции под префиксом /api/v1 с пагинацией курсором, фильтрами и сортировкой.

ДобавленоКлючи доступа rk_live_ / rk_test_ с областями прав

Ключ хранится хэшем, показывается один раз, отзывается и вращается в «Настройки → API».

ДобавленоЛимит запросов и заголовки X-RateLimit-*

100 запросов в минуту на ключ, всплеск до 20 в секунду, 429 с Retry-After.

ДобавленоИдемпотентность POST через Idempotency-Key

Повтор с тем же телом возвращает прежний ответ, с другим — 409.

ДобавленоВебхуки: dish.updated, check.created, stock.low

Подпись X-Rkdash-Signature, три попытки доставки, журнал в панели и через API.

ДобавленоOpenAPI 3.1, документация и SDK

Спецификация собирается из Zod-схем: /api/v1/openapi, страница /docs/api, пакеты @rkdash/api и rkdash (Python).

ДобавленоОшибки в формате RFC 7807

application/problem+json с полями type, title, status, detail, instance, code, requestId.