Control Panel — API Documentation

Please provide a valid credit card using the credit card form on the billing page. Update Card Details

Documentation

channel.updatechannelvideos

This API will update one or more playlist items associated to an existing channel. If a playlist item could not be updated a failure message will be returned and a list of all the ids that could not be updated.

Example Code (PHP)

    $request = array(
        'command' => 'channel.updatechannelvideos',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'channel_id' => 1000,
        'videos' => array(
            0 => array(
                'video_id' => 123,
                'video' => 'sestore1/username/path/play_first_updated.mp4',
                'start' => 0,
                'length' => -1,
                'sort_order' => 3
            ),
            1 => array(
                'video_id' => 124,
                'video' => 'my_livestream_2',
                'start' => 0,
                'length' => -2,
                'sort_order' => 4
            ),
        ) 
    );
        //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, 'https://api.scaleengine.net/stable/'); // 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
        print_r($arrResponse);
    } else {
        //Operation failed
        echo 'An error occured processing your request:';
        print_r($response);
    }
    	

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
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed
channel_id [REQUIRED] [int] - The unique ID of the Playlist
videos [REQUIRED] [array] - Array of Videos to be added to the playlist
[array]
video_id [REQUIRED] [int] - the unique id of the playlist item. This ID is returned from calling channel.channeldetails command
video [REQUIRED] [string] - The stream name or file path. VOD examples look like like: mp4:sestore3/username/path/filename.mp4, mp3:sestore3/username/audio/song.mp3,
start [REQUIRED] [int] - the time in seconds where the VOD file should begin. set to 0 to start at the beginning.
length [REQUIRED] [int] - the number of seconds to play of the stream or VOD file.
-1 to play to the end of a VOD file
-2 to play to the end of a live stream
sort_order [REQUIRED] [int] - the order in which the video should appear in the playlist.

Example Result (JSON)

    {
    "message": "channel Videos updated",
    "ids" :[{123}], /* on update failure */
    "status": "success",
    "handle_time":"0.3795 seconds"
    }
	

Result Fields

code [int] - API Response Code
message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
ids [array] - Array of video_ids that could not be updated. This field will only be present if a video could not be updated, and the status field will be set to "faiure"