Developers API & Widget
API Reference
ZH

入门

简介

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

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

开始之前

您需要:

  • 完成注册并取得 api_key。
  • 与技术团队进行一次入门指导。通过支持预约。
  • 选择集成方式(见下文)。
  • 如果采用 iframe 集成,准备接收 callback 的 HTTPS URL。

选择集成方式

比较项 iframe(组件) OAuth
适用场景 可以嵌入 iframe 的 Web 应用 原生应用,或无法嵌入 iframe
前端 在页面中嵌入组件 将用户重定向到 oauth.wealthreader.com
数据 通过 POST 发送到 callback URL 在 /token/ 完成挑战后获取
从这里开始 iframe:前端 OAuth:后端

大多数 Web 客户使用 iframe。

使用 AI 编程助手?在 Claude Code、Codex、Cursor、Copilot 或 Gemini CLI 中安装 Wealth Reader skill,让它按照本指南生成集成。

工作原理(iframe)

  1. 页面使用您生成的 operation_id 加载组件。
  2. 用户选择金融机构、授权同意,并在需要时完成双因素认证。这些步骤由组件管理。
  3. Wealth Reader 获取数据后,按以下顺序执行两项操作:
    • 向后端配置的 callback URL 发送完整 JSON。响应携带 operation_id,以便关联前端操作。
    • 在前端,iframe 通过 postMessage(flow completed)通知页面,但仅在 callback 正常响应时发送。用此通知关闭选择器或显示成功页面。

operation_id 是前后端之间的桥梁。没有它,就无法将浏览器中的操作与服务器收到的数据关联起来。

flow completed 消息不包含银行数据。数据发送给 callback。如果 callback 未返回 HTTP 200 和 {"status":"ok"},前端就不会收到 flow completed。

最后更新于