API Documentation: usage.billing.live

Synopsis

The Usage Billing api retrieves the current months worth of account usage and charges. The usage returned is in Google table format with the first row being headers, and the last row showing totals. the columns returned are: usage type, usage to date, estimated price, estimated usage, and estimated price.

Example Request (JSON)

Example Code (PHP)

    $request = array(
        'command' => 'usage.billing.live',
        'api_key' => 'APX4GKLM0RKQLSP2FBO1ROPKSSW47DZE',
        'timestamp' => time(),
        'cdn' => 158,
    );
        //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

Example Result (JSON)

    {"data":{
        "cols":[
            ["string","Item"],
            ["number","Usage To Date:"],
            ["number","Estimated Price:"],
            ["number","Estimated Usage:"],
            ["number","Estimated Total:"]
            ],
        "vals":
            [["Edge Bandwidth:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["Edge Requests:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["CDN Bandwidth:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["CDN Requests:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["Origin Bandwidth:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["Origin Requests:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["VideoCDN Bandwidth:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["Storage Usage:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["SQL SELECT:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["SQL UPDATE:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["SQL OTHER:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["SQL Replication Bandwidth:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["SQL CPU Hours:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["PHP CPU Hours:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["Origin CPU Hours:",{"v":0,"f":"0 "},{"v":0,"f":"$0.00"},{"v":0,"f":"0 "},{"v":0,"f":"$0.00"}],
            ["Totals: ",{"v":0,"f":"To Date:"},{"v":0,"f":"$0.00"},{"v":0,"f":"Estimated:"},{"v":0,"f":"$0.00"}]
            ]
            },
        "status":"success",
        "message":"Found Usage Summary Data",
        "handle_time":"2.1368 seconds",
    }
    

Result Fields

message [string] - Debugging message
status [string] - "success" or "failure"
handle_time [float] - The amount of time spent processing your request
data Array - Array of cols and vals. the columns key contains the table header, while the vals key contains rows of items, usage, and prices