MTB ESB Documentation

Справочник

Каталоги, матрицы, шаблоны и source-of-truth артефакты платформы.

Reference

Справочные артефакты отвечают на вопрос «где находится актуальное значение». Портал объясняет назначение и формат, а изменяемые operational values должны поступать из соответствующего source of truth.

Обязательные каталоги

КаталогМинимальное содержаниеOwner
API CatalogAPI, version, owner, status, Consumers, deprecationAPI Management
API Product CatalogProduct, included operations, subscription modelAPI Owner
Topic CatalogTopic, schema, producer, consumers, key, retentionKafka/Router owner
Adapter CatalogTarget system, endpoints, owner, supported operationsAdapter team
Flow CatalogKestra flow, version, triggers, dependencies, ownerOrchestration owner
Environment MatrixDNS, ingress, namespace, dependencies, readinessPlatform team
Service RegistryService, support owner, dashboard, alerts, runbooksOperations
Decision LogADR, status, context, decision, consequencesArchitecture

Матрица окружений

Для каждого environment фиксируются ссылки на:

  • consumer-facing endpoints;
  • administrative endpoints;
  • Kubernetes cluster/namespace;
  • Kafka cluster и topic namespace;
  • database instances/schemas;
  • dashboards и logs;
  • pipeline и registry;
  • secrets/certificate ownership;
  • readiness status.

D8 Transaction Services snapshot

Confluence export от 19 августа 2026 добавляет и обновляет шесть transaction routes. Таблица ниже служит навигационным snapshot; полные request/response schemas должны публиковаться из versioned OpenAPI, а не копироваться вручную из Confluence. Общий runtime flow описан на странице D8 Transaction Services.

Router ruleOperationInput topicSync reply topicDLT topic
38getCardTransactionHistorytransactions.in.d8.command.get-card-transaction-historytransactions.out.d8.reply.get-card-transaction-historytransactions.dlt.d8.command.get-card-transaction-history
39getTransactionDetailstransactions.in.d8.command.get-transaction-detailstransactions.out.d8.reply.get-transaction-detailstransactions.dlt.d8.command.get-transaction-details
40authorizeTransactiontransactions.in.d8.command.authorize-transactiontransactions.out.d8.reply.authorize-transactiontransactions.dlt.d8.command.authorize-transaction
41reverseTransactiontransactions.in.d8.command.reverse-transactiontransactions.out.d8.reply.reverse-transactiontransactions.dlt.d8.command.reverse-transaction
42getTransactionStatustransactions.in.d8.command.get-transaction-statustransactions.out.d8.reply.get-transaction-statustransactions.dlt.d8.command.get-transaction-status
43calculateAcqCommissiontransactions.in.d8.command.calculate-acq-commissiontransactions.out.d8.reply.calculate-acq-commissiontransactions.dlt.d8.command.calculate-acq-commission

Для async-варианта всех шести операций используется callback.out. Adapter проверяет idempotencyKey, сохраняет результат для безопасного повтора и направляет неуспешно обработанные сообщения в соответствующий DLT. Точные retry parameters и error mapping должны подтверждаться реализацией и тестами перед публикацией SLA.

Credentials не являются документацией API

Учётные данные, секреты и полные токены из Confluence exports не переносятся в портал или OpenAPI. Храните только secret reference и процедуру получения доступа.

Не храните secrets в справочнике

Каталог содержит ссылку на secret reference и owner, но не значение secret. То же относится к private keys, passwords и полным access tokens.

Шаблоны

  • New Consumer Onboarding Request;
  • Access Modification Request;
  • New API Request;
  • API Design Review;
  • Topic Registration;
  • Adapter Onboarding;
  • Architecture Decision Record;
  • Release Checklist;
  • Incident Record;
  • Sandbox Audit;
  • Runbook;
  • Restore Test Record.

Статусы документов

СтатусЗначение
DraftВ разработке, не является нормативным
ReviewПередан на согласование
ApprovedДействующее правило/source of truth
DeprecatedИмеет замену, действует переходный период
ArchivedНе применяется

Управление актуальностью

Каждый документ имеет owner, status, version и review date. При изменении API, flow, topology или policy соответствующая документация обновляется в рамках той же поставки.

Где искать информацию

  • назначение платформы — Introduction;
  • подключение Consumer — Consumer Onboarding;
  • создание API — API Publishing;
  • нормативные правила — Architecture & Standards;
  • диагностика и восстановление — Operations & Reference.

Если информация расходится, приоритет имеет утверждённый source of truth с более новым version/review date; конфликт должен быть зарегистрирован и устранён владельцем.

On this page