Control Panel — API Documentation

Updates the details of a stored PushPublish service. Depending on the type of some settings may or may not be required. All services require atleast a destination stream, service name, and push service id. For Akamai destinations the Akamai Host and Stream IDs are required. For RTMP the settings are based on what the service designates as necessary, but can include host address, port, application and instance. Transcoded streams should be group together with the adaptive_group setting designating them with the same group name. Autopush will allow stream to auto connect to the destination when it is published. Lastly, push_source will enable/disable pushing of the source stream for instances where overlays are being added to the transcoded streams.

Akamai HLS

Akamai HLS pushes require an Akamai Host and Stream ID.
To push a single stream into both Akamai's primary and backup streams, enable lock_servers and set the primary_server and backup_server properties to match.

Facebook

Facebook pushes requires a destination host url and stream.

Periscope

Requires destination host address and stream

Youtube

Requires no additional fields. Default host url: a.rtmp.youtube.com, use dst_host to change if different.

RTMP

RTMP Services will require a host address, and may also require a destination app, instance, port, username and password to connect.

Icecast

Icecast pushes require a host address, port, username, and password

Twitch

Requires no additional fields. Default host url: live.twitch.tv, use dst_host to change if different.

	$request = array(
		'command' => 'pushpublish.update',
		'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
		'timestamp' => time(),
		'cdn' => 158,
		'push_service_id' => 100,
		
		'service_name' => 'akamai',
		'dst_stream' => 'destination_stream_name',
		'adaptive_group' => 'group1', //optional
		
		/* Default Source Params */
		'app' => 'demo-origin',	//optional
		'stream' => 'livestream',	//optional
		'autopush' => true,		//optional
		
		/* Akamai Params */
		'host_id' => 'akamai_host_id', 
		'stream_id' => 'akamai_stream_id', 
		'event_name' => 'my_event', 	//optional
		'push_source' => true,		//optional
		'redundant_playlist' => 1,	//optional
		'playback_ssl' => 0,		//optional
		'addEndListOnDisconnect => false, //optional
		
		/* Advanced Settings */
		'playlist_count' => 0,		//optional
		'playlist_timeout => 120000, //optional
		'playlist_across_sessions' => 0, //optional
		'relative_playlist' => 0, 	//optional
		'bitrate_order' => 'high2low', //optional
		'send_ssl' => 1, //optional
		
		'primary_server' => 'PRI1', //optional
		'backup_server' => 'BAK1', //optional
		'lock_servers' => 1,
		
		/* RTMP Params */
		'dst_host' => 'rtmp.host.com', //do not include rtmp://
		'dst_port' => 1935,
		'dst_app' => 'destination_app',
		'dst_appinst' => 'destination_instance',
		'username' => 'rtmp_user',
		'password' => 'rtmp_pass',
	);
	    //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);
    }
    	

	{
	"message": "PushPublish services stored",
	"status": "success",
	"handle_time":"0.3795 seconds",
	"push_service_id" : 1
	}