REST · OPENAPI 3.1 · SOURCE FIRST

REST API и канонический контракт

OpenAPI-файл является machine-readable источником endpoint, schema, security requirement, response и header semantics. Reference добавляет guarded Try in Sandbox, не копируя каталог operations вручную.

Граница выполнения: CONFIGURED SANDBOX ORIGIN · NO EXTERNAL EXECUTION CLAIM
OpenAPI и HTTP handlers: РЕАЛИЗОВАНО

Контракты и исходные файлы

OpenAPI, схемы и примеры для скачивания.

OpenAPI 3.1Канонический REST-контракт CertaRail Postman Collection 2.1Canonical API catalog и runnable guided sandbox lifecycle Postman Local environmentSecret-safe LOCAL variables for a caller-supplied short-lived credential Bruno OpenCollection 1.0Bundled YAML с тем же canonical catalog и guided lifecycle HTTP Client collectionCanonical-generated requests for editor HTTP clients Collections runbookImport, credential, execution и cleanup boundary для generated artifacts AsyncAPI 3.1Канонический Kafka event-контракт CertaRail Capability Status v1Публичная проекция canonical capability registry

Полный OpenAPI reference

Операции, параметры, schemas, security requirements, examples и behavioural notes ниже строятся автоматически из canonical OpenAPI и связанных с ним AsyncAPI channels. Встроенный request builder и response inspector работают только через ограниченный same-origin relay.

TRY IN SANDBOX · GUARDED RELAY

Подключить short-lived credential

Credential передаётся только в Authorization header к same-origin relay, не попадает в Scalar, URL, analytics или application logs и удаляется при отключении, закрытии вкладки либо через 15 минут. Серверный срок действия остаётся authoritative и может быть короче.

ОТКЛЮЧЕНОCredential не подключён. Публичные operations можно отправлять без него.

Выберите operation ниже: встроенный builder отправит запрос, а inspector покажет status, headers, body и X-Request-ID. Заголовок каждой operation содержит copy-link; deep link хранится в hash и не включает credential.

Скачать raw OpenAPI YAML

LAZY-LOADED API EXPLORER

Интерактивный API reference

Тяжёлый explorer загружается при приближении к этому разделу или по явному действию. Canonical YAML доступен выше без загрузки explorer.

Один источник контракта

Dev и production build перед запуском публикуют canonical YAML из api/openapi/certarail.v1.yaml и создают из него reference-only JSON, Try allowlist, synthetic examples и operation notes. Related events сопоставляются через metadata canonical AsyncAPI, без ручного каталога REST operations.

Производная проекция содержит SHA-256 исходного YAML. Отдельно скачиваемый raw YAML отдаётся как application/yaml и остаётся пригодным для генерации client types и независимых contract checks. Для каждой operation генерируются cURL, JavaScript Fetch, Python stdlib и Go stdlib samples.

Generated Postman и Bruno collections

Postman Collection 2.1, secret-safe Local environment, bundled Bruno OpenCollection YAML и HTTP Client catalog генерируются тем же build step из canonical OpenAPI. Оба основных клиента содержат полный каталог operations и одинаковый numbered workflow: credential probe, decision, exact replay, changed-payload conflict, evidence, webhook test/verification и cleanup.

Credential не выдаётся коллекцией: пользователь помещает short-lived bearer в локальное secret storage и отдельно задаёт его ISO-8601 expiry. Pre-request checks fail closed при пустом, некорректном или истёкшем значении. One-time checkout token и webhook signing secret не сохраняются и не логируются.

Cleanup имеет ограниченную область

Финальные requests отзывают только созданные текущим run mutable Webhook Inbox и checkout fixture. Immutable decision и evidence records намеренно не удаляются.

Try исполняет только разрешённый sandbox HTTP request

Credential и execution boundary

Short-lived bearer проверяется read-only operation, хранится только в памяти вкладки и удаляется не позднее 15 минут. Relay принимает лишь method/path/query/header/content-type из generated OpenAPI allowlist, не следует redirects и не делает retries. Успешный HTTP response доказывает только ответ настроенного sandbox runtime; он не доказывает provider call, движение денег или активов, Production readiness либо Official receipt.

Нашли неточность?

Участники private repository могут предложить правку через reviewed pull request. Остальные пользователи — отправить техническое сообщение без credentials и чувствительных данных.

Предложить правку Сообщить об ошибке