API Documentation: sevu.search

Synopsis

This API allows finds SEVU Tickets based on search criteria. The system allows you to find tickets based on any number of parameters and returns all tickets that match. Search paramaters include Key, pass, ip address, video name, and application name. Results can be limited using a limit and offset.

Example Request (JSON)

Example Code (PHP)

    $request = array(
        'command' => 'sevu.search',
        '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 */
        '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 to allow access from
  • [string] - The CIDR mask of a range of IP addresses to allow access from.
    Example: 192.168.0.0/24
    Example: 0.0.0.0/0 allows any IP address
  • [string] - The literal string 'auto' or 'auto/24'. This will update the ticket the first time it is used to restrict it to the IP address of the user. This will prevent account sharing, while at the same time dealing with edge cases such as users behind corporate firewalls or proxies that may have a different IP address on the website than they will use to access the video stream
pass [OPTIONAL] [string] - The randomly generated password assigned to a SEVU Ticket.
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": 2031,
    "message": "ScaleEngine Virtual Usher Tickets Found",
    "status": "success",
    "tickets" : [{
        "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
  • 2030 - ScaleEngine Virtual Usher Ticket search results failed to find any matching tickets
  • 2031 - ScaleEngine Virtual Usher Tickets Found
status [string] - "success" or "failure"
message [string] - Debugging message
tickets [array] - SEVU Tickets matching the search parameters
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