sevu.status
This API finds the status of a SEVU Ticket. This system allows you to lookup
the status of any SEVU Ticket created by your account using the SEVU Ticket
key that was returned by calling sevu.request. The ticket will show the
criteria it was created with as well as information on last used date, # of
uses remaining, and active status.
Example Code (PHP)
$request = array(
'command' => 'sevu.status',
'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
'timestamp' => time(),
'cdn' => 158,
'key' => 'mystream.53ffc996dd39d5.39102367'
);
//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 |
Key |
[REQUIRED] [string] - The SEVU ticket. This is the string
that combined with the password provided when the ticket
was created allows a user access to a protected stream.
|
Example Result (JSON)
{
"code": 2021,
"message": "ScaleEngine Virtual Usher Ticket Found",
"status": "success",
"ticket": {
"key": "mystream.53ffc996dd39d5.39102367",
"pass": "g63clVAI5wFPxY9vwVOJvw6L",
"ip": "0.0.0.0/0",
"video": "mystream",
"app": "myapp-sevu",
"created_date": "2014-08-29 00:30:14",
"used_date": "0000-00-00 00:00:00",
"uses": "5",
"active": "1"
},
"handle_time":"0.3795 seconds"
}
Result Fields
code |
[int] - API Response Code
- 2020 - ScaleEngine Virtual Usher Ticket could not be found with that key
- 2021 - ScaleEngine Virtual Usher Ticket Found
|
status |
[string] - "success" or "failure" |
message |
[string] - Debugging message |
ticket |
key |
[string] - The SEVU ticket. This is the string that
combined with the password provided when the ticket
was created allows a user access to a protected
stream. Must be included in the server URL as the
"key" parameter |
pass |
[string] - The password provided by you when you
requested the ticket. Must be included in the server
URL as the "pass" parameter |
ip |
[string] - The IP address provided in the request |
video |
[string] - The video(s) or stream(s) that this ticket
is valid for |
app |
[string] - The application(s) that this ticket is
valid for |
created_date |
[datetime] - The datetime the ticket was created |
used_date |
[datetime] - The datetime of the first time this ticket
was used by a user |
uses |
[int] - How many uses remain for this ticket, this
number is decremented each time the ticket is used |
active |
[bool] - 1 if the ticket is still active, 0 if it
has been revoked |
|
handle_time |
[float] - The amount of time spent processing your request |