ユーザー:投票
users > set_content_vote
動画への投票内容(高評価/低評価)を設定もしくは変更します。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
変数 | 値 | 説明 |
---|---|---|
go | users | APIセクション |
do | set_content_vote | APIアクション |
iq | User ID | ユーザーID 匿名投票の場合は"0"を入力してください。 |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=set_content_vote&iq={user_id}&{required information}
POST変数
以下のPOST変数は必須です。
変数 | 値 | 説明 |
---|---|---|
contentID | (int) Clip ID | 投票に関連付ける動画のID。 |
vote | (string) like | dislike | 「高評価」または「低評価」 |
ip | (string) User IP | (GET変数が"iq=0"の場合のみ)匿名投票(未登録ユーザー)の場合は、ユーザーIPを入力する必要があります。 |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok:投票が正しく設定/変更された場合
{ "ok": "Vote was registered" }
再度同じ投票を設定しようとした場合など、リクエストが失敗した場合のレスポンス
{ "error": "VOTING_ERROR", "error_long": "VOTED_ALREADY" }
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | Invalid Content ID
コンテンツIDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | Invalid Vote [Must be 'like' or 'dislike']
投票が指定されていないか無効です。
・VOTING_ERROR | VOTED_ALREADY
再度同じ投票を設定しようとしています。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "users", "do" => "set_content_vote", "iq" => 13 ); // POST変数 $POST_VARS = array( "contentID" => 2635, "vote" => "like" );
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)); }