Developers API & Widget
API Reference
ZH

入门

简介

本指南说明如何集成 Wealth Reader:用户选择银行并完成认证后,您的系统会收到标准化数据。

最终效果示例:https://widget.wealthreader.com/demo-all/

开始之前

您需要:

  • 已完成注册并持有 api_key
  • 与技术团队进行一次接入培训。请从支持预约。
  • 决定集成方式(见下文)。
  • 如果通过 iframe 集成,需要一个接收 callback 的 HTTPS URL。

选择集成方式

标准 Iframe(widget) OAuth
适用场景 可以嵌入 iframe 的 Web 应用 原生应用,或无法嵌入 iframe
Frontend 在页面中插入 widget 将用户重定向到 oauth.wealthreader.com
数据 POST 发送到您的 callback URL /token/ 完成挑战后获取
从此开始 Iframe:frontend OAuth:backend

大多数 Web 客户使用 iframe。

工作原理(iframe)

  1. 您的页面使用自行生成的 operation_id 加载 widget。
  2. 用户选择金融机构、给予同意,并在需要时完成双因素认证。这些步骤由 widget 处理。
  3. Wealth Reader 获取数据,并按此顺序做两件事:
    • backend,将完整 JSON 发送到您配置的 callback URL。该响应中带有 operation_id,便于与 frontend 操作对应。
    • frontend,仅当 callback 成功时,iframe 才会通过 postMessageflow completed)通知您的页面。用它来关闭选择器或显示成功页面。

operation_id 是 frontend 与 backend 之间的桥梁。没有它,就无法将浏览器中发生的操作与到达服务器的数据对应起来。

flow completed 消息不包含银行数据。数据会发送到 callback。如果 callback 未以 HTTP 200{"status":"ok"} 响应,frontend 不会收到 flow completed

最后更新于