diff --git a/docs/index.md b/docs/index.md index f64d791..0923191 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,38 +9,34 @@ ## Что внутри -{% list tabs %} +### Я интегрирую свой сервис -- Я интегрирую свой сервис +Начни с [обзора API](integration/api/index.md) и [авторизации](integration/api/auth.md). - Начни с [обзора API](integration/api/index.md) и [авторизации](integration/api/auth.md). +Дальше: +- [Read-side endpoints](integration/api/read-endpoints.md) — как читать справочники +- [События (Kafka outbox)](integration/api/events.md) — топики `ordinis.cuod.events.*` +- [Webhooks](integration/api/webhooks.md) — push-уведомления вместо polling +- [Кэширование](integration/api/caching.md) — TTL / push / snapshot стратегии - Дальше: - - [Read-side endpoints](integration/api/read-endpoints.md) — как читать справочники - - [События (Kafka outbox)](integration/api/events.md) — топики `ordinis.cuod.events.*` - - [Webhooks](integration/api/webhooks.md) — push-уведомления вместо polling - - [Кэширование](integration/api/caching.md) — TTL / push / snapshot стратегии +### Я строю UI / клиент -- Я строю UI / клиент +- [Cross-references](integration/api/x-references.md) — FK между справочниками +- [Bitemporal](integration/api/bitemporal.md) — `validFrom` / `validTo` + история +- [Bundle cuod](integration/api/bundle-cuod.md) — список 40 справочников ЦУОД +- [Best practices](integration/api/best-practices.md) — частые ошибки - - [Cross-references](integration/api/x-references.md) — FK между справочниками - - [Bitemporal](integration/api/bitemporal.md) — `validFrom` / `validTo` + история - - [Bundle cuod](integration/api/bundle-cuod.md) — список 40 справочников ЦУОД - - [Best practices](integration/api/best-practices.md) — частые ошибки +### Я обрабатываю ошибки -- Я обрабатываю ошибки +- [Ошибки и rate limits](integration/api/errors.md) — error codes, retry strategy +- [Лучшие практики](integration/api/best-practices.md) — robust integration - - [Ошибки и rate limits](integration/api/errors.md) — error codes, retry strategy - - [Лучшие практики](integration/api/best-practices.md) — robust integration +### Я хочу пощупать API -- Я хочу пощупать API - - Открой [Swagger UI](https://ordinis.k8s.264.nstart.cloud/swagger-ui.html) — - там можно нажать **Authorize** → войти через Keycloak (PKCE, без secret) → - и сразу делать "Try it out" с реальным JWT. Authorization, error codes, - schemas — всё через interactive UI. - -{% endlist %} +Открой [Swagger UI](https://ordinis.k8s.264.nstart.cloud/swagger-ui.html) — +там можно нажать **Authorize** → войти через Keycloak (PKCE, без secret) → +и сразу делать "Try it out" с реальным JWT. Authorization, error codes, +schemas — всё через interactive UI. ## Среды