Control Panel — API Documentation

Welcome to the new Control Panel. If you are having trouble with any functionality, or have any feedback, we would appreciate a support ticket. Additionally, you can continue to use the old control panel until it is retired in March 2019.

aws.upload

Queues a Video-On-Demand file to be uploaded to AWS S3 Storage. Requests require a valid filepath, bucket, and acl setting (private or public-read), optionally an associative array of user defined metadata for the uploaded video, and a callback url to send response data to when the queue has finished uploading the VOD to S3. If you do not wish to have a callback made set this field to an empty string "". After a VOD file has been queued an ID will be returned for you to query the status of the upload.

Example Request (JSON)


	

Example Code (PHP)

    $request = array(
        'command' => 'aws.upload',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
        "path" => "sestore{#}/jb/path/to/file.mp4",
        "destination_path" => "path/to/file.mp4",
        "metadata" => array( 'param1' => 'value1'),
        "acl" => "private",
        "bucket" => "my_bucket",
        "callback" => "www.mycallbackurl.com/",
    );
    
        //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_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
path [REQUIRED][String] - The file to be uploaded. File paths begin with an sestore{#}. To find which sestore to use call files.getstorage.
destination_path [REQUIRED][String] - The destination file path; including folders and filename.
metadata [REQUIRED][Array] - Key Value pairs of user metadata
acl [OPTIONAL][String] - Sets the visibility of the video to "private" or "public-read". Default "private".
bucket [REQUIRED][String] - AWS Bucket Name
callback [REQUIRED][String] - Callback URL to send information when upload is finished. Set to "" to bypass callback

Example Result (JSON)

    {
    "message": "Queued file for upload",
    "status": "success",
    "data": 1
    }
	

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
data [int] - Upload request ID. Use this id to call aws.status for status updates. Returns 0 if there was an error.