Developers API & Widget
API Reference
ZH

入门

集成流程

这是 iframe 集成的正常流程。callback 在通知前端之前发送。

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: 使用operation_id插入iframe
U->>WG: 选择金融机构并授权同意
WG->>API: 使用operation_id请求数据
API->>B: 请求账户数据
B-->>API: 返回原始数据
API-->>WG: 返回标准化数据
WG->>W: 向callback发送POST(operation_id + token + payload)
W-->>WG: 返回HTTP 200和status ok
WG-->>W: 发送postMessage flow completed
W-->>U: 显示成功页面

职责分工

参与方 职责
您的前端 生成唯一的 operation_id,加载组件并监听 postMessage。
组件 向用户显示银行、登录、2FA 和错误。
Wealth Reader API 与金融机构通信并标准化响应。
您的后端 提供 callback URL,返回 {"status":"ok"},并保存 operation_id、token 和 payload。

出错时

  • 密码错误、2FA 或金融机构错误由组件与用户共同处理。前端可能通过 postMessage 收到错误 JSON;数据读取成功前不会调用 callback。
  • 如果 callback 未返回 200 + {"status":"ok"},用户不会看到成功提示,前端也不会收到 flow completed。
  • 如果 token 失效(密码更改或新增 2FA),请传入该 token 并重新打开组件,让用户重新认证。

各消息和 callback 请求体的详细说明见 iframe 页面。

下一步

如使用 iframe,请先阅读前端,再阅读后端。如果无法嵌入 iframe,请参阅 OAuth。

最后更新于