Control Panel — API Documentation

Welcome to the new Control Panel. If you are having trouble with any functionality, or have any feedback, we would appreciate a support ticket. Additionally, you can continue to use the old control panel until it is retired in March 2019.

liveswitcher.get

This Live Switcher API retrieves the stored Lists. When provided with a 'live_switcher_id' only the requested list will be returned, otherwise when omitted all lists will be returned.

Example Request (JSON)


	

Example Code (PHP)

    $request = array(
        'command' => 'liveswitcher.get',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        'live_switcher_id' => 1, //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, '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_id [REQUIRED] [int] - The ScaleEngine CDN ID of your account
api_key [REQUIRED] [string] - The API key provided as part of your account
live_switcher_id [OPTIONAL] [int] - The ID of Live Switch List

Example Result (JSON)

    {
    "message": "Live Switch List found",
    "status": "success",
    "handle_time":"0.3795 seconds"
    "lists" : [
        {
            'live_switcher_id' : 1,
            'app' : 'jb-origin',
            'stream' : 'live_switch_stream',
            'stream_list' : ["stream1","stream2","stream3"]
        }
    ],
    }
	

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
Lists [Array] - Array of stored lists
live_switcher_id [int] - ID of the Live Switch List
app [string] - The ScaleEngine Application name
stream [string] - Stream name or VOD file path
stream_list [array] - Array of Stream Names
handle_time [float] - The amount of time spent processing your request