Zimin A.N.
1d5ee4291e
`{% list tabs %}` требует @diplodoc/tabs-extension package + plugin config,
не входит в base @diplodoc/cli build output. Без него HTML refs
/_assets/tabs-extension.{css,js} → 404 в browser console.
Convert на plain ### headers — same content, no missing assets, проще
для переводов и navigation.
3.2 KiB
Ordinis НСИ ЦУОД ОДХ — Integrator Guide
Документация для команд, интегрирующих свои сервисы с Ordinis НСИ ЦУОД. Сюда не входят operator runbooks и архитектурные deep-dives — те материалы во внутренней документации проекта.
Anchor v1 — production LIVE на cluster.142 (с 2026-05-07). Альтум consumers подключены, blue/green cutover завершён.
Что внутри
Я интегрирую свой сервис
Начни с обзора API и авторизации.
Дальше:
- Read-side endpoints — как читать справочники
- События (Kafka outbox) — топики
ordinis.cuod.events.* - Webhooks — push-уведомления вместо polling
- Кэширование — TTL / push / snapshot стратегии
Я строю UI / клиент
- Cross-references — FK между справочниками
- Bitemporal —
validFrom/validTo+ история - Bundle cuod — список 40 справочников ЦУОД
- Best practices — частые ошибки
Я обрабатываю ошибки
- Ошибки и rate limits — error codes, retry strategy
- Лучшие практики — robust integration
Я хочу пощупать API
Открой Swagger UI — там можно нажать Authorize → войти через Keycloak (PKCE, без secret) → и сразу делать "Try it out" с реальным JWT. Authorization, error codes, schemas — всё через interactive UI.
Среды
| Среда | URL | Auth | Назначение |
|---|---|---|---|
| prod | https://ordinis.k8s.264.nstart.cloud/ |
JWT обязателен | Real users |
| staging | https://ordinis.k8s.265.nstart.cloud/ |
optional (legacy mode) | Dev environment |
| local | http://localhost:8080 |
off | docker-compose dev |
Поддержка
- Запросы новых ролей / scope в Keycloak:
zimin.an@nstart.space - Bug reports / feature requests: через issue tracker (запросить URL у Ordinis team)
Версионирование
API стабилизирован под v1 — breaking changes только через major bump (v2). См.
Best practices для рекомендаций по
обработке появления новых полей в v1 (forward compatibility).
Bundle справочников ЦУОД versioned отдельно (cuod-bundle:1.2.1). Изменение
schemas — minor bump, добавление словарей — minor bump, удаление — major bump
(никогда без уведомления consumers через record.closed events).