Control Panel — API Documentation



Cloning a playlist will copy the videos and settings to a new playlist. A new name and stream may be set at the time of cloning. Cloned playlists are set to inactive when they are created.

Example Code (PHP)

	$request = array(
		'command' => 'channel.clone',
		'timestamp' => time(),
		'cdn' => 158,
		'channel_id' => '1'
		'name' => 'My first playlist',		/*optional*/
		'app' => 'jb-chorigin', //optional
		'stream' => 'my_channel_stream_name',	/*optional*/
	    //Create request signature
    $json_request = json_encode($request);
    $sig = base64_encode(hash_hmac('sha256', $json_request,
        '8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f', true));
    $request['signature'] = $sig;
    $json_request = json_encode($request);
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, ''); // Set the URL
    curl_setopt($ch, CURLOPT_POST, true); // Perform a POST
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // If not set, curl prints output to the browser
    curl_setopt($ch, CURLOPT_HEADER, false); // If set, curl returns headers as part of the data stream
    curl_setopt($ch, CURLOPT_POSTFIELDS, array('json' => $json_request)); //'Json' string or 'PHP' serialized return
    //If your PHP host does not have a proper SSL certificate bundle, you will need to turn off SSL Certificate Verification
    //This is dangerous, and should only be done temporarily until a proper certificate bundle can be 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.
    $response = curl_exec($ch); //Execute the API Call
    if (!$response) {
        die('Failed to connect to ScaleEngine API');
    //Decode the response as an associative array 
    $arrResponse = json_decode($response, true); 
    if ($arrResponse) {
        //Operation completed successfully
        //TODO Add work here
    } else {
        //Operation failed
        echo 'An error occured processing your request:';

Request Fields

command [REQUIRED] [string] - API command to execute
cdn [REQUIRED] [int] - The ScaleEngine CDN ID of your account
api_key [REQUIRED] [string] - The API key provided as part of your account
channel_id [REQUIRED] [int] - The unique ID of the Playlist
app [OPTIONAL][string] - Application name, defaults to the app currently selected on the playlist
name [OPTIONAL] [string] - A descriptive name given to the playlist.
stream [OPTIONAL] [string] - Name of the Channel on which the playlist will be shown.
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed

Example Result (JSON)

	"message": "channel cloned",
	"status": "success",
	"channel_id" : 2,
	"handle_time":"0.3795 seconds"

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
channel_id [int] - Unique ID of the Playlist
handle_time [float] - The amount of time spent processing your request