Downloads: Clear Download Queue

As downloads are requested they are kept track of inside of the POOL Download Queue. This API call will empty the download queue and return the successful or unsuccessful result of the action.

Clear Download Queue Specification

Parameters: Header variables:
  1. userid: integer
  2. token: string
Data list returned:

Clear Download Queue Workflow

  1. URL: https://api.promoonly.com/download/clear_queue
  2. Header: Authorization: Bearer Base64(userid:token)
  3. Method: GET
  4. Returned: JSON

    Example JSON Output:

    {
        "result": "success"
    }

Examples

  1. PHP (using cURL):

    <?php
        $userid = 1;
        $token = "8b26e1e4f3f5e00a888807e605565c47";
        $clearqueue_url = "https://api.promoonly.com/download/clear_queue";

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $clearqueue_url);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer ".base64_encode($userid.":".$token)));
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        $clearqueue_result = curl_exec($ch);
        curl_close($ch);

        $sync_obj = json_decode($clearqueue_result);
    ?>
  2. Javascript (using jQuery):

    function b64EncodeUnicode(str)
    {
        return btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g,
            function toSolidBytes(match, p1)
            {
                return String.fromCharCode('0x' + p1);
            }));
    }

    var userid = 1;
    var token = "8b26e1e4f3f5e00a888807e605565c47";
    var auth_str = "Bearer " + b64EncodeUnicode(userid + ":" + token);

    $.ajax({
        type: "GET",
        url: "https://api.promoonly.com/download/clear_queue",
        headers: { "Authorization": auth_str },
        dataType: "json",
        success: function (data)
        {
            console.log(data);
        }
    });
  3. Python (using requests):

    #!/usr/bin/env python

    import requests
    import base64
    import urllib

    userid = 1
    token = "8b26e1e4f3f5e00a888807e605565c47"

    b64_key = base64.b64encode("%s:%s" % (userid, token))
    headers = {"Authorization": "Bearer %s" % b64_key}
    clearqueue_url = "https://api.promoonly.com/download/clear_queue"
    result_return = requests.get(clearqueue_url, headers=headers)

    print(result_return.text)