印刷する

ストア

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"
                    );

salt, timestamp, signatureを生成してリクエストを送信します。

?
// APIベースURLと認証情報の収集
$API_URL = "https://www.interstreamdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee";
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // 公開しないでください
 
// salt, timestamp, signatureの生成
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));
 
// key, salt, timestamp, signatureをGET変数に追加
$GET_VARS["timestamp"] = $timestamp;    // UTCタイムスタンプ
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ;      // APIキーID:これは公開されており、アプリケーションを識別するためにAPIによって使用されます
$GET_VARS["signature"] = $signature;
 
// リクエストURLを作成します。HTTPクエリを作成するためにPHPの組み込み関数を使用しない場合は、値をURLエンコードすることを忘れないでください。
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS);
// ".../api.php?go=api_subject&do=api_action&etc..."のようにURLを構築
 
// 新しいcURLリソースを作成して適切なオプションを設定
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $REQUEST_URL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS);
// PHPホストに有効なSSL証明書がない場合は、SSL証明書の検証を無効にする必要があります。これは危険であり、有効な証明書がインストールされるまで一時的に行われるべきです。
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.
 
// APIにリクエストを送信
$response = curl_exec($ch);
 
// レスポンス処理
if (!$response) {
    echo 'API call failed';
}
else
{
    print_r(json_decode($response,true));
}