Справочник REST API КриптоАРМ CA

Справочник REST API#

Базовая версия API — v1; доступны /api/v1/* и /api/*. Спецификация — OpenAPI 3.x.

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

Поддерживаются X-API-KEY, Authorization: Bearer <token> и cookie-сессия после OIDC-входа.

Конвенции#

Мутирующие POST/PUT/PATCH принимают Idempotency-Key. Повтор с тем же ключом и телом возвращает исходный ответ и может содержать Idempotency-Replayed: true.

Списки используют range, sort, filter; ответы содержат X-Total-Count и Content-Range. При превышении лимита — 429 и Retry-After, RateLimit-*.

Ошибки имеют форму {"error":{"code","message","field?","hint?","details?"}}; ответы содержат X-Request-Id.

Discovery#

GET /api/health — liveness;
GET /api/ready — readiness и проверка БД;
GET /api/version — версия;
GET /openapi.json и GET /.well-known/openapi.json — OpenAPI;
GET /llms.txt — карта ресурсов;
/api — интерактивная документация / Try it out.

Аутентификация#

GET /api/auth, POST /api/login, GET /api/login, POST|GET /api/logout, GET /api/profile, GET /api/auth/jwt, GET /api/auth/callback.

Пользователи#

GET/POST /api/users, GET/PUT/DELETE /api/users/{id}.

Сертификаты#

Метод	Назначение
`GET /api/certificates`	список
`POST /api/certificates`	выпуск
`POST /api/certificates/issue`	выпуск, алиас
`GET /api/certificates/{id}`	просмотр
`GET /api/certificates/{id}/download`	скачивание
`PUT /api/certificates/{id}`	отзыв
`PUT /api/certificates/{id}/pin`	смена PIN PFX
`GET /api/events`	аудит

Десктопный адаптер#

POST /api/operations/start, POST /api/operations/params, POST /api/operations/upload, GET /api/operations/result.

Связь GUI и API#

Список → GET /api/certificates; выпуск → POST /api/certificates; просмотр → GET /api/certificates/{id}; скачивание → /download; отзыв → PUT /api/certificates/{id}; PIN → /pin; аудит → GET /api/events.