OAuth 2.0認可の流れ(Moneytree LINK Webアプリ)
認可フローの種類
Moneytree LINKが対応する、OAuth 2.0のフローです。
| 認可フロー | MT LINK APIの対応 | 説明 |
|---|---|---|
code + PKCE (RFC7636) | 対応 | クライアント様がLINK API からゲストデータにアクセスするためのアクセストークンを取得できるフローです。 |
client_credentials | 対応 | ゲストユーザーの認可でなく、client id/secretから直接アクセストークンを生成するフローです。 Moneytree LINK APIにおいては、金融機関一覧APIをおいて利用します。 |
code | 非対応 | 対応しておりません。本フローによる実装をご検討の場合は、マネーツリーにご連絡ください。 |
implicit | 非対応 | 対応しておりません。本フローによる実装をご検討の場合は、マネーツリーにご連絡ください。 |
code認可フロー
下記の図のように、codeの認可フローの時に、利用者が貴社のユーザーインターフェースから一旦弊社の認証画面で本人認証を行ない、次にリソース（口座情報など）に対する認可をしていただきます。
この流れは利用者のWebブラウザまたはモバイルアプリから可能です。実装には、是非Moneytree LINKのSDKをご利用ください。
OAuth 2.0の認可は、クライアント様アプリ・サービスから、ゲストユーザー様がMoneytree LINKの認可ページを開くことで始まります。
- 開発環境:
https://myaccount-staging.getmoneytree.com/oauth/authorize? - 本番環境:
https://myaccount.getmoneytree.com/oauth/authorize?
なお、開発環境・本番環境はそれぞれ独立したシステムであり、client id/secretはそれぞれ異なります。
以下がセットするパラメーターです。
| パラメーター名 | 設定有無 | 内容 |
|---|---|---|
client_id | 必須 | 貴社に発行されているclient_idです。環境によって異なることをご注意ください。 |
response_type | 必須 | codeに設定してください。 |
scope | 必須 | OAuth 2.0の認可スコープを指定します。詳細はご利用可能なスコープのページをご参照ください。 |
redirect_uri | 必須 | リダイレクト先URIをセットします。検証環境では登録後の初期設定の値は、urn:ietf:wg:oauth:2.0:oobです。redirect_uriで利用する値を登録・変更するには、Moneytreeにお問い合わせください。 |
state | *推奨 | OAuth 2.0認可時の推奨パラメータです。CSRF対策にご利用されることを推奨します。 |
locale | オプション | 表示する言語を指定します。“ja-JP” か “en-AU”を指定できます。 ※ 設定されない場合は、Webブラウザのロケール設定により、英語が表示されることがあります。 |
configs=auth_action | オプション | ゲストがログインしていない場合、Moneytreeの新規登録画面を表示させるか指定することができます。 ・configs=auth_action=signup → アカウントの新規登録画面が表示されます。 ・指定しない場合 → Moneytreeのログイン画面が表示されます。 |
stateについて
stateパラメータは、OAuth 2.0の仕様上推奨されているものですが、必須パラメーターではありません。しかし、Moneytree LINK APIにおいては、必須項目と解釈し、必ず実装してください。
Moneytreeの認証ページURLの例は以下となります。
[Webブラウザ]
https://myaccount-staging.getmoneytree.com/oauth/authorize?client_id={clientID}}&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=code&scope=guest_read%20accounts_read%20transactions_read%20request_refresh
(※ いずれも、リダイレクトURLは、初期設定である、urn:ietf:wg:oauth:2.0:oobです。)
金融サービス登録・管理ページ
ゲストユーザーがMoneytreeに金融サービスを登録したり、登録した金融サービスを確認・管理するためのページです。
金融サービス登録・管理ページは、ゲストユーザーがログインしていない場合、Moneytreeのログイン・新規登録画面が表示されます。
- 開発環境:
https://vault-staging.getmoneytree.com? - 本番環境:
https://vault.getmoneytree.com?
以下がセットするパラメータです。
| パラメーター名 | 設定 | 内容 |
|---|---|---|
client_id | 必須 | client_idをセットします。 |
configs=back_to | オプション | このパラメーターを設定すると、金融サービス登録・管理ページ上部に戻るリンクが表示されます。 指定できるURLは、redirect_uriに設定したものに限られるため、redirect_uri以外のuriをセットする場合は、Moneytreeにご連絡ください。 |
configs[auth_action]=signup | オプション | このパラメータにより、認証画面が開かれた時に、ログインページでなく、新規登録画面を指定して開くことができます。 指定しない場合、ログインページが表示されます。 |
ゲストユーザー設定ページ
ゲストユーザーが、Moneytreeのアカウント情報を閲覧・変更するためのページです。
登録しているメールアドレス/パスワードの変更や、および認可した連携サービスの閲覧/連携解除などをすることができます。
開発環境: https://myaccount-staging.getmoneytree.com/settings?
本番環境: https://myaccount.getmoneytree.com/settings?
セットするパラメータは、[金融サービス登録・管理ページ]と同じです。
認証・認可のイメージ
Moneytree LINKのOAuth認可ページを開き、ゲストユーザーがクライアント様アプリ・サービスへ認可したり、金融サービスを登録するイメージフローです。
認証・認可のイメージ（ユーザー）①
認証・認可のイメージ（ユーザー）②
認証・認可のイメージ（ユーザー）③
Updated over 1 year ago