トークン取得APIリファレンス（アフィリエイトサイト向け）

概要

アフィリエイトサイト向け認証下APIにアクセスするため必要なトークンを提供するリクエストについての仕様書です。 トークン発行リクエストを行うためには、管理画面「ツール」 ＞「レポートAPI」画面にて、API認証キーを発行している必要があります。

有効期限

このAPIのトークンの有効期限は30分間です。期限が切れるとリクエスト時にエラーメッセージ「invalid_token」が返却されますので、トークン取得APIに再度リクエストを行い、最新のトークンを取得し、指定してください。エラーメッセージについては「レスポンスヘッダー」の章を参照ください。

利用制限

このAPIでは30分間以内に9,000回を超える正常リクエストが行われた場合に30分間ロックされます。ロック中のリクエスト時にはエラーメッセージ「locked」が返却されますので、時間を置いて再度リクエストしてください。エラーメッセージについては「レスポンスヘッダー」の章を参照ください。

リクエスト

エンドポイント

GET https://api.valuecommerce.com/auth/v1/affiliate/token/

リクエストヘッダー

リクエストヘッダーには下記を指定してください。

  • Authorization: Bearer [署名]
  • Accept: application/json

署名作成サンプル

[署名]部分には、管理画面の「ツール」 ＞「レポートAPI」画面で発行した CLIENT_KEY、CLIENT_SECRETを"|"（パイプ）で結合し、Base64エンコードした文字列を指定してください。改行文字は利用不可、1行で出力してください。

Ruby

$ ruby -r base64 -e "print Base64.strict_encode64('THIS_IS_TEST_CLIENT_KEY_STR|THIS_IS_TEST_CLIENT_SECRET_STR')"
VEhJU19JU19URVNUX0NMSUVOVF9LRVlfU1RSfFRISVNfSVNfVEVTVF9DTElFTlRfU0VDUkVUX1NUUg==

PHP

$ php -r "echo base64_encode('THIS_IS_TEST_CLIENT_KEY_STR|THIS_IS_TEST_CLIENT_SECRET_STR');"
VEhJU19JU19URVNUX0NMSUVOVF9LRVlfU1RSfFRISVNfSVNfVEVTVF9DTElFTlRfU0VDUkVUX1NUUg==

Node.js

$ node -e "process.stdout.write(new Buffer('THIS_IS_TEST_CLIENT_KEY_STR|THIS_IS_TEST_CLIENT_SECRET_STR').toString('base64'));"
VEhJU19JU19URVNUX0NMSUVOVF9LRVlfU1RSfFRISVNfSVNfVEVTVF9DTElFTlRfU0VDUkVUX1NUUg==

bash

$ echo -n $(echo -n "THIS_IS_TEST_CLIENT_KEY_STR|THIS_IS_TEST_CLIENT_SECRET_STR" | base64 | sed -ne 'N;s/\n//p')
VEhJU19JU19URVNUX0NMSUVOVF9LRVlfU1RSfFRISVNfSVNfVEVTVF9DTElFTlRfU0VDUkVUX1NUUg==

あるいは、以下のようにします。

$ echo -n "THIS_IS_TEST_CLIENT_KEY_STR|THIS_IS_TEST_CLIENT_SECRET_STR" | base64 | perl -pe 's/\n//g'
VEhJU19JU19URVNUX0NMSUVOVF9LRVlfU1RSfFRISVNfSVNfVEVTVF9DTElFTlRfU0VDUkVUX1NUUg==

リクエストサンプル

$ curl https://api.valuecommerce.com/auth/v1/affiliate/token/?grant_type=client_credentials -H "Authorization: Bearer VEhJU19JU19URVNUX0NMSUVOVF9LRVlfU1RSfFRISVNfSVNfVEVTVF9DTElFTlRfU0VDUkVUX1NUUg==”

リクエストボディー

パラメーター名説明必須許容文字列許容バイト数
callback(※1)コールバック関数名×半角英数および記号【_-】50バイト以下
grant_type要求内容○client_credentials（固定）18バイト（固定）

※1：JSONP返却を求める場合のみ指定してください。

レスポンス

レスポンスヘッダー

エラーメッセージ

error="XXX"error_description="XXX"の表記で、発生したエラーメッセージを示します。正常レスポンス時にはこの項目は返却しません。各エラーメッセージの示す内容は以下のとおりです。

errorerror_descriptionHTTP STATUS CODE意味対応要求
invalid_requestAuthorization request header is in invalid format (or may not be encoded).401Authorizationヘッダー不正、指定されていない、Base64エンコードされていない場合Authorizationヘッダーの値、生成方法を確認してください。詳しくは「リクエストヘッダー」の章を参照ください
invalid_credentialInactive credential value.401Authorizationヘッダーが正常だが、アクティブなサイト署名情報とひもづかない不正値管理画面で表示されているCLIENT_KEY/CLIENT_SECRETを再度ご確認ください。再生成されている可能性があります（このエラーメッセージはトークン取得APIに限り返却します）
invalid_tokenThe current bearer token is invalid or already expired. Please get a new one.401トークンが不正値、または有効期限切れトークン取得APIにリクエストを行い、最新のトークンを取得し、指定してください（このエラーメッセージは認証下APIに限り返却します）
lockedThe endpoint has been locked due to the requests limit. Please try again later.403期間内利用回数の上限を超え、ロック中のエンドポイントに対するアクセス時間をおいて再度リクエストしてください
invalid_parametersSome of request parameters are invalid.400いずれかのリクエストパラメーターが不正値「リクエストボディー」の章をご確認ください
not_found-404存在しないエンドポイントに対するアクセスリクエストされたURLをご確認ください
server_error-500システムメンテナンス中時間をおいて再度リクエストしてください

レスポンスボディー

パラメーター名説明説明詳細正常時返却異常時返却
errorエラー概要レスポンスヘッダー「error」と同一×○
error_descriptionエラー詳細レスポンスヘッダー「error_description」と同一×○
resultSet正常時レスポンスフィールドセット正常処理時のリクエスト・およびレスポンスに関する情報○×
responseInfoレスポンス情報正常処理時のレスポンスに関する情報○×
numberOfResult取得件数rowDataフィールド要素数○×
nextOffset次取得開始位置次リクエスト時にoffsetに指定する値（一覧系のAPI時にのみ有効で取得内容が最終行である場合には-1を返却する）○×
responseTimeレスポンス返却日時JST yyyy-mm-dd hh:ii:ss○×
requestInfoリクエスト情報正常処理時のリクエスト要求に関する情報○×
queryクエリストリング受け付けたリクエスト要求のクエリストリング○×
requestTimeリクエスト受付日時JST yyyy-mm-dd hh:ii:ss○×
rowData詳細情報正常処理時のリクエスト要求に対する詳細情報○×
bearer_tokenBearerトークン認証下API接続時に必要となるトークン○×
← 商品APIリファレンス注文別レポートAPIリファレンス →