Developers API & Widget
API Reference
JA

はじめに

連携フロー

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: iframeをoperation_idで挿入してください。
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): その token を渡して widget を再度開き、ユーザーに再認証してもらいます。

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

次のステップ

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

最終更新