This API function allows you to associate/dissociate a Clip to/from a Category.
support, ws.webtv, api, clips, set_category_association, category
GET vars specific to this request:
Var | Value | Description |
go | clips | The API section |
do | set_category_association | The API action |
iq | Clip ID | Clip 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=clips&do=set_category_association&iq={clip_id}&{required information}
The following POST vars are required.
Var | Value | Description |
association | (string) associate | dissociate | Whether to associate or dissociate the Clip to/from a Category |
category_ids | (string) Category IDs | ID of one or more Categories (comma separated). |
If the request was successful, you'll receive a response containing:
• ok: If the Clip was associated/dissociated to/from the Category(ies).
Example:
{ "ok": "The operation was performed" }
If the request failed (for example, if the association value is invalid), you'll receive a response like the following:
{ "error": "REQUEST_ERROR", "error_long": "Invalid association" }
Possible Error Messages
Besides the general errors, this request can return the following errors:
• REQUEST_ERROR | Invalid Clip ID:
The Clip ID is not valid.
• CLIP_NOT_FOUND | It was not possible to find a Clip with the supplied ID:
The Clip was not found.
• REQUEST_ERROR | Invalid association
The value of the inclusion field is not equal to "include" or "exclude" (or the data was not provided).
• REQUEST_ERROR | Category IDs: not provided or invalid
You did not provide the Category(ies) ID(s) or the provided one(s) is/are not valid.
Preparing GET and POST data.
// The GET vars $GET_VARS = array( "go" => "clips", "do" => "set_category_association", "iq" => 700 ); // The POST vars $POST_VARS = array( "association" => "associate", "category_ids" => "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18" );
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)); }