Microsoft Word - アクセストークン取得API仕様書（AS）_ver1.docx

Size: px

Start display at page:

Download "Microsoft Word - アクセストークン取得API仕様書（AS）_ver1.docx"

ひできかりこめ
6 years ago
Views:

1 バリューコマースウェブサービストークン取得 API リファレンス ( アフィリエイトサイト向け ) 第 1 版

2 概要アフィリエイトサイト向け認証下 API にアクセスするために必要なトークンを提供するリクエストについての仕様書ですトークン発リクエストをうためには事前に管理画設定 > レポート API 認証キーの取得画にて API 認証キーを発している必要があります有効期限この API のトークンの有効期限は 30 分間です期限が切れるとリクエスト時にエラーメッセージ invalid_token が返却されますのでトークン取得 API に再度リクエストをい最新のトークンを取得し指定してくださいエラーメッセージについてはレスポンスヘッダの章を参照ください利制限この API では 30 分間以内に 9000 回を超える正常リクエストがなわれた場合に 30 分間ロックされますロック中のリクエスト時にはエラーメッセージ locked が返却されますので時間を置いて再度リクエストしてくださいエラーメッセージについてはレスポンスヘッダの章を参照ください

3 リクエストエンドポイント GET リクエストヘッダリクエストヘッダには下記を指定してください 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')" PHP $ php -r "echo base64_encode('this_is_test_client_key_str THIS_IS_TEST_CLIENT_SECRET_STR');" Node.js $ node -e "process.stdout.write(new Buffer('THIS_IS_TEST_CLIENT_KEY_STR THIS_IS_TEST_CLIENT_SECRET_STR').toString('base64'));" Bash $ echo -n $(echo -n "THIS_IS_TEST_CLIENT_KEY_STR THIS_IS_TEST_CLIENT_SECRET_STR" base64 sed -ne 'N;s/\n//p') # or

4 $ echo -n "THIS_IS_TEST_CLIENT_KEY_STR THIS_IS_TEST_CLIENT_SECRET_STR" base64 perl -pe 's/\n//g' リクエストサンプル $ curl -H "Authorization: Bearer リクエストボディパラメーター名説明必須許容字列許容バイト数 callback 1 コールバック関数名半英数および記号 _- grant_type 要求内容 client_credentials ( 固定 ) 50 バイト以下 18 バイト ( 固定 ) 注意事項 1. JSONP 返却を求める場合のみ指定してください

5 レスポンスレスポンスヘッダエラーメッセージ error= XXX error_description= XXX の表記で発したエラーメッセージをします正常レスポンス時にはこの項は返却しません各エラーメッセージのす内容は以下の通りです error error_description HTTP STATUS CODE 意味対応要求 invalid_request Authorization request header is in invalid format (or may not be encoded). 401 Authorization ヘッダー不正指定されていない Base64 エンコードされてい Authorization ヘッダーの値成法を確認してください詳しくはリクエストヘッダの章を参照くださいない場合 invalid_credential Inactive credential value. 401 Authorization ヘッダーが正常だがアクティブ管理画で表されている CLIENT_KEY/CLIENT_SECRET を再度ご確認ください再成されなサイト署名情ている可能性があります報と紐づかない不正値 ( このエラーメッセージはトークン取得 API に限り返却します ) invalid_token The current bearer token is invalid or already expired. Please get a new one. 401 トークンが不正値または有効期限切れトークン取得 API にリクエストをい最新のトークンを取得し指定してください ( このエラーメッセージは認証下 API に限り返却します ) locked The endpoint has been locked due to the requests limit. Please try again later. 403 期間内利回数上限を超えロック中のエンドポイントに対するアクセス時間をおいて再度リクエストしてください invalid_parameters Some of request parameters are invalid. 400 いずれかのリクエストパラメーターが不正値リクエストボディの章をご確認ください

6 not_found 存在しないエンドポイントに対するアクセス server_error システムメンテナンス中リクエストされた URL をご確認ください時間をおいて再度リクエストしてくださいレスポンスボディパラメーター名説明説明詳細正常時返却異常時返却 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 詳細情報正常処理時のリクエスト要求に対する詳細情報

7 bearer_token Bearer トークン認証下 API 接続時に必要となるトークン

8 改定履歴付内容 2017 年 6 28 第 1 版発

9 バリューコマースウェブサービストークン取得 API 仕様書 ( アフィリエイトサイト向け ) 2017 年 6 28 著者バリューコマース株式会社 Copyright (c), ValueCommerce co., ltd.

はじめにインフォマート API の呼び出しには OAuth2.0 による認証を受ける必要があります OAuth2.0 を使うことでインフォマート API を利用するサービスはインフォマートプラットフォーム ID( 1 以下 PFID) とパスワードを保存したり処理したりすることなく PFID

はじめにインフォマート API の呼び出しには OAuth2.0 による認証を受ける必要があります OAuth2.0 を使うことでインフォマート API を利用するサービスはインフォマートプラットフォーム ID( 1 以下 PFID) とパスワードを保存したり処理したりすることなく PFID インフォマート API 利用における OAuth2.0 認証手順作成日 2017 年 6 月 14 日更新日 2017 年 9 月 27 日株式会社インフォマート 1 はじめにインフォマート API の呼び出しには OAuth2.0 による認証を受ける必要があります OAuth2.0 を使うことでインフォマート API を利用するサービスはインフォマートプラットフォーム ID( 1 以下