API 共通仕様

リクエスト

API ごとにリクエスト先の URL と使用可能なメソッド、必要なリクエストパラメータが定められています。

API のうち、POST 及び PATCH メソッドを使用するものに関しては以下のリクエストヘッダの付与が必須となります。

Content-Type: application/json

リクエストボディには次の形式の JSON オブジェクトを使用します。
リクエストパラメータの文字コードには UTF-8 を、改行コードには CR+LF または LF を使用します。

{
  "key1": value1,
  "key2": value2
}

Coupon Management API のレスポンスは以下のようなHTTPレスポンスコードを返す可能性があります¹。

コード	説明
2xx	リクエストの成功。
3xx	API仕様などの変更によりリダイレクトを要求しています。リダイレクト先にアクセスして下さい。
400	不正なリクエストパラメータ、リクエストボディを指定しています。
401	認証に失敗しました。認証トークンが無効です。
404	存在しないURL、リソースにアクセスしています。
405	許可されていないメソッドを指定しています。
429	過剰なアクセスと判断されたため、リクエストが処理できませんでした。
500	Coupon Management API の問題により、リクエストを処理できませんでした。
その他	Coupon Management API の問題により、リクエストを処理できませんでした。

バリデーションエラーの場合は、http 400 にて、以下のJSONを返却します。複数のバリデーションエラーがあった場合でも、１つのみ返却します。

キー	型	必須	デフォルト	最大	説明	詳細	備考
error	文字列	o	-	-	エラーメッセージ	「エラー一覧表」を参照。	-

例

{"error": "有効期限が不正です"}

現在、503 (サービス利用不可) を返すケースは想定されていませんが、APIの負荷状況によってアクセストークンごとのリクエスト頻度制限を実装する可能性があります。 ↩