API Documentation: sevu.errorcount

Synopsis

This API counts the amount of times tickets have been used based on the search criteria. You can limit results by the Ticket Key, pass, application name, attempts by an ip address, or video trying to be accessed.

Example Request (JSON)

Example Code (PHP)

    $request = array(
        'command' => 'sevu.errorcount',
        'api_key' => '##API Public Key##',
        'timestamp' => time(),
        'cdn' => 158,
        'key' => 'mystream.53ffc996dd39d5.39102367',        /* optional */
        'app' => 'appname-here',                               /* optional */
        'video' => 'mystream',                              /* optional */
        'ip' => '192.168.0.0',                              /* optional */
        'pass' => 'unique_random_string_per_request',       /* optional */
        'success' => 1,                                     /* optional */
        'limit' => '25',                                    /* optional */
        'seek => '0',                                       /* optional */
    );
    
        //Create request signature
    $json_request = json_encode($request);
    $sig = base64_encode(hash_hmac('sha256', $json_request,
        '##API Secret Key##', 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
timestamp [REQUIRED] [int] - The unix timestamp of your request, used to prevent authenticated API requests from being replayed
Key [OPTIONAL] [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.
app [OPTIONAL] [string] - The ScaleEngine Application name
video [OPTIONAL] [string] - The stream name or path of the VOD video the user is restricted to. VOD examples look like like: sestore3/username/path/filename.mp4
ip [OPTIONAL][string] - The IP Address of the user that attempted to use the ticket.
pass [OPTIONAL] [string] - The randomly generated password assigned to a SEVU Ticket.
success [OPTIONAL] [int] - 1 if the ticket attempt was accepted, 0 if the ticket was rejected.
limit [OPTIONAL] [int] - Limits the number of results to be returned.
seek [OPTIONAL] [int] - Number of records to skip.
Example: Seek of 25 and Limit of 25 will return results 26-50

Example Result (JSON)

    {
    "code": 2051,
    "message": "ScaleEngine Virtual Usher unsuccessful tickets attempts found",
    "status": "success",
    "error_count" 4,
    "handle_time":"0.3795 seconds"
    }
    

Result Fields

code [int] - API Response Code
  • 2050 - ScaleEngine Virtual Usher no unsuccessful tickets attempts found
  • 2051 - ScaleEngine Virtual Usher unsuccessful tickets attempts found
message [string] - Debugging message
status [string] - "success" or "failure"
error_count [int] - Number of attempts that were found based on search criteria
handle_time [float] - The amount of time spent processing your request