認証

アクセストークンの発行

アクセストークンの発行

認証用のアクセストークンの作成、取得をします。

補足説明
認証トークンの発行は、導入時にお渡ししたクライアントIDおよびシークレットキーを使用します。

メソッドとURL

メソッド  URL
POST https://auth.{HOST名}/oauth2/token

リクエスト

リクエストは、ヘッダとパラメータを利用します。
詳細については以下AWSドキュメントをご参照ください。

トークンエンドポイントについて

ヘッダ

リクエストのタイプ指定と、認証のためのデータを設定します。

項目 設定値
Content-Type application/x-www-form-urlencoded
Authorization Basic[SP]{クライアントIDとシークレットキーをbase64エンコードしたもの}
※[SP]は半角スペース
補足説明
クライアントIDとシークレットキーをbase64化する際、以下のように文字列を結合してbase64化します。

クライアントID:シークレットキー

（「:」で両者を結合した文字列）

ボディパラメーター

リクエストボディには、以下のようにパラメーターを設定します。

項目 設定値
grant_type client_credentials

レスポンス

ステータスコード

コード メッセージ  説明
200 OK 処理成功。
400 Bad Request パラメータ不正。フォーマット不正など。errorパラメータにて詳細を確認。
405
 Method Not Allowed メソッドの利用が許可されていないか、パラメーターが不足です。
500 Internal Server Error 想定外のエラー。
しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。
その場合は、HTTPレスポンスステータスコード一覧をご確認ください。

HTTPレスポンスステータスコード一覧

トークンの有効期間

発行されたトークンは1時間有効となります。
トークンは、有効期限が切れるまでは複数回利用できます。

トークン発行について

トークン有効期限内に複数回発行しても、発行済みのトークンの有効期限は変更されません。
それぞれのトークンは、有効期限が切れるまで利用可能です

トークンの無効化について

  • アララにてクライアントIDを一時的に無効化した場合、トークンの発行は可能ですが、発行されたトークンの認可がエラーとなります。
  • アララにて解約などでクライアントIDを削除した場合には、認証がエラーとなり、トークン発行ができなくなります。

サンプル

リクエスト

POST https://xxxxxxxxxxxxx/oauth2/token
Content-Type: application/x-www-form-urlencoded
Authorization: Basic XXXXXXXXXXXXX

grant_type=client_credentials

※ヘッダ情報含む

補足説明
「Authorization=Basic XXXXXXXXXXXXX」の「XXXXXXXXXXXXX」部分は、
クライアントIDとシークレットキーをbase64エンコードしたものを記載してください。

レスポンス

リクエストデータにより、サンプルに記載の項目以外の情報も返却される可能性があります。

正常

HTTP/1.1 200 OK
Content-Type: application/json
{
"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

※ヘッダ情報含む

返却されたaccess_tokenを、配信予約などのリクエスト時に設定します。

エラー

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
{
"error":"invalid_client"
}

※ヘッダ情報含む