ストア
store > get_subscription_pre_rp_info
定期支払いプロファイルを作成するために必要な情報を取得します。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | store | APIセクション |
| do | get_subscription_pre_rp_info | APIアクション |
| iq | User ID | ユーザーID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
POST変数
以下のPOST変数は必須です。
| 変数 | 値 | 説明 |
|---|---|---|
| productID | (int) Product ID | 注文を処理する前に提供するデータ（"subscriptionID"が指定されていない場合のみ） |
| subscriptionID | (int) Subscription ID | "productID"が提供されていない場合のみ |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・data：配列には以下が含まれます。
- id_subscription(int)：サブスクリプションID（既にサブスクリプションが作成されている場合）
- subscription_number(string)：サブスクリプション番号（既にサブスクリプションが作成されている場合）
- amount(decimal)：更新ごとに請求される金額
- currency_code(string)：通貨コード
- date_first_payment(int/Unixタイムスタンプ)：最初に自動的に請求される日付
- date_first_payment_with_trial(int/Unixタイムスタンプ)：無料試用版サブスクリプションである場合、値は-1ではなく、ユーザーが最初に自動的に請求される日付に対応します。
- id_product(int)：関連商品ID
- product_sku(string)：関連商品のSKU
- period(int)：請求期間の時間単位(DAY, WEEK, MONTH, YEAR)
- period_frequency(int)：請求期間の単位数、頻度
{
"data": {
"amount": "10.00",
"currency_code": "EUR",
"date_first_payment": 1509174392,
"id_product": "6",
"id_subscription": -1,
"period": "MONTH",
"period_frequency": "1",
"product_sku": "CHNACCSUB_3",
"subscription_number": ""
}
}
リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Missing signature"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが指定されていないか無効、もしくは1未満です。
・REQUEST_ERROR | Invalid Product/Subscription ID
productIDまたはsubscriptionID、あるいはその両方が指定されていなかったか、無効であるか1未満です。
・ERROR_NO_SUBSCRIPTION | The User does not have any subscription associated with the provided subscription ID
無効なサブスクリプションIDを指定しました。
・ERROR_SUBSCRIPTION_NOT_RENEWABLE | This subscription is not renewable. It must be reactivated first
このサブスクリプションは更新できません。
・ERROR_ACTIVE_RP_PROFILE | The subscription already has an active recurring payments profile
定期購入に関連付けられている定期支払いプロファイルが既に存在します。
・ERROR_NO_PRODUCT | The associated product does not exist
無効な商品IDを指定したか、商品がもう使用出来ない可能性があります。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "store", "do" => "get_subscription_pre_rp_info", "iq" => "2" ); // POST変数 // 1. 商品IDを指定した場合 $POST_VARS = array( "productID" => 6 ); // 2. サブスクリプションIDを指定した場合 $POST_VARS = array( "subscriptionID" => 19 );
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));
}