トークンエンドポイント
POST/token
認可コードフローまたはトークンの更新を行い、トークンを発行します。
リクエストボディは、認可コードフローでのトークン発行とトークン更新で異なります。 詳細は次のスキーマをご確認ください。
- 認可コードフロー:
AuthorizationCodeTokenRequestBody - トークン更新:
RefreshTokenRequestBody
取得したトークンは有効期限まで再利用してください。 トークンを使用したとき、有効期限が切れて401を返した時は、このエンドポイントでトークンを更新してください。 それまではトークンを再発行する必要はないため、過度なアクセスはお控えください。
client_id および client_secret の使い方は連携用アプリの「クライアント認証方式」の設定に依存します。
認証方式はアプリ詳細画面よりご確認ください。
クライアント認証方式が CLIENT_SECRET_BASIC の場合は、Basic認証を使用します。
ClientID:ClientSecretをBasic認証で指定してください。
クライアント認証方式が CLIENT_SECRET_POST の場合は、リクエストパラメタにclient_idとclient_secretを指定してください。
レート制限
このエンドポイントにはレート制限があります。 制限に達した場合、しばらく待ってからアクセスしてください。 通常はトークンを適切にキャッシュすることで、レート制限を回避することができます。
詳細はAPI共通仕様のレート制限を参照してください。
リクエスト
レスポンス
- 200
- 400
- 401
- 429
- 500
- 503
トークンリクエストが正しい場合
トークンの詳細はSchemaを参照してください。下記のどちらも同じレスポンス形式になります。
- 認可コードフローでのトークン発行
- トークン更新
レスポンスヘッダー
application/json;charset=UTF-8
no-store
no-cache
トークンリクエストが誤っている場合
レスポンスヘッダー
application/json;charset=UTF-8
no-store
no-cache
クライアント情報が誤っている場合
レスポンスヘッダー
application/json;charset=UTF-8
no-store
no-cache
Basic realm="token"
リクエスト回数制限を超えた場合
レスポンスヘッダー
リクエスト回数制限を超えた場合のリトライまでの時間(秒)
認可サーバー内でエラーが発生した場合
レスポンスヘッダー
application/json;charset=UTF-8
no-store
no-cache
サーバーメンテナンス中の場合