ギャラリー
galleries > get
ギャラリー情報をリクエストします。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | galleries | APIセクション |
| do | get | APIアクション |
| iq | Gallery ID | ギャラリーID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=galleries&do=get&iq={gallery_id}&{required information}
POST変数
このリクエストにはPOST変数は必要ありません。
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・data：ギャラリー情報
・categories：ギャラリーに関連付けられているカテゴリーのリスト。
・gallery_images：ギャラリーイメージ
{
"data": {
"allow_comments": "1",
"date": "1394707840",
"date_formatted": "13\/03\/2014 11:50:40 AM",
"date_lastmod": "1426932169",
"date_lastmod_formatted": "21\/03\/2015 11:02:49 AM",
"description": "The gallery description",
"description_seo": "The gallery description",
"id": "37",
"id_channel": null,
"id_news": null,
"id_user": "1",
"img_icon": "http:\/\/......\/uploads\/images\/gallery_37_1382608290_icon.jpg",
"img_poster": "http:\/\/......\/uploads\/images\/gallery_37_1382608290_poster.jpg",
"img_social": "http:\/\/......\/uploads\/images\/gallery_37_1382608290_social.jpg",
"img_thumbnail": "http:\/\/......\/uploads\/images\/gallery_37_1382608290_thumb.jpg",
"is_featured": "0",
"privacy": "0",
"privacy_access_level": "99",
"socialize": "1",
"status": "1",
"tags": "tag1, tag2",
"title": "My Gallery",
"title_url": "my-gallery",
"url": "http:\/\/......\/index.php\/gallery\/37\/my-galley\/",
"user_alias": "InterStream",
"user_url": "http:\/\/......\/index.php\/portal\/user\/1\/inter-stream\/",
"views_page": "101",
"views_page_formatted": "101"
},
"categories": [{
"id": 1,
"title": "Movies",
"breadcrumb": [{
"id": 1,
"title": "Movies"
}]
}, {
"id": 18,
"title": "Animation",
"breadcrumb": [{
"id": "1",
"title": "Movies"
}, {
"id": "18",
"title": "Animation"
}]
}],
"gallery_images": [{
"date": "1382608240",
"date_formatted": "24\/10\/2013 11:50:40 AM",
"date_lastmod": "1426932169",
"date_lastmod_formatted": "21\/03\/2015 11:02:49 AM",
"description": "",
"id": "34",
"id_gallery": "37",
"img_icon": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_34_1383812218_icon.jpg",
"img_large": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_34_1383812218_large.jpg",
"img_thumbnail": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_34_1383812218_thumb.jpg",
"title": "Image 1"
}, {
"date": "1382608240",
"date_formatted": "24\/10\/2013 11:50:40 AM",
"date_lastmod": "1426932169",
"date_lastmod_formatted": "21\/03\/2015 11:02:49 AM",
"description": "",
"id": "35",
"id_gallery": "37",
"img_icon": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_35_1385451866_icon.jpg",
"img_large": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_35_1385451866_large.jpg",
"img_thumbnail": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_35_1385451866_thumb.jpg",
"title": "Image 2"
}, {
"date": "1382608240",
"date_formatted": "24\/10\/2013 11:50:40 AM",
"date_lastmod": "1426932169",
"date_lastmod_formatted": "21\/03\/2015 11:02:49 AM",
"description": "",
"id": "36",
"id_gallery": "37",
"img_icon": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_36_1385451867_icon.jpg",
"img_large": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_36_1385451867_large.jpg",
"img_thumbnail": "http:\/\/......\/uploads\/images\/galleries\/gallery_37_image_36_1385451867_thumb.jpg",
"title": "Image 3"
}]
}
認証情報にGETの許可がない場合など、リクエストが失敗した場合のレスポンス
{
"error" : "REQUEST_ERROR",
"error_long" : "Permission error: GET"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid Gallery ID
ギャラリーIDが1未満かもしくは数値ではありません。
・REQUEST_ERROR | Gallery not found, inactive or restricted
ギャラリーが見つからない、非アクティブ、もしくは公開制限されています。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "galleries", "do" => "get", "iq" => 37 ); // 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));
}