設定
config > get
INTER-STREAMの一般的な構成と設定をリクエストします。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | config | APIセクション |
| do | get | APIアクション |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=config&do=get&{required information}
POST変数
このリクエストにはPOST変数は必要ありません。
応答例
リクエストが成功した場合のレスポンス
{
"data": {
"banner_mobile": "",
"banner_player": "",
"banner_sidebar": "",
"banner_top": "",
"base_url": "http:\/\/......",
"channel_related_videos_fetch_from": "current_playlist",
"channel_related_videos_sorting": "playlist",
"clip_related_videos_fetch_from": "categories",
"clip_related_videos_sorting": "random",
"date_format": "d\/m\/Y",
"development_mode": "0",
"external_page_link_menu_inclusion": "all",
"external_page_link_target": "_blank",
"external_page_link_title": "My site",
"external_page_link_url": "http:\/\/www.mysitelink.com\/",
"img_bkg": "",
"img_bkg_color": "#C8E3F7",
"img_bkg_use": "0",
"img_logo": "",
"img_player_logo": "http:\/\/......\/uploads\/images\/logo_player_1426842561.png",
"img_player_logo_show": "1",
"img_player_logo_url": "",
"img_social": "",
"lang_backend": "en",
"lang_frontend": "en",
"number_format_dec": "2",
"number_format_dec_point": ".",
"number_format_tho_sep": ",",
"site_description": "WebTV description",
"site_tags": "tag1, tag2, tag3",
"site_title": "WebTV Title",
"social_page_facebook": "http:\/\/www.facebook.com\/......\/",
"social_page_flickr": "",
"social_page_googleplus": "http://google.com/......",
"social_page_linkedin": "",
"social_page_tuenti": "",
"social_page_twitter": "http:\/\/twitter.com\/......\/",
"social_page_vkontakte": "",
"time_format": "h:i:s A",
"time_zone": "Europe\/Madrid"
}
}
リクエストにハッシュが指定されていない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Missing signature"
}
エラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "config", "do" => "get" ); // 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));
}