channels > get | WS.WebTV API Reference | WebTV Solutions

Print

Building the Request

Request URL and GET vars

GET vars specific to this request:

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=channels&do=get&iq={channel_id}&{required information}

POST vars

The following POST vars are optional

Response Examples

If the request was successful, you'll receive a response containing:
• data: The Channel/Page info.
• playlists: [Only on Channels] The list of playlists of the Channel.
• categories: The list of Categories associated with the Channel/Page.
Example:

{
    "data": {
        "ad_policy": "0",
        "admin_template": "",
        "allow_comments": "1",
        "banner_mobile": "",
        "banner_player": "",
        "banner_sidebar": "",
        "banner_top": "",
        "date": "1348912509",
        "date_formatted": "29\/09\/2012 11:55:09 AM",
        "date_lastmod": "1426679760",
        "date_lastmod_formatted": "18\/03\/2015 12:56:00 PM",
        "description": ">p>Channel 1 description...>\/p>",
        "description_seo": "Channel 1 description...",
        "display_info": "1",
        "id": "1",
        "id_import": null,
        "id_user": "1",
        "img_bkg": "",
        "img_bkg_attachment": "scroll",
        "img_bkg_color": "#ADDCFF",
        "img_bkg_position_x": "center",
        "img_bkg_position_y": "top",
        "img_bkg_repeat": "repeat",
        "img_bkg_use": "0",
        "img_icon": "http:\/\/......\/uploads\/images\/channel_1_1348912530_icon.jpg",
        "img_poster": "http:\/\/......\/uploads\/images\/channel_1_1348912530_poster.jpg",
        "img_social": "http:\/\/......\/uploads\/images\/channel_1_1348912530_social.jpg",
        "img_thumbnail": "http:\/\/......\/uploads\/images\/channel_1_1348912530_thumb.jpg",
        "menu_group": "",
        "menu_inclusion": "main",
        "menu_position": "2",
        "page_endbody_code": "",
        "page_head_code": "",
        "privacy": "0",
        "privacy_access_level": "5",
        "socialize": "1",
        "status": "1",
        "status_moderation": "1",
        "store_on_sale": "0",
        "tags": "video, channel, 1, various",
        "template": "default",
        "title": "Video Channel 1",
        "title_url": "video-channel-1",
        "type": "0",
        "type_name": "video",
        "url": "http:\/\/......\/index.php\/channel\/1\/video-channel-1\/",
        "user_alias": "WebTV",
        "user_url": "http:\/\/......\/index.php\/portal\/user\/1\/webtv\/",
        "views_embed": "3",
        "views_embed_formatted": "3",
        "views_page": "7134",
        "views_page_formatted": "7,134"
    },
    "playlists": [{
        "clips": "6",
        "id": "36",
        "is_current": "0",
        "sorting": "0",
        "sync_time": "0",
        "time_synced": "0",
        "title": "Ch1 Monday"
    }, {
        "clips": "9",
        "id": "37",
        "is_current": "0",
        "sorting": "0",
        "sync_time": "0",
        "time_synced": "0",
        "title": "Ch1 Tuesday"
    }, {
        "clips": "27",
        "id": "43",
        "is_current": "1",
        "sorting": "0",
        "sync_time": "0",
        "time_synced": "1",
        "title": "Ch1 Wednesday"
    }],
    "categories": [{
        "id": 18,
        "title": "Pixar",
        "breadcrumb": [{
            "id": "1",
            "title": "Movies"
        }, {
            "id": "7",
            "title": "Animation"
        }, {
            "id": 18,
            "title": "Pixar"
        }]
    }, {
        "id": 1,
        "title": "Movies",
        "breadcrumb": [{
            "id": 1,
            "title": "Movies"
        }]
    }]
}

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 Channel/Page ID:
Channel/Page ID is not numeric or lower than 1.

• REQUEST_ERROR | Channel/Page not found, inactive or restricted

PHP Example Code

Preparing GET and POST data.

// The GET vars
$GET_VARS = array( 
					"go"        => "channels",
					"do"        => "get",
					"iq"        => 1
					);

// 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 salt and timestamp
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));

// Generating the validation signature
// - Default method: using base64_encode(hash_hmac(...))
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // comment this line if using the next method
// - Simplified method - available since v60: using md5(). 
//   This method requires the variable $API_SIGNATURE_GENERATION_MODE = 1; in the config/Config.inc.php file.
// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // you must "uncomment" this line when using the simplified method

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