Control Panel — API Documentation
Please provide a valid credit card using the credit card form on
the billing page.
Update Card Details
switchboard.get
Retrieves switchboard details for:
- The given switchboard ID
- The switchboards of a ScaleEngine app, when the 'app' field is provided
- All switchboards when no ID or app name is provided
Example Code (PHP)
$request = array(
'command' => 'switchboard.get',
'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
'timestamp' => time(),
'cdn' => 158,
'switchboard_id' => 1, //optional
'app' => 'demo-origin', //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 |
[REQUIRED] [int] - The ScaleEngine CDN ID of your
account |
api_key |
[REQUIRED] [string] - The API key provided as part of your
account |
switchboard_id |
[OPTIONAL] [int] - The ID of Switchboard |
app |
[OPTIONAL] [string] - The ScaleEngine Application name |
Example Result (JSON)
{
"message": "Switchboard List found",
"status": "success",
"handle_time":"0.3795 seconds"
"lists" : [
{
'switchboard_id' : 1,
'app' : 'demo-origin',
'stream' : 'switchboard_stream',
'stream_list' : ["stream1","stream2","stream3"]
}
],
}
Result Fields
message |
[string] - Debugging message |
status |
[string] - "success" or "failure" |
Lists |
[Array] - Array of stored lists
switchboard_id |
[int] - ID of the Switchboard |
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 |