印刷する

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

users > set_cvp

ユーザーにコンテンツへのアクセスを許可します。"CVP"はContent View Permission=コンテンツ表示権限の略です。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

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

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

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

以下のPOST変数は必須です。

変数値説明
permission (string) Permission 利用可能な値："allow", "disallow"
contentType (string) Content Type 利用可能な値："clip", "channel", "gallery"
contentID (int) Content ID 動画、チャンネル、ギャラリーのID

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・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未満かもしくは数値ではありません。

・NOT_FOUND | User not found
指定されたIDのユーザーを見つけることができませんでした。

・REQUEST_ERROR | Invalid Content ID
動画、チャンネル、ギャラリーのIDが1未満かもしくは数値ではありません。

・REQUEST_ERROR | Invalid Content Type [Must be 'clip', 'channel' or 'gallery']
予期しない値のコンテンツタイプ。

・REQUEST_ERROR | Invalid Permission [Must be disallow or allow]
"permission"の値が想定外です。

・PRIVACY | Content privacy is not set as per user
コンテンツのプライバシー設定はアクセスレベルまたは公開レベルに基づいているため、ユーザーによるコンテンツへのアクセスを許可または禁止することはできませんでした。

・NOT_FOUND | Content not found or inactive
指定されたIDのコンテンツを見つけることができませんでした。コンテンツが存在しないか、非アクティブになっている可能性があります。

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

PHPサンプルコード

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

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

// POST変数
$POST_VARS = array(
					"permission"	=> "disallow",
					"contentType"	=> "clip"",
                    "contentID"		=> 38
                    );

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