アクセストークンの取得

認可コードからアクセストークンを取得する

OAuth 2.0のフローで、ゲストユーザーが認可すると、指定されたリダイレクトURIにリダイレクトされ、パラメータとして認可コード(code)が発行されます。
上記のAPIを利用し、認可コードから、アクセストークン、およびリフレッシュトークンを取得します。

なお、セキュリティ上の目的もありますが、認可コードの有効期間は十分に短いため、リダイレクトで取得したら即座にアクセストークンAPIからアクセストークンを取得するように実装してください。

アクセストークンとリフレッシュトークンの利用について

アクセストークンのライフタイム(寿命)は短いものです。
有効期間が過ぎたら、アクセストークンと同時に発行されるリフレッシュトークンから再度、新しいアクセストークン及びリフレッシュトークンを取得します。

📘

アクセストークン及びリフレッシュトークンのライフタイムについて

アクセストークンの有効期限は通常1時間ですが、expires_inの値(秒数)で有効期間を判定する実装をしてください。
リフレッシュトークンの有効期限は十分に長いもの(数ヶ月以上)ですが、仕様として定義しません。これはセキュリティ上の理由などにより、今後変更される可能性があります。

リフレッシュトークンは原則1回のみの利用できます。しかし、リフレッシュトークンを利用してアクセストークンを取得してから、新しく発行されたアクセストークンが利用されるまでは、そのリフレッシュトークンは再利用可能です。
これは例えば、リフレッシュトークンを利用してアクセストークンを取得するAPIをリクエストした時に、ネットワーク障害などで応答内容が戻ってこない場合などに、再度リフレッシュトークンを使って新しいトークンを取得できるようにするためです。

❗️

リフレッシュトークンの重要性

リフレッシュトークンは、用途として、パスワードのようなものであると言えます。
取り扱いには十分にご注意し、厳重に保管してください。例えば、システムのログなどに出力したりしないようにしてください。
これはアクセストークン、リフレッシュトークンにおいても同様に、ログや機密性がそれほど高くないデータベースなどに保管しないでください。

❗️

URLクエリパラメータに機密情報を送信しないでください

URLのクエリーパラメーターに機密情報を送信することは、セキュリティ上の問題があります。
URL のパラメータとして client_secretaccess_token または refresh_token を送信しないでください。
詳細については留意点を参照してください。

Recipes
🏦
トークンリフレッシュとデータ取得
Open Recipe
🚀
認可コードからゲストトークン取得
Open Recipe
🔐
認可コードからゲストトークン取得(PKCE使用)
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
enum
required

トークン取得時に指定するグラントタイプ(authorization_coderefresh_token, client_credentials

Allowed:
string
required

連携するクライアントアプリケーションのID

string

client_idとセットとなるsecretキー

string

認可コードを受け取るリダイレクト先URI(grant_type = authorization_codeの場合のみ利用)

string

トークンを取得するために一時的に発行される認証コード(grant_type = authorization_codeの場合のみ利用)

string

リフレッシュトークン(grant_type = refresh_tokenの場合のみ利用)

string
length between 43 and 128

RFC 7636に記述されているPKCEコード検証。(grant_type = authorization_codeの場合のみ利用)

string

OAuth 2.0の認可スコープをセット指定します(grant_type = client_credentialsの場合のみ利用)。
※ 複数のscope値をセットする場合、" "(スペース)で値を繋げます。
例:scope=guest_read accounts_read transactions_read

Responses

400

APIに対して行われたリクエストが無効である場合に返されます。
これは通常、送信されたデータが検証を通過しなかったことが原因です。

401

有効なアクセストークンを持っていない場合に返されます。

429

アプリケーションが多くのリクエストを送信し、レート制限を受けている場合に返されます。
APIレート制限は何か、どのように対処するのか?もご覧ください。

500

原因不明の内部サーバーエラーが発生した場合に返されます。

503

Moneytreeサービスがメンテナンス中の場合に返されます。

Language
URL
LoadingLoading…
Response
Choose an example:
application/json