access_token / refresh_token

ネクストエンジン API の「access_token / refresh_token」に関するよくある質問です。

エラーが発生した場合access_tokenとrefresh_tokenは返ってきますか？

返却されるメッセージコードによります。 resultがerrorの場合でも, 基本的には有効なaccess_token, refresh_tokenを返します。

ただし, リクエストされたaccess_token, refresh_tokenが不正の場合(エラーコード: 002002, 002004),

一部のシステムエラー(エラーコード: 999999)の場合は有効なaccess_token, refresh_tokenを返しません。

ログイン画面を開かずに、access_tokenを取得する方法はありませんか？

申し訳ございませんが、ネクストエンジンAPIはWebアプリケーションを想定した仕組みのため、初回は必ずログイン画面にてネクストエンジンIDとパスワードでの認証が必要になります。

access tokenが有効期限切れ、refresh tokenが期限内という状態でリクエストした場合どうなりますか？

初回のリクエストのみエラーにはならず、新しいaccess tokenとrefresh tokenが発行されます。

この時に発行されるaccess tokenとrefresh tokenを保持しておけば、以降のリクエストは正常レスポンスが返却されます。ただ、この時のaccess tokenとrefresh tokenを保持せず、今までのaccess tokenとrefresh tokenでリクエストするとエラーレスポンス(002002: access_token[xxxxx]が不正です。)が返却されます。

access_tokenの更新タイミングについて教えてください。

認証の度に更新されるのではなく、access_token有効期限が切れている場合にいタイミングで更新されます。

例えばaccess_tokenの有効期限が10:00までだった場合、以下のようになります。　a. 09:50 アクセストークンAでリクエスト

　b. 10:01 アクセストークンAでリクエスト ← ここで更新されたトークン情報(アクセストークンB)が返却されます。

　c. 10:02 アクセストークンBでリクエスト ← bで返却された新しいトークン情報を利用して、リクエストを行ってください。

レスポンスの度にDBなどの永続化されたデータに保存、リクエストの際はそのデータを毎回参照し、アプリの画面など別のプロセスでトークンの更新があっても問題ないように実装いただくようにしてください。

access_token, reflesh_tokenは任意のタイミングで更新できますか？

いいえ。任意のタイミングでの更新はできません。有効期限切れ後の初回リクエスト(いずれかのエンドポイントにリクエスト)時に更新されます。

access_tokenとrefresh_tokenの構成要素を教えてください。

ともにランダムな文字列128桁になります。

アクセストークン値は発行からどのくらい継続されますか？

発行から24時間継続されます。24時間を過ぎるとトークン値が更新され、発行時のトークン値が利用できなくなります。

トークン値更新後の最初のリクエストにてアクセストークンとリフレッシュトークンを渡していただければ、新しいアクセストークンとリフレッシュを取得できます。

なお、リフレッシュトークンは72時間継続されます。