Requesting Gallery info
support, ws.webtv, api, galleries, get
GET vars specific to this request:
Var | Value | Description |
go | galleries | The API section |
do | get | The API action |
iq | Gallery ID | The Gallery ID |
Resulting Request URL:
The resulting request URL would be similar to this (don't forget to append the required info: key, timestamp, salt and signature):
https://....../api.php?go=galleries&do=get&iq={gallery_id}&{required information}
None. No POST vars are required for this request.
If the request was successful, you'll receive a response containing:
• data: The Gallery info.
• categories: The list of Categories associated with the Gallery.
• gallery_images: The Gallery images.
Example:
{ "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": "WebTV", "user_url": "http:\/\/......\/index.php\/portal\/user\/1\/webtv\/", "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" }] }
If the request failed (for example, if the Credential does not have permission to GET), you'll receive a response like the following:
{ "error" : "REQUEST_ERROR", "error_long" : "Permission error: GET" }
Possible Error Messages
Besides the general errors, this request can return the following errors:
• REQUEST_ERROR | Invalid Gallery ID:
Gallery ID is not numeric or lower than 1.
• REQUEST_ERROR | Gallery not found, inactive or restricted
Preparing GET and POST data.
// The GET vars $GET_VARS = array( "go" => "galleries", "do" => "get", "iq" => 37 ); // The POST vars $POST_VARS = array();
Generating the salt, timestamp, signature and sending the request
*** The following code block is common to all signed requests ***
// Collect the API Base URL and Credential info $API_URL = "https://www.mywebtvdomain.tv/api.php"; $API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; $API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // keep this safe!!! // Generating the salt, timestamp and validation signature $salt = md5(mt_rand()); $timestamp = time(); $signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // Append the timestamp, salt, key and signature to the GET vars $GET_VARS["timestamp"] = $timestamp; // UTC timestamp $GET_VARS["salt"] = $salt; $GET_VARS["key"] = $API_KEY_ID ; // The API Key ID: This is public and is used by the API to identify the application; $GET_VARS["signature"] = $signature; // Create the request URL. Please note that if you do not use PHP buit in function // to create the HTTP query then don't forget to URL encode the values $REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); // The previous will build an URL like .../api.php?go=api_subject&do=api_action&etc... // Create a new cURL resource and set the appropriate options $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); // If your PHP host does not have a valid SSL certificate, you will need to turn off SSL // Certificate Verification. This is dangerous (!), and should only be done temporarily // until a valid certificate has been installed 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. // Sending the request to the API $response = curl_exec($ch); // Processing the response if (!$response) { echo 'API call failed'; } else { print_r(json_decode($response,true)); }