Developers API & Widget
API Reference
JA

はじめに

はじめに

このガイドでは Wealth Reader(ウェルスリーダー)の統合方法を説明します。ユーザーが銀行を選び、認証を完了すると、正規化されたデータがシステムに届きます。

最終結果の例: https://widget.wealthreader.com/demo-all/

始める前に

次のものが必要です。

  • 登録を完了し、api_key を取得していること。
  • テクニカルチームとのオンボーディングセッション。サポート から予約してください。
  • 統合方式を決めること(下記)。
  • iframe で統合する場合、callback を受け取る HTTPS URL。

統合方式を選ぶ

基準 Iframe(widget) OAuth
適用場面 iframe を埋め込める Web アプリ ネイティブアプリ、または iframe を埋め込めない場合
Frontend ページに widget を挿入する ユーザーを oauth.wealthreader.com へリダイレクトする
データ callback URL への POST で届く /token/ でチャレンジを完了して取得する
開始ページ Iframe: frontend OAuth: backend

Web クライアントの大半は iframe を使います。

仕組み(iframe)

  1. ページが、生成した operation_id 付きで widget を読み込みます。
  2. ユーザーが金融機関を選び、同意し、必要なら二要素認証を完了します。これらの手順は widget が処理します。
  3. Wealth Reader がデータを取得し、この順で次の 2 つを行います。
    • backend では、設定済みの callback URL に完全な JSON を送ります。この応答に operation_id が含まれるので、frontend の操作と突き合わせられます。
    • frontend では、callback が成功した場合に限り、iframe が postMessageflow completed)でページに通知します。セレクターを閉じる、または成功画面を表示するために使います。

operation_id は frontend と backend をつなぐ橋です。これがないと、ブラウザ側で起きたこととサーバーに届いたデータを照合できません。

flow completed メッセージには銀行データは含まれません。データは callback に送られます。callback が HTTP 200{"status":"ok"} を返さない場合、frontend は flow completed を受け取りません。

最終更新