Developers API & Widget
API Reference
JA

はじめに

連携フロー

iframe 統合の正常系です。callback は frontend への通知より前に送信されます。

sequenceDiagram
participant User as ユーザー
participant Web
participant Widget as Wealth Reader Widget
participant API as Wealth Reader API
participant Bank as 金融機関
User->>Web: アプリを開く
Web->>Widget: operation_id 付きで iframe を読み込む
User->>Widget: 金融機関を選び同意する
Widget->>API: operation_id でデータを要求
API->>Bank: 照会
Bank-->>API: 応答
API-->>Widget: 正規化データを返す
Widget->>Web: callback へ POST(operation_id + token + payload)
Web-->>Widget: HTTP 200 と status ok
Widget-->>Web: postMessage flow completed
Web-->>User: 完了を表示

役割分担

アクター 責務
フロントエンド 一意の 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): その token を渡して widget を再度開き、ユーザーに再認証してもらいます。

各メッセージと callback 本文の詳細は、iframe の各ページにあります。

次のステップ

iframe で統合する場合は、frontend に進み、続けて backend を実施してください。iframe を埋め込めない場合は OAuth へ進んでください。

最終更新