Developers API & Widget
API Reference
JA

はじめに

連携の流れ

iframe 連携の正常な処理順序です。フロントエンドへの通知より前に callback が送信されます。

sequenceDiagram
participant U as ユーザー
participant W as 自社Webサイト
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 を生成し、ウィジェットを読み込み、postMessage を受信する。
ウィジェット 銀行選択、ログイン、2FA、エラーをユーザーに表示する。
Wealth Reader API 金融機関と通信し、応答を正規化する。
自社バックエンド callback URL を公開し、{"status":"ok"} を返し、operation_id、token、payload を保存する。

エラーが発生した場合

  • パスワード誤り、2FA、金融機関のエラーはウィジェットがユーザーと処理します。フロントエンドは postMessage でエラー JSON を受信する場合があります。読み取りが正常に完了するまで callback は呼び出されません。
  • callback が 200 + {"status":"ok"} を返さない場合、ユーザーに成功は表示されず、フロントエンドは flow completed を受信しません。
  • token が無効になった場合(パスワード変更や新たな 2FA)、その token を渡してウィジェットを再度開き、ユーザーに再認証してもらいます。

各メッセージと callback 本文の詳細は iframe の各ページを参照してください。

次の手順

iframe 方式の場合は、フロントエンド、続いてバックエンドに進んでください。iframe を埋め込めない場合は OAuthを参照してください。

最終更新