印刷する

動画

clips > get

動画或いは広告情報ををリクエストします。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
goclipsAPIセクション
dogetAPIアクション
iqClip ID動画もしくは広告のID

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

https://....../api.php?go=clips&do=get&iq={clip_id}&{required information}
POST変数

以下のPOST変数はオプションです。

変数値説明
generateEmbedCode (int) 0|1 "1"の場合、対応する埋め込みコードが生成されます。
embedWidth (int) width 埋め込みコードの幅(px)
embedHeight (int) height 埋め込みコードの高さ(px)
embedURLVars (string) "&var1=value1..." 埋め込みコードの動画プレーヤーURL変数。
可能なURL変数はこちらでご確認ください。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・data：動画情報
・media：動画に関連付けられているメディアファイルのリスト
・media_mbr：動画に関連付けられているマルチビットレートURL(Flash/F4M, HTML5/DASH)
・subtitles：字幕のリスト
・interactivities：インタラクティビティのリスト
・channels：クリップに関連付けられているチャンネルのリスト
・categories：クリップに関連付けられているカテゴリーのリスト

{
    "data": {
        "ad_is_channel_mid_roll": "0",
        "ad_is_channel_pre_roll": "0",
        "ad_is_clip_pre_roll": "0",
        "ad_link": "",
        "ad_policy": "0",
        "admin_template": "",
        "allow_comments": "1",
        "aspect": "1.78",
        "clicks": "0",
        "date": "1381911153",
        "date_formatted": "16\/10\/2013 10:12:33 AM",
        "date_lastmod": "1423210557",
        "date_lastmod_formatted": "06\/02\/2015 09:15:57 AM",
        "description": "<p>Clip description<\/p>",
        "description_seo": "Clip description",
        "dislikes": "1",
        "dislikes_formatted": "1",
        "downloadable": "0",
        "downloadable_condition": "0",
        "downloadable_xfiles": "",
        "duration": "8",
        "duration_formatted": "00:08",
        "id": "45",
        "id_imdb": "",
        "id_import": "",
        "id_user": "1",
        "img_icon": "http:\/\/......\/uploads\/images\/clip_45_1390047394_icon.jpg",
        "img_poster": "http:\/\/......\/uploads\/images\/clip_45_1390047394_poster.jpg",
        "img_social": "http:\/\/......\/uploads\/images\/clip_45_1390047394_social.jpg",
        "img_thumbnail": "http:\/\/......\/uploads\/images\/clip_45_1390047394_thumb.jpg",
        "interactivity_randomization": "0",
        "interactivity_spacing": "1",
        "interactivity_start_delay": "1",
        "interactivity_timing": "0",
        "is_3d": "0",
        "is_360": "0",
        "is_ad": "0",
        "is_featured": "1",
        "is_indexable": "1",
        "is_searchable": "1",
        "is_skippable": "1",
        "is_skippable_after": "0",
        "is_visitable": "1",
        "likes": "1",
        "likes_formatted": "1",
        "privacy": "0",
        "privacy_access_level": "99",
        "socialize": "1",
        "sprite_img": "http:\/\/......\/uploads\/images\/clip_45_1390926596_sprite.jpg",
        "sprite_vtt": "http:\/\/......\/uploads\/images\/clip_45_1390926596_sprite.vtt",
        "status": "1",
        "status_moderation": "1",
        "store_on_sale": "0",
        "store_play_trailer": "1",
        "tags": "tag1, tag2, tag3, tag4",
        "title": "This is a sample Clip",
        "title_url": "this-is-a-sample-clip",
        "type": "1",
        "type_name": "streamclip_vod",
        "url": "http:\/\/......\/index.php\/video\/45\/ws-interstreamm\/",
        "user_alias": "InterStream",
        "user_url": "http:\/\/......\/index.php\/portal\/user\/1\/inter-stream\/",
        "views": "346",
        "views_complete": "42",
        "views_complete_formatted": "42",
        "views_embed": "7",
        "views_embed_formatted": "7",
        "views_formatted": "346",
        "views_page": "206",
        "views_page_formatted": "206"
    },
    "media": {
        "0": {
            "id": "4843",
            "id_quality": "2",
            "vod_flash": "http:\/\/......\/uploads\/movies\/myvideo-hq.mp4",
            "vod_html5_h264": "http:\/\/......\/uploads\/movies\/myvideo-hq.mp4",
            "vod_html5_webm": "",
            "live_flash": "",
            "live_ios": "",
            "live_rtsp": "",
            "live_ms": "",
            "embed_flash": "",
            "embed_html5": "",
            "vod_flash_trailer": "",
            "vod_html5_h264_trailer": "",
            "vod_html5_webm_trailer": ""
        },
        "1": {
            "id": "4844",
            "id_quality": "3",
            "vod_flash": "http:\/\/......\/uploads\/movies\/myvideo-normal.mp4",
            "vod_html5_h264": "http:\/\/......\/uploads\/movies\/myvideo-normal.mp4",
            "vod_html5_webm": "",
            "live_flash": "",
            "live_ios": "",
            "live_rtsp": "",
            "live_ms": "",
            "embed_flash": "",
            "embed_html5": "",
            "vod_flash_trailer": "",
            "vod_html5_h264_trailer": "",
            "vod_html5_webm_trailer": ""
        },
        "2": {
            "id": "4845",
            "id_quality": "1",
            "vod_flash": "",
            "vod_html5_h264": "",
            "vod_html5_webm": "",
            "live_flash": "",
            "live_ios": "",
            "live_rtsp": "",
            "live_ms": "",
            "embed_flash": "",
            "embed_html5": "",
            "vod_flash_trailer": "http:\/\/......\/uploads\/movies\/myvideo-low.mp4",
            "vod_html5_h264_trailer": "http:\/\/......\/uploads\/movies\/myvideo-low.mp4",
            "vod_html5_webm_trailer": ""
        }
    },
    "media_mbr": {
        "flash": "http://../f4m_manifest.f4m",
        "html5": "http://../dash_manifest.mpd"
    },
    "subtitles": [],
    "interactivities": {
        "settings": {
            "timing": "absolute",
            "start_delay": -1,
            "spacing": -1,
            "randomize": -1
        },
        "list": [
            {
                "clicks": "18",
                "closable": "1",
                "content": "http://pubads.g.doubleclick.net/....&LR_SCHEMA=vast2",
                "contentType": "vast",
                "duration": -1,
                "end": "8",
                "height": "0",
                "id": "141",
                "link": "",
                "relative_position": -1,
                "start": "5",
                "views": "529",
                "width": "0"
            },
            {
                "clicks": "1",
                "closable": "0",
                "content": "Click for more info here!",
                "contentType": "text",
                "duration": -1,
                "end": "4",
                "height": "0",
                "id": "142",
                "link": "http://interactivity_link/",
                "relative_position": -1,
                "start": "1",
                "views": "381",
                "width": "0"
            }
        ]
    },
    "channels": [{
        "id": "1",
        "title": "Video Channel 1"
    }],
    "categories": [{
        "id": 7,
        "title": "Animation",
        "breadcrumb": [{
            "id": "1",
            "title": "Movies"
        }, {
            "id": 7,
            "title": "Animation"
        }]
    }]
}

認証情報にGETの許可がない場合など、リクエストが失敗した場合のレスポンス

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Permission error: GET"
}

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

・REQUEST_ERROR | Invalid Clip ID
動画IDが1未満かもしくは数値ではありません。

・REQUEST_ERROR | Clip not found, inactive or restricted
動画が見つからない、非アクティブ、もしくは公開制限されています。

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

PHPサンプルコード

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

// GET変数
$GET_VARS = array( 
					"go"        => "clips",
					"do"        => "get",
					"iq"        => 45
					);

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