API:store > list_subscriptions｜INTER-STREAMサポート

ストア

store > list_subscriptions

ユーザーの進行中のサブスクリプションの一覧を取得します。

注：サブスクリプションを管理（キャンセル）するには、ユーザーを「購入履歴」のページへリダイレクトする必要があります。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数	値	説明
go	store	APIセクション
do	list_subscriptions	APIアクション
iq	User ID	ユーザーID

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

https://....../api.php?go=store&do=list_subscriptions&iq={user_id}&{required information}

POST変数

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

応答例

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

content_title(string)：サブスクリプションに関連するコンテンツのタイトル
date_end(int/Unixタイムスタンプ)：サブスクリプションの終了日時
date_end_formatted_d(string)：サブスクリプションの終了日時のフォーマット値（日付）
date_end_formatted_t(string)：サブスクリプションの終了日時のフォーマット値（時刻）
id(int)：サブスクリプションID
id_product(int)：このサブスクリプションに関連する商品のID
renewable(int 0|1)：サブスクリプションが更新可能かどうか。
更新可能な場合、INTER-STREAMはユーザーに更新日に支払うように通知します。既存の定期支払いプロファイルの場合は、対応する支払いが行われたかどうかを関連する支払方法を使用して確認します。
subscription_number(string)：サブスクリプション番号

定期支払い関連データ

rp_profile_id(string)：定期支払いプロファイルのID（存在する場合）
rp_status(string)：定期支払いプロファイル（存在する場合）のステータス(blank, Active, Pending, Cancelled, Suspended, Expired, etc.)
rp_amount(decimal)：更新の際に請求される金額
rp_amount_formatted(string)：請求金額のフォーマット値
rp_currency_code(string)：通貨コード
rp_date_last_payment(int/Unixタイムスタンプ)：最後の定期支払いが行われた日時
rp_date_last_payment_formatted_d(string)：最後の定期支払いが行われた日時のフォーマット値（日付）
rp_date_last_payment_formatted_t(string)：最後の定期支払いが行われた日時のフォーマット値（時刻）
rp_date_start(int/Unixタイムスタンプ)：最初の定期支払いが行われる（または行われた）日時
rp_date_start_formatted_d(string)：最初の定期支払いが行われる（または行われた）日時のフォーマット値（日付）
rp_date_start_formatted_t(string)：最初の定期支払いが行われる（または行われた）日時のフォーマット値（時刻）
rp_id_payment_method(int)：定期支払いに使用される支払方法のID
rp_period_unit(int)：請求期間の時間単位(DAY, WEEK, MONTH, YEAR)
rp_period_amount(int)：請求期間の金額/頻度

{
	"list": [{
		"content_title": "Premium Channel",
		"date_end": "1509177992",
		"date_end_formatted_d": "28\/10\/2017",
		"date_end_formatted_t": "10:06:32 AM",
		"id": "26",
		"id_product": "6",
		"renewable": "1",
		"rp_amount": "10.00",
		"rp_amount_formatted": "10\u20ac",
		"rp_currency_code": "EUR",
		"rp_date_last_payment": "0",
		"rp_date_last_payment_formatted_d": "",
		"rp_date_last_payment_formatted_t": "",
		"rp_date_start": "1508916090",
		"rp_date_start_formatted_d": "25\/10\/2017",
		"rp_date_start_formatted_t": "09:21:30 AM",
		"rp_id_payment_method": "3",
		"rp_period_amount": "1",
		"rp_period_unit": "MONTH",
		"rp_profile_id": "MyUniqueExtAPIProfileID",
		"rp_status": "Active",
		"subscription_number": "SUBS00026"
	}]
}

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

{
    "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_subscriptions",
					"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)); 
}