Developers API & Widget
API Reference
RU

Начало работы

Процесс интеграции

Успешный сценарий интеграции через iframe. Callback отправляется до уведомления frontend.

sequenceDiagram
participant U as Пользователь
participant W as Ваш сайт
participant WG as Wealth Reader Виджет
participant API as Wealth Reader API
participant B as Финансовое учреждение
U->>W: Откройте приложение
W->>WG: Вставьте iframe с operation_id
U->>WG: Выберите организацию и дайте согласие
WG->>API: Запросите данные с помощью operation_id
API->>B: Запросите данные счёта
B-->>API: Возвращает исходные данные
API-->>WG: Возвращает нормализованные данные
WG->>W: Отправьте POST в callback (operation_id + token + payload)
W-->>WG: Отвечайте HTTP 200 и status ok
WG-->>W: Отправьте postMessage flow completed
W-->>U: Показывает экран успеха

Кто за что отвечает

Участник Ответственность
Ваш frontend Генерирует уникальный operation_id, загружает виджет и слушает postMessage.
Виджет Показывает пользователю банки, вход, 2FA и ошибки.
API Wealth Reader Общается с учреждением и нормализует ответ.
Ваш backend Публикует URL callback, отвечает {"status":"ok"} и сохраняет operation_id, token и payload.

Если что-то идёт не так

  • Неверный пароль, 2FA или ошибка учреждения: виджет разбирается с этим вместе с пользователем. Ваш frontend может получить JSON ошибки через postMessage; callback не вызывается, пока чтение не завершится успешно.
  • Ваш callback не возвращает 200 + {"status":"ok"}: пользователь не видит успех, и frontend не получает flow completed.
  • token перестаёт работать (смена пароля, новый 2FA): снова откройте виджет, передав этот token, чтобы пользователь мог повторно пройти аутентификацию.

Подробности сообщений и тело callback — на страницах iframe.

Следующий шаг

Если вы интегрируете через iframe, продолжайте с frontend, затем с backend. Если встроить iframe нельзя, перейдите к OAuth.

Последнее обновление