clips > set_image_file_info

Tutorials, technical documents and downloads

API: Reference

Rev. Sep 8, 2016

Description

This API function allows you to set the image information for a Clip, in the database.
NOTES:
1. This function does not operate directly on files in the storage location; additionally it does not validae file types.
2. This function assumes that the image files are already in the storage location, according to the settings of Configuration > Storage and have the correct dimensions:
    - In the case of using local storage, the files must have been uploaded to the uploads/images folder.
    - In the case of AWS, the files must have been uploaded to the corresponding S3 bucket.
    - In the case of external server (FTP), the files must have been uploaded to the FTP location.
3. Since this API call will only associate new info in the database, it will not handle file deletion/replacement.
4. If you want to use the default images for a Clip, assign an empty string to the desired field.
5. When assigning a new image file name, the new value name will replace any previous value in the database but (due to the aforementioned facts) the previous file won't be deleted or replaced on the storage location; therefore, if you are intending to replace/delete previous files then you must do it in another procedure managed by you.

Requirements

WS.WebTV 2.0+

Required Credential Permission

MODIFY [Signed Requests Only]

Building the Request

Request URL and GET vars

GET vars specific to this request:

Var	Value	Description
go	clips	The API section
do	set_image_file_info	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_image_file_info&iq={clip_id}&{required information}

POST vars

The following POST vars are optional.

Var	Value	Description
img_poster	(string) *Poster image file name*	Name of the image file - "poster" size [+info]
img_social	(string) *Social image file name*	Name of the image file - "social" size [+info]
img_thumbnail	(string) *Thumbnail image file name*	Name of the image file - "thumbnail" size [+info]
img_icon	(string) *Icon image file name*	Name of the image file - "icon" size [+info]
sprite_img	(string) *Sprite image file name*	Name of the sprite image file [+info]
sprite_vtt	(string) *Sprite VTT image file name*	Name of the sprite VTT image file [+info]
*NOTE: Do not provide the URL to the images, only the file names.*

Response Examples

If the request was successful, you'll receive a response containing:
• ok: If the Clip was modified successfully.
Example:

{
    "ok": "The Clip image file info was correctly set"
}

If the request failed (for example, if the Clip ID is invalid), you'll receive a response like the following:

{
    "error": "CLIP_NOT_FOUND",
    "error_long": "It was not possible to find a Clip with the supplied ID"
}

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.

• MODIFICATION_ERROR | {Message}
It was not possible to modify the Clip because of the specified reason.

PHP Example Code

Preparing GET and POST data.

// The GET vars
$GET_VARS = array( 
                    "go"        => "clips",
                    "do"        => "set_image_file_info",
                    "iq"        => 700
                    );
 
// The POST vars
$POST_VARS = array(
                    "img_poster"    => "clip_700_poster.jpg",
                    "img_social"    => "clip_700_social.jpg",
                    "img_thumbnail" => "clip_700_thumbnail.jpg",
                    "img_icon"      => "clip_700_icon.jpg",
                    "sprite_img"    => "clip_700_sprite_image.jpg",
                    "sprite_vtt"    => "clip_700_sprite_vtt.vtt"
                    );

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

clips > set_image_file_info | WS.WebTV API Reference | WebTV Solutions

Professional and affordable online video solutions

API: Introduction

API: Reference

API: Reference