動画
clips > geo_block_check
APIリクエストからIP/国コード単位での動画へのアクセスが許可されているかどうかを確認します。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
変数 | 値 | 説明 |
---|---|---|
go | clips | APIセクション |
do | geo_block_check | APIアクション |
iq | Clip ID | 動画ID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=clips&do=geo_block_check&iq={id_clip}&{required information}
POST変数
以下のPOST変数は必須です。
変数 | 値 | 説明 |
---|---|---|
ip | (string) IP Address | ユーザーのIPアドレス |
以下のPOST変数はオプションです。
変数 | 値 | 説明 |
---|---|---|
country_code | (string) Two-letter country code | 2文字のISO 3166-1国別コード 注:国コードが空欄の場合はIPから取得されます。 |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・allow:可能な値:0(IPは許可されていません), 1(IPは許可されています)
{ "allow" : 1 } |
リクエストにIPが指定されていない場合など、リクエストが失敗した場合のレスポンス
{ "error" : "REQUEST_ERROR" , "error_long" : "Invalid IP" } |
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid IP
IPが指定されていないか、無効なIPです。
・REQUEST_ERROR | Invalid Clip ID:
動画IDが1未満かもしくは数値ではありません。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array ( "go" => "clips" , "do" => "geo_block_check" , "iq" => 456 ); // POST変数 $POST_VARS = array ( "ip" => "4.4.4.4" ); |
salt, timestamp, signatureを生成してリクエストを送信します。
以下のコードブロックはすべてのハッシュつきリクエストに共通です。
// APIベースURLと認証情報の収集 $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)); } |