主な画面
新規登録・ログイン
Moneytree LINK SDKが対応するMoneytreeの認証フローは以下の2つがあります。
- パスワード認証
- パスワードレスサインアップ・ログインフロー
パスワード認証
- メールアドレスとパスワードを入力して新規登録・ログインする方法です。
- クライアント側アプリ・サービスで、メールアドレスの登録などがある場合、そのメールアドレスをオートフィルして呼び出すことができます。
関数
MoneytreeLink.instance.authorize(activity, config)
MTLinkClient.shared.authorizeUsingPkceFrom(viewController, authOptions, animated, completion)
- 新規登録ページか、ログインページかを指定して開くことができます。新規登録を指定しない(
signup
パラメータを指定しない)場合、ログイン画面が表示されます。 - 本関数は、メールアドレスをオートフィルして呼び出すことができます。
ログイン・新規登録画面は右上のボタンから、ゲストユーザーがきりかえることができます。 - 新規登録・ログインいずれにおいても、メールアドレスとパスワードを入力します。
- 他の関数でMoneytree LINKのWebページを開く場合、SDKがログイン状態でない場合は、ログインページが表示されます。
パスワードレスサインアップ・ログインリンク
- Moneytree LINK SDK v.6.0における新機能です。
- メールアドレスのみで新規登録、または認証できるフローです。
- 入力したメールアドレスに認証するリンクを送信します。そのメールにあるリンクをタップすることで自動的に認証されます。
- パスワード認証と同様に、新規登録の際、メールアドレスをセットして呼び出すことができます。
パスワードレスサインアップ・ログインフローの実装における注意点です。
パスワードレスサインアップ
関数
MoneytreeLink.instance.onboard(activity, config)
MTLinkClient.shared.onboardFrom(viewController, authorizationType, email, state, region, animated, completion)
- パスワードレスサインアップ画面を直接呼び出します。
- 本機能は、メールアドレスをオートフィルして呼び出すことができます。クライアント様アプリ・サービスにおいて、利用者様のメールアドレスが存在する場合、そうしたメールアドレスをご利用ください。
- 本関数がコールされると、登録したメールアドレスに新規登録メールが届きます。
ログインリンク
関数
MoneytreeLink.instance.authorize(activity, config)
MTLinkClient.shared.authorizeUsingPkceFrom(viewController, authOptions, animated, completion)
- ログインリンクの設定が有効な場合、本関数により、ログインリンクを送信するページが表示されます。
- 本関数は、メールアドレスをセットして呼び出すことができます。
- ログインリンクを含むメールが登録したメールアドレスに送信され、そのURLをタップすると、パスワードを入力することなく、Moneytreeにログインできます。
- ゲストユーザーはこのページを、パスワードでログインするページと切り替わることができます。
- 本機能は、パスワードレスサインアップとは独立した機能であり、本機能のみ利用することもできます。
認可(OAuth)
関数
MoneytreeLink.instance.authorize(activity, config)
MTLinkClient.shared.authorizeUsingPkceFrom(viewController, authOptions, animated, completion)
- ログイン後、Moneytree 連携認可画面表示されます。
- OAuthに設定した、対応するscopeが表示されます。該当する説明を表示します。
※ なお、同じクライアント、同じscopeの一覧で認可済みの場合、この画面は表示されず、自動的にredirectされます。 - 「連携する」をタップするとredirect_uri先に認可code, stateがセットされてリダイレクトされます。
(PKCEの場合はSDKが自動的に処理します。)
金融サービスの登録・管理
関数:
MoneytreeLink.instance.openVault(activity, requestContext)
MTLinkClient.shared.openVaultFromViewController(viewController, animated, email, completion)
ゲストユーザー様が以下の操作を行うための画面です。
- 金融サービスを登録
- 登録されているサービスの情報・設定の変更
- 登録されているサービスの情報をアーカイブ
※ アーカイブすると、LINK Kitや、ネイティブアプリなどにおいて非表示になり、またデータも更新されなくなります。 - 登録されているサービスの情報を削除
※ SDKがログインしていない場合、ログインページが表示されます。
本画面は、ゲストユーザーに以下の機能を提供するものです:
- ログイン情報の変更:新しいID・パスワード入力、または金融サービスに再認可することができます
- アーカイブする:データ自体は削除されず、データの更新を停止することができます。
- 「アカウント」の設定:特定のアカウントの表示名称をニックネームとして変更することができます。なお、ニックネームを入力すると、金融サービス一覧画面ではニックネームが表示されます。また、この値は、各口座(accounts)APIのレスポンスにおける
nickname
フィールドに返されます。(institution_account_name
は影響を受けません。)
特定の金融サービス登録/管理画面を直接表示する機能について
機能概要
openVault
関数は、金融機関登録画面のトップページを呼び出すだけでなく、以下のように、その先にある、特定の金融サービスの登録/管理画面を直接呼び出すこともできます。
- 特定グループの金融サービス一覧
- 特定の金融サービスの登録画面
- 登録済の金融サービス再認証画面
openVault
関数の推奨利用方法、注意点について
- 本機能は、ゲストユーザー様がクライアントに認可をしていない状態でも利用できますが、認可された後に利用できるように実装することを推奨します。
- ゲストユーザーのメールアドレスの誤入力を防ぐため、メールアドレスをお客様情報APIで取得し、そのメールアドレスをセットして、自動入力させてこの機能を呼び出すようにしてください。
- 誤った値がセットされている場合など、正常に処理されなかった場合は、通常のMoneytree 金融機関一覧画面が起動します。
1. 特定グループの金融サービス一覧
関数
MoneytreeLink.instance.openVault(activity, requestContext)
MTLinkClient.shared.openServicesFromViewController(viewController, animated, email, options, completion)
クライアント様アプリから、ワンステップでMoneytreeの特定グループの金融サービス一覧画面を開くイメージです。
例えば、”新しい銀行口座を追加する”などといった機能をクライアント様アプリで表示し、そこから直接ターゲットとする金融サービスの登録画面を表示することができます。
2. 特定の金融サービスの登録画面
関数
MoneytreeLink.instance.openVault(activity, requestContext)
MTLinkClient.shared.connectServiceFromViewController(viewController, animated, email, entityKey, completion)
クライアント様アプリから、ワンステップでMoneytreeの特定の金融サービスの登録画面に遷移させるイメージです。
例えば、クライアント様アプリ上で、”A銀行口座を追加する”, ”Bクレジットカードを追加する”といったボタンを配置し、選択されると該当する金融サービスの登録画面を直接開くことができます。
3. 登録済の金融サービス再認証画面
関数
MoneytreeLink.instance.openVault(activity, requestContext)
MTLinkClient.shared.serviceSettingsFromViewController(viewController, animated, email, credentialId, completion)
クライアント様アプリから、すでにMoneytreeに登録されている金融サービスのログイン情報の変更画面を開くイメージです。
クライアント様側で「アカウントグループのステータス確認」APIで登録されている口座のステータスをチェックし、再認証や、OTPの入力などが必要な状態にある金融サービスの変更画面を直接開くことができます。
Moneytreeゲストアカウントの設定
関数
openSettings
MoneytreeLink.instance.openSettings(activity, email)
MTLinkClient.shared.openSettingsFromViewController(viewController, animated, completion)
MTLinkClient.shared.openSettingsFromViewController(viewController, email, animated, completion)
- Moneytree 設定画面は、Webのセッションが有効でない場合、都度ログインする必要があります。
- この関数は、可能な限りゲストユーザー様が認可済みの条件下でご利用ください。そして、メールアドレスの誤入力を防ぐために、メールアドレスをパラメータにセットし、メールアドレスが自動入力された状態で開かれるように実装してください。
※ メールアドレスは、お客様情報APIで取得できます。 - 右にある各項目のうち、以下のページが新しいタブで開かれます。
- 利用規約と個人情報保護方針:Moneytreeの利用規約・個人情報保護方針を説明するページのリンクです。
- よくある質問:MoneytreeのFAQページのリンクです。
- 本画面をクライアント様アプリから直接呼び出すことで、ゲストユーザー様はクライアントへ認可していない状態からMoneytreeを退会することができます。そのため、クライアント様アプリから独立してこの画面を呼び出す導線を実装してください。
Updated almost 2 years ago