Developers API & Widget
API Reference
JA

はじめに

はじめに

このガイドでは 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 アシスタントで開発していますか? Wealth Reader スキルを Claude Code、Codex、Cursor、Copilot、Gemini CLI にインストールすると、このガイドに沿って連携を実装できます。

動作の流れ(iframe)

  1. 自分で生成した operation_id を指定して、ページにウィジェットを読み込みます。
  2. ユーザーが銀行を選び、同意し、必要なら二要素認証を行います。これらの手順はウィジェットが管理します。
  3. Wealth Reader はデータを取得し、次の順番で 2 つの処理を行います。
    • バックエンドには、設定済みの callback URL へ完全な JSON を送信します。応答に含まれる operation_id により、フロントエンドの操作と関連付けられます。
    • フロントエンドには、callback が正常に応答した場合に限り、iframe が postMessage(flow completed)で通知します。この通知で選択画面を閉じるか、成功画面を表示します。

operation_id はフロントエンドとバックエンドを結ぶ識別子です。これがなければ、ブラウザー上の操作とサーバーに届くデータを関連付けられません。

flow completed メッセージには銀行データは含まれません。データは callback に送られます。callback が HTTP 200 と {"status":"ok"} を返さない場合、フロントエンドは flow completed を受信しません。

最終更新