Moneytree LINK 開発スタートガイド
このガイドはMoneytree LINKサービスを利用したWebアプリケーション開発にあたり、第一歩目となるAPIコールで金融データ取得までの手順を説明しています。
スタートガイド概要
以下2つのページをクライアント様ウェブアプリケーションに組み込み、APIコールを行うことで、Moneytree LINKサービスを通じてエンドユーザー様の金融データをクライアント様webアプリケーションに連携することができます。
- OAuth認可ページ:Moneytree LINKで保持するエンドユーザー様の金融データをクライアント様webアプリケーションへ連携を許可する仕組み
- 金融サービス一覧ページ:Moneytree LINKに接続する金融機関の追加や削除などを管理するページ
このスタートガイドでは検証環境でテストアプリを作成し、上記の2つのページを組み込み、最初のAPIコールで金融データを取得する基礎的なシナリオを想定しています。
このガイドと合わせて、簡単なサンプルコードを解説付きで紹介しているチュートリアル(レシピ)を用意しています。ぜひそちらもご覧ください。
手順
Step 0- セットアップ
Step 1 - OAuthの認可の設定とトークンの取得
Step 2 - 金融サービス一覧ページで金融機関の登録
Step 3 - アクセストークンでAPIコールを行いエンドユーザーの口座データを取得
スタートガイド概要マップ
エンドユーザー:Moneytree LINKクライアントのサービス利用者をエンドユーザーと呼びます。
クライアント:Moneytree LINKのAPIを利用し、エンドユーザーの金融データを取得するアプリやサービスを提供するサービス事業者をクライアントと呼びます。
Moneytree LINK:エンドユーザーから明示的に情報共有の同意を得た上で金融データを取得し、それを集約してクライアントに提供するデータプラットフォームです。
Step 0 - セットアップ
このステップでは検証環境でテストアプリ作成を始める前のセットアップを紹介しています。検証環境は主にMoneytree LINK APIに対して開発・テストするための環境です。Moneytree LINK APIの本番データを取得する環境は本番環境となります。
- 認証の照合に使われる
client_id
とclient_secret
はマネーツリーから提供されます。
このガイドではテストアプリ用のredirect_uriをローカルホストに設定したシナリオになります。
例) http://localhost:8080/moneytree_auth/callback
ご質問はMonetytree LINKのお問合せフォームをご活用ください。
テスト用のエンドユーザーアカウントはご担当者様のメールアドレスなどを使用して作成してください。エンドユーザーアカウントを準備することで、Moneytree LINK サービスを介して、金融データ取得のテストを行うことができます。
- テスト用のエンドユーザーとしてMoneytree IDの新規登録を完了します。(新規登録ページ)
エンドユーザーアカウントの新規作成をする場合は、こちらのいずれかの金融機関一覧のURLからアカウント新規登録ができます。
<https://vault-staging.getmoneytree.com?client_id=[******]&configs=auth_action=signup>
([**]の部分は、Client IDに入れ替えてください。)<https://vault-staging.getmoneytree.com/?configs=auth_action=signup>
アカウント新規登録
新規登録画面で、ユーザーIDとパスワードを設定してエンドユーザーのMoneytree IDを作成します。
Step 1 - OAuthの認可の設定とトークンの取得
このステップではOAuth認可フローの設定とアクセストークン取得のプロセスを紹介しています
クライアントのテストアプリがエンドユーザーの金融データにアクセスできるように、エンドユーザーが「認可」(連携許可)を承認できる認可フレームワーク(OAuth 2.0)を設定します。
- Moneytree LINKのOAuth認可ページ(連携許可承認画面)にリダイレクトされる誘導リンクを、テストアプリウェブサーバーに設定します。実際にはエンドユーザーのクリックでリダイレクトされます。
- エンドユーザーは連携許可承認画面でクライアントへの連携許可を承認もしくはキャンセルします。(エンドユーザーがMoneytree IDにログインしていない場合はログイン画面が先に表示されます。
- エンドユーザーにより連携許可が承認された場合、Moneytree LINK はブラウザを介して認可コードを含むリダイレクトコールをします。
- クライアントのテストアプリは、送られてきた認可コードと
client_id
とclient_secret
を使いアクセストークンをリクエストします。 - Moneytree LINK のバックエンドシステムが認可コード、
client_id
、client_secret
を検証します。 - 全てが承認された場合、Moneytree LINK はアクセストークンおよびリフレッシュトークンを生成して、クライアントに送ります。
下記のボタンからサンプルコードを使った認可コードからゲストトークン取得のチュートリアルもご参考ください。
エンドユーザーのフローはテストアプリ画面から始まり、Moneytree IDの連携許可承認画面へと移り、連携許可を承認して、テストアプリ画面へと戻ります。
エンドユーザーフロー 1
連携許可のプロセスを開始
エンドユーザーはテストアプリ上でMoneytree IDの連携許可承認画面へのリンクをクリックします。
エンドユーザーフロー 2
Moneytree IDにログイン
エンドユーザーはメールアドレスとパスワードを入力して、Moneytree IDにログインします。
エンドユーザーフロー 3
連携許可の承認
エンドユーザーはMoneytree IDの連携許可承認画面で、連携許可の承認もしくはキャンセルを選択します。
エンドユーザーフロー 4
連携許可の完了
エンドユーザーは連携許可を承認して、テストアプリで連携許可の完了を確認します。
Step 2 - 金融サービス一覧ページで金融機関を登録
このステップではエンドユーザーのアカウントで金融の登録を完了するプロセスを紹介しています。
Moneytree LINK サービスは、エンドユーザーが登録した金融機関・サービスから金融データを取得します。エンドユーザーアカウントで、金融サービス一覧ページから1つ以上の金融機関を登録してください。
エンドユーザーフロー 1
Moneytree IDにログイン
エンドユーザーはメールアドレスとパスワードを入力して、Moneytree IDにログインします。
エンドユーザーフロー 2
金融サービス検索
ログイン後、金融サービス一覧ページに移ります。エンドユーザーは緑色ボタン「銀行を登録する」「クレジットカードを登録する」をクリックするか、右下の「+」ボタンをクリックして「[Data Test] Bank」を検索します。
エンドユーザーフロー 3
金融サービス登録
エンドユーザーは、金融サービス一覧ページの画面で必要なログイン情報を入力もしくは選択し、「金融機関に接続する」ボタンをクリックします。
エンドユーザーフロー 4
金融サービス登録完了
金融サービス一覧ページに戻り、接続済みの金融サービスに連携接続中である金融サービスが表示されます。「接続中」から「たった今更新」のステータスが表示されるのを確認できれば登録完了です。
Step 3 - APIコールを行い口座一覧を取得する
取得したアクセストークンでテストアプリはエンドユーザーの口座データをリクエストするAccount APIをコールをします。
Moneytree LINK はアクセストークンの有効性を検証します。承認された場合、エンドユーザーの口座データを取得してクライアントにレスポンスします。
テストアプリは取得した口座データを使い、エンドユーザーにアプリのサービスを提供することになります。
- 取得したアクセストークンでテストアプリはエンドユーザーの口座データをリクエストするAccount APIをコールをします。
- Moneytree LINK はアクセストークンの有効性を検証します。承認された場合、エンドユーザーの口座データを取得してクライアントにレスポンスします。
- テストアプリは取得した口座データを使い、エンドユーザーにアプリのサービスを提供することになります。
実使用ではトークンリフレッシュの設定が必要になります。ご興味ある方は、サンプルコードを使ったチュートリアルをご参考ください。
リソース
このスタートガイドに併せて、以下のリソースもご参照ください。
サンプルコードを紹介しているチュートリアル(レシピ)
- 認可コードからゲストトークン取得方法
- トークン交換の安全性を高めるためにPKCEを使用した認可コードからゲストトークン取得方法
- エンドユーザ認可が取得済みの状態からのトークンリフレッシュとデータ取得方法
- 金融機関からの最新データを取得するための同期依頼とアカウントグループステータスのポーリングのサンプル紹介
MoneytreeのAPIドキュメントサイトにも開発のリソースを掲載しています。
-
Moneytree LINKのOAuth 2.0認可ページ
-
エンドユーザーが連携の登録や管理をする金融サービス登録・管理ページ
-
エンドユーザーがMoneytree IDのアカウント情報を閲覧・変更するMoneytree設定ページ
-
Moneytree LINK が採用していAPIについて Moneytree LINK APIについて
-
Moneytree LINK画面のカスタマイズ 設定項目・各種コンテンツについて
-
開発の工数を減らすSDK導入について Moneytree LINK SDKについて