ДокументацияОткрыть Kanyman
Разделы документации

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

API и безопасные ошибки

Основные endpoints внешнего приложения и поведение при отказах контекста.

Обновлено: 10 августа 2026

Публичный Web Chat API

httpKanyman docs
POST /api/public/web-chat/{public_key}/sessions
Idempotency-Key: <unique-session-creation-key>
Content-Type: application/json

{
  "locale": "ru",
  "context_token": "<optional-signed-jwt>"
}
httpKanyman docs
PUT /api/public/web-chat/{public_key}/sessions/{session_id}/context
Authorization: Bearer <session_token>
Content-Type: application/json

{ "context_token": "<signed-jwt>" }

Результат обработки контекста

jsonKanyman docs
{
  "context_status": "rejected",
  "context_id": null,
  "context_error_code": "context_expired"
}

Ошибка контекста не отменяет chat-сессию. Интерфейс должен продолжить обычный чат и показать нейтральное сообщение о временно недоступной технической информации.

API кабинета

textKanyman docs
GET  /api/projects/{project_id}/external-integrations
POST /api/projects/{project_id}/external-integrations
GET  /api/projects/{project_id}/external-integrations/{integration_id}
POST /api/projects/{project_id}/external-integrations/{integration_id}/test-token
GET  /api/projects/{project_id}/external-integrations/{integration_id}/tools
POST /api/projects/{project_id}/external-integrations/{integration_id}/tools
POST /api/projects/{project_id}/external-integrations/{integration_id}/tools/{tool_id}/test
POST /api/projects/{project_id}/external-integrations/{integration_id}/tools/{tool_id}/hmac-credentials
GET  /api/projects/{project_id}/external-integrations/{integration_id}/connector-catalog
GET  /api/projects/{project_id}/external-integrations/{integration_id}/connectors/{connector_id}/versions/{version}/manifest
POST /api/projects/{project_id}/external-integrations/{integration_id}/connectors/{connector_id}/versions/{version}/provision-plan
POST /api/projects/{project_id}/external-integrations/{integration_id}/connectors/{connector_id}/versions/{version}/provision
GET  /api/projects/{project_id}/external-integrations/{integration_id}/actions
POST /api/projects/{project_id}/external-integrations/{integration_id}/actions
GET  /api/projects/{project_id}/external-integrations/{integration_id}/actions/{action_id}
POST /api/projects/{project_id}/external-integrations/{integration_id}/actions/{action_id}/confirm
POST /api/projects/{project_id}/external-integrations/{integration_id}/actions/{action_id}/cancel
POST /api/projects/{project_id}/external-integrations/{integration_id}/actions/{action_id}/reconcile

GET  /api/projects/{project_id}/solution-packs/catalog
GET  /api/projects/{project_id}/solution-packs
POST /api/projects/{project_id}/solution-packs/install
POST /api/projects/{project_id}/solution-packs/{installation_id}/refresh
POST /api/projects/{project_id}/solution-packs/{installation_id}/activate
POST /api/projects/{project_id}/solution-packs/{installation_id}/disable
POST /api/projects/{project_id}/solution-packs/{installation_id}/rollback
GET  /api/projects/{project_id}/solution-packs/{installation_id}/scenarios
POST /api/projects/{project_id}/solution-packs/{installation_id}/scenarios/{scenario_key}/preview
POST /api/projects/{project_id}/solution-packs/{installation_id}/scenarios/{scenario_key}/drafts
POST /api/projects/{project_id}/solution-packs/{installation_id}/scenarios/versions/{version_id}/submit
POST /api/projects/{project_id}/solution-packs/{installation_id}/scenarios/versions/{version_id}/activate
POST /api/projects/{project_id}/solution-packs/{installation_id}/scenarios/versions/{version_id}/archive

POST /api/public/web-chat/{public_key}/sessions/{session_id}/actions/{action_id}/confirm
POST /api/public/web-chat/{public_key}/sessions/{session_id}/actions/{action_id}/cancel

Создание и тестирование конфигурации требуют роли owner или admin в выбранном проекте. Все операции проверяют workspace/project scope.

Логи и ошибки

Продолжить

API и безопасные ошибки — Kanyman Docs