ストア
store > modify_cart
ショッピングカートの変更:商品の追加、削除、またはカートを空にします。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | store | APIセクション |
| do | modify_cart | APIアクション |
| iq | User ID | ユーザーID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
POST変数
以下のPOST変数は必須です。
| 変数 | 値 | 説明 |
|---|---|---|
| cartAction | (string) Operation Type | 利用可能な値:"add"(商品の追加), "remove"(商品の削除), "empty"(カートを空にする) |
| productID | (int) Product ID | "cartAction=add"または"cartAction=remove"の場合は必須です。 |
| productQty | (int) Quantity | クレジットや寄付など商品タイプで数量が必要な場合にのみ必要。デフォルト値:1 |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok
{
"ok":"Cart action was performed"
}
リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Missing signature"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが指定されていないか無効、もしくは1未満です。
・REQUEST_ERROR | Invalid cart action
アクションが指定されていないか、許可されているものと異なります。
・REQUEST_ERROR | Invalid or missing product ID
商品IDが指定されていないか無効、もしくは1未満です。
・REQUEST_ERROR | Invalid product quantity
数量が指定されていないか無効、もしくは0以下です。
・ERROR | User not found
IDに該当するユーザーが見つかりません。
・CART_ACTION_ERROR | Cant perform actions on the cart because there is acurrent order
進行中の注文がある為アクションは実行されませんでした。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "store", "do" => "modify_cart", "iq" => "2" ); // POST変数 $POST_VARS = array( "cartAction" => "add", "productID" => 79, "productQty" => 1 );
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));
}