PayBridge B2B¶
PayBridge B2B — шлюз, который подключает банк к Национальной платёжной сети (НПС) для мгновенных платежей между юридическими лицами: оплаты по QR-коду и платёжной ссылке, входящих зачислений и возвратов.
Демонстрационный проект
Продукт, компания и платёжная сеть вымышлены. Это портфолио технического писателя: структура, стиль и инструменты повторяют реальную рабочую документацию, но всё содержание написано заново.
С чего начать¶
-
Администраторам
Архитектура, состав решения, установка и настройка компонентов.
-
Разработчикам и интеграторам
Сценарии платежей, Merchant API, коды ошибок.
-
Сотрудникам ТСП
Вход в кабинет, выставление счетов по ссылке, поиск платежей и возвраты.
Как устроена документация¶
Документация ведётся по принципу docs-as-code и устроена как monorepo: у разделов «Администрирование», «Интеграция» и «Кабинет ТСП» свои подпроекты MkDocs, которые можно собирать и просматривать отдельно, а общий сайт объединяет их плагином monorepo.
- Исходники хранятся в Git в формате Markdown, диаграммы PlantUML лежат рядом с текстом, справочник API собирается из спецификации OpenAPI.
- Сайт собирается автоматически при каждом изменении основной ветки и публикуется на GitHub Pages.
- Для размещения в инфраструктуре компании есть Docker-образ с nginx.