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

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

Read-only HTTP-инструменты

Декларативные серверные методы для свежей диагностики без изменения данных клиента.

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

Конфигурация

jsonKanyman docs
{
  "name": "project.get_diagnostics",
  "capability_version": "1.0.0",
  "description": "Получить безопасную диагностику проекта",
  "method": "POST",
  "url": "https://api.example.com/kanyman/project-diagnostics",
  "input_schema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {}
  },
  "output_schema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {}
  },
  "side_effect": "none",
  "confirmation_policy": "none",
  "idempotency_policy": "none",
  "auth_type": "hmac",
  "auth_version": "v2",
  "hmac_key_id": "connector-current"
}

Инструмент создаётся как черновик. Admin выполняет безопасный probe с subject=kanyman_configuration_test, новым request_id и пустым entities. Успешный ответ по output schema или подписанный 404 OBJECT_NOT_FOUND с тем же request_id активирует транспорт без доступа к реальному объекту.

Запрос к вашему endpoint

jsonKanyman docs
{
  "request_id": "ktc_...",
  "integration_id": "ext_...",
  "subject": "opaque-user-reference",
  "entities": [{ "type": "project", "ref": "prj_..." }],
  "input": { "request_id": "req_..." }
}

Модель управляет только объектом input. integration_id, subject и entities Kanyman извлекает из проверенного контекста и добавляет сервером.

Авторизация и HMAC

Для HMAC v2 подпишите METHOD\nPATH\nTIMESTAMP\nNONCE\nBODY_SHA256 и проверьте X-Kanyman-Key-Id, X-Kanyman-Timestamp, X-Kanyman-Nonce, X-Kanyman-Body-SHA256 и X-Kanyman-Signature: <hex>. Тело ограничено 32 КиБ, nonce одноразовый, query string запрещён. HMAC v1 сохранён только для совместимости существующих подключений.

Сетевые ограничения

  • Только публичный HTTPS endpoint и метод POST.
  • Private, loopback, link-local и reserved адреса запрещены.
  • DNS проверяется до исходящего вызова, редиректы отключены.
  • Применяются timeout, лимит размера ответа и rate limit.
  • Вход и выход проходят закрытые JSON Schema.
  • Реквизиты, input и output хранятся зашифрованно; аудит не раскрывает секреты.
  • Ротация HMAC меняет current/previous key атомарно и требует повторного probe перед активацией.

Продолжить

Read-only HTTP-инструменты — Kanyman Docs