Developers API & Widget
API Reference
RU

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

Введение

В этом руководстве объясняется, как интегрировать Wealth Reader: пользователь выбирает свой банк, проходит аутентификацию, и ваша система получает нормализованные данные.

Пример итогового результата: https://widget.wealthreader.com/demo-all/

Перед началом

Вам потребуется:

  • Завершённая регистрация и api_key.
  • Сессия онбординга с технической командой. Запишитесь на неё в разделе Поддержка.
  • Решение о типе интеграции (ниже).
  • URL HTTPS, который принимает callback, если вы интегрируете через iframe.

Выберите тип интеграции

Критерий Iframe (виджет) OAuth
Когда Веб-приложение, в которое можно встроить iframe Нативное приложение или нельзя встроить iframe
Frontend Вы вставляете виджет на свою страницу Вы перенаправляете пользователя на oauth.wealthreader.com
Данные Приходят как POST на ваш URL callback Вы получаете их, завершив challenge по адресу /token/
Начните с Iframe: frontend OAuth: backend

Большинство веб-клиентов используют iframe.

Как это работает (iframe)

  1. Ваша страница загружает виджет с operation_id, который вы генерируете.
  2. Пользователь выбирает учреждение, даёт согласие и при необходимости проходит двухфакторную аутентификацию. Эти шаги обрабатывает виджет.
  3. Wealth Reader получает данные и делает две вещи в таком порядке:
    • На backend отправляет полный JSON на настроенный вами URL callback. В этом ответе передаётся operation_id, чтобы вы могли сопоставить его с операцией на frontend.
    • На frontend iframe уведомляет вашу страницу через postMessage (flow completed) только если callback завершился успешно. Используйте это, чтобы закрыть селектор или показать экран успеха.

operation_id — это мост между frontend и backend. Без него вы не сможете сопоставить то, что произошло в браузере, с данными, которые приходят на ваш сервер.

Сообщение flow completed не содержит банковских данных. Данные уходят на callback. Если callback не отвечает HTTP 200 с {"status":"ok"}, frontend не получает flow completed.

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