印刷する

ストア

store > add_subtract_credit

ユーザーに対してクレジットの追加または削除をおこないます。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gostoreAPIセクション
doadd_subtract_creditAPIアクション
iqUser IDユーザーID

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=store&do=add_subtract_credit&iq={user_id}&{required information}
POST変数

以下のPOST変数は必須です。

変数値説明
creditAction (string) Operation Type 利用可能な値："add", "subtract"
amount (decimal) Amount ユーザーのクレジットに加算または減算される金額

以下のPOST変数はオプションです。

変数値説明
description (string) Description クレジットが加算または減算された理由など取引の説明

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok

{
    "ok":"Credit action was performed"
}

リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス

{
    "error"      : "REQUEST_ERROR",
    "error_long" : "Missing signature"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。

・REQUEST_ERROR | Invalid credit action
creditAction値が指定されていないか、"add"または"subtract"と異なります。

・REQUEST_ERROR | Invalid amount
金額が指定されていないか0以下です。

・ERROR_CANT_SUBTRACT | Can't subtract credit because the user does not have any available
利用可能なユーザークレジットはすでに0なので、金額を差し引くことはできません。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "store",
					"do"        => "add_subtract_credit",
					"iq"        => "2"
					);

// POST変数
$POST_VARS = array( 
					"creditAction"  => "add",
					"amount"        => 5.00,
					"description"   => "Coupon XJW5P redeem"
					);