Microsoft Word - 注文ステータス変更API仕様書（EC）_ver1.docx

Size: px

Start display at page:

Download "Microsoft Word - 注文ステータス変更API仕様書（EC）_ver1.docx"

ゆきさみおか
4 years ago
Views:

1 バリューコマースウェブサービス注ステータス変更 API リファレンス ( 広告主向け ) 第 1 版

2 概要広告主向け管理画で提供している注ステータス変更機能と同等の情報を提供する API についての仕様書ですこの API をリクエストするためには事前に広告主向けトークン取得 API にリクエストをい有効なトークンを取得している必要がありますステータス変更に関するリクエストが反映されるまで最 1 時間かかります有効期限この API のトークンの有効期限は 30 分間です期限が切れるとリクエスト時にエラーメッセージ invalid_token が返却されますのでトークン取得 API に再度リクエストをい最新のトークンを取得し指定してくださいエラーメッセージについてはレスポンスヘッダの章を参照ください利制限この API では 30 分間以内に 30 回を超える正常リクエストがなわれた場合に 30 分間ロックされますロック中のリクエスト時にはエラーメッセージ locked が返却されますので時間を置いて再度リクエストしてくださいエラーメッセージについてはレスポンスヘッダの章を参照ください

3 リクエストエンドポイント POST リクエストヘッダリクエストヘッダには下記を指定してください Authorization: Bearer [bearer_token] 1 Content-Type: application/x-www-form-urlencoded Accept: application/json リクエストボディパラメーター名説明必須許容字列許容バイト数 callback 2 コールバック関数名半英数および記号 _- 50 バイト以下注意事項 1. [bearer_token] 部分にトークン取得 API から取得した bearer_token を指定してください 2.JSONP 返却を求める場合のみ指定してください

4 ペイロードパラメーター名説明必須初期値許容字列許容バイト数 order 下記セットの配列を list キーの値とした JSON の書 null 半英ただし式で指定する別表参照数記号 list 内 JSON の中は数値字列問わずダブルクォートを必須とする JSON 書式最指定可能件数 1000 件 order フィールド覧フィールド名説明必須初期値許容字列許容バイト数指定例 id 注番号 null 指定なし 300 "id":"123" st 変更後の注ステータス null 下記半英 1 "st":"a" 下記から択指定字 ( 固定 ) a: 承認 c: 拒否 a,c 指定例 order 注 ID:123 を A に注 ID:234 を C に変更する場合 {"list":[{"id":"123","st":"a"},{"id":"234","st":"c"}]}

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 レスポンス情報正常処理時のレスポンスに関する情報 numberoftotalresult 総件数 1( 固定 ) numberofresult 取得件数 rowdata フィールド要素数 1( 固定 ) responsetime レスポンス返却時 JST yyyy-mm-dd hh:ii:ss requestinfo リクエスト情報正常処理時のリクエスト要求に関する情報 requesttime リクエスト受付時 JST yyyy-mm-dd hh:ii:ss rowdata 詳細情報正常処理時のリクエスト要求に対する詳細情報 result 受付結果 true / false リクエストが全て正常で処理を受け付けられたかどうかを返却

7 同期で処理をおこなうため true= 処理完了をすものではない

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

9 バリューコマースウェブサービス注ステータス変更 API 仕様書 ( 広告主向け ) 2017 年 6 28 著者バリューコマース株式会社 Copyright (c), ValueCommerce co., ltd.

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

Microsoft Word - アクセストークン取得API仕様書（AS）_ver1.docx バリューコマースウェブサービストークン取得 API リファレンス ( アフィリエイトサイト向け ) 第 1 版概要アフィリエイトサイト向け認証下 API にアクセスするために必要なトークンを提供するリクエストについての仕様書ですトークン発リクエストをうためには事前に管理画設定 > レポート API 認証キーの取得画にて API 認証キーを発している必要があります有効期限