CertaRailКонсоль организации
Для разработчика

Справочник API

Методы, параметры и примеры запросов к CertaRail.

Разделы документации
API 0.32.1Быстрый стартСкачать OpenAPI · YAML
Подключить токен sandbox Не подключён

Токен хранится в памяти вкладки до отключения, закрытия страницы или истечения доступного срока, не более 15 минут. Это предел хранения, а не срок действия токена на сервере.

Создайте sandbox и скопируйте токен, который показывается один раз. Уже полученный токен можно вставить сюда.

Токен не подключён. Общедоступные методы работают без него.

Примеры содержат тестовые данные. Отправка выполняется в sandbox без внешних операций.

Загружаем справочник API…
Коллекции для Postman и Bruno
Postman Collection 2.1Canonical API catalog и runnable guided sandbox lifecyclePostman Local environmentSecret-safe LOCAL variables for a caller-supplied short-lived credentialBruno OpenCollection 1.0Bundled YAML с тем же canonical catalog и guided lifecycleHTTP Client collectionCanonical-generated requests for editor HTTP clientsCollections runbookImport, credential, execution и cleanup boundary для generated artifacts

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 намеренно не удаляются.
Устройство справочника и ограничения

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

Граница выполнения
CONFIGURED SANDBOX ORIGIN · NO EXTERNAL EXECUTION CLAIM
OpenAPI и HTTP handlers
РЕАЛИЗОВАНО
OpenAPI 3.1Канонический REST-контракт CertaRailAsyncAPI 3.1Канонический Kafka event-контракт CertaRailCapability Status v1Публичная проекция canonical capability registry

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

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.

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 и чувствительных данных.

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