Developers API & Widget
API Reference
ZH

入门

集成流程

这是 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: 用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,加载 widget,并监听 postMessage
widget 向用户展示银行、登录、2FA 和错误。
Wealth Reader API 与金融机构通信并标准化响应。
后端 公开 callback URL,返回 {"status":"ok"},并保存 operation_idtoken 和 payload。

如果失败

  • 密码错误、2FA 或金融机构错误:由 widget 与用户处理。前端可能通过 postMessage 收到错误 JSON;在读取成功完成之前,不会调用 callback。
  • 您的 callback 未返回 200 + {"status":"ok"}:用户看不到成功,前端也收不到 flow completed
  • token 失效(密码变更、新的 2FA):再次打开 widget 并传入该 token,以便用户重新认证。

各消息详情以及 callback 正文见 iframe 各页。

下一步

如果通过 iframe 集成,请继续阅读 frontend,然后是 backend。如果无法嵌入 iframe,请前往 OAuth

最后更新于