印刷する

ストア

store > list_orders

ユーザーが発注した注文の一覧（注文履歴）を取得します。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

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

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

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

このリクエストにはPOST変数は必要ありません。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・list：注文リストを含む配列（配列は空の場合もあります）。
配列には以下が含まれます。

  • date(int/Unixタイムスタンプ)：注文日
  • date_formatted(string)：注文日のフォーマット値
  • id(int)：注文ID
  • id_currency(int)：通貨のID
  • invoice_url(string)：請求書のURL（注文に請求書が添付されている場合）
  • order_number(string)：注文番号
  • status(int)：注文のステータス(0=進行中, 1=注文済, 2=キャンセル)
  • status_payment(int)：支払状況(0=未払い, 1=支払済, 2=キャンセル)
  • status_payment_text(string)：支払状況テキスト値
  • total(decimal)：注文合計金額
  • total_formatted(string)：注文合計金額のフォーマット値
  • total_paid(decimal)：支払い合計金額
  • total_paid_formatted_t(string)：支払い合計金額のフォーマット値
{
	"list": [{
		"date": "1506765778",
		"date_formatted": "30\/09\/2017",
		"id": "322",
		"id_currency": "5",
		"invoice_url": "",
		"order_number": "ORD00322",
		"status": "1",
		"status_payment": "1",
		"status_payment_text": "Paid",
		"total": "5.50",
		"total_formatted": "5.50\u20ac",
		"total_paid": "5.50",
		"total_paid_formatted": "5.50\u20ac"
	}, {
		"date": "1502973305",
		"date_formatted": "17\/08\/2017",
		"id": "298",
		"id_currency": "5",
		"invoice_url": "",
		"order_number": "ORD00298",
		"status": "1",
		"status_payment": "1",
		"status_payment_text": "Paid",
		"total": "5.50",
		"total_formatted": "5.50\u20ac",
		"total_paid": "5.50",
		"total_paid_formatted": "5.50\u20ac"
	}]
}

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

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

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

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

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

PHPサンプルコード

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

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

// POST変数
$POST_VARS = array();

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