API:users > get_cvr｜INTER-STREAMサポート

ユーザー:コンテンツアクセス

users > get_cvr

ユーザーがアクセスを許可されていないコンテンツのリストをリクエストします。"CVR"はContent View Restriction=コンテンツビュー制限の略です。
ユーザーに動画、チャンネル、ギャラリーへのアクセスを許可する前に、そもそもユーザーがアクセスを許可されているかどうかを最初に確認する必要があります。このリクエストは、ユーザーがアクセスを許可されていないコンテンツを含むリストを返します。

重要
INTER-STREAM上のコンテンツ量によっては、このAPIコールによってサーバーに重負荷がかかる可能性があります。パフォーマンス向上の為にはこの結果をキャッシュし、INTER-STREAMの管理インターフェース[一般設定＞設定＞ユーザー]の「コンテンツビュー制限の更新時間」に従って更新することをお勧めします。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数	値	説明
go	users	APIセクション
do	get_cvr	APIアクション
iq	User ID	ユーザーID。公開CVRが必要な場合は、"ID=0"を指定します（ログインしていないユーザーの場合）。

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

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

POST変数

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

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・cvr：IDと紐付くユーザーがアクセスを許可されていない3つのコンテンツの配列（動画、チャンネル/ページ、ギャラリー）

{
    "cvr": {
        "clip": [68, 9, 401, 43, 8],
        "channel": [3, 41],
        "gallery": [39]
    }
}

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

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

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

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

・REQUEST_ERROR | User not found
ユーザーが見つかりません。

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

PHPサンプルコード

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

// GET変数
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "get_cvr",
					"iq"        => 3
					);

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