Get products

Recover products matching with the following parameters

Endpoint

Method	URI	Notes
POST	https://apiv2.keliweb.it/api/v2/keliweb/get-products
POST	https://apiv2.keliweb.it/api/v2/keliweb/get-filtered-products	pid or gid required
POST	https://apiv2.keliweb.it/api/v2/keliweb/get-product-addons	pid required
POST	https://apiv2.keliweb.it/api/v2/keliweb/get-product-configoptions	pid required

Products Pids

Products Groups

Request Parameters

Parameter	Type	Description	Required
HTTP headers: Authorization	string	Bearer + the token to access APIs	Required
pid	integer	Obtain a specific product id configuration. Can be a list of ids comma separated	Optional
gid	integer	Retrieve products in a specific group id	Optional
module	string	Retrieve products utilising a specific module	Optional

Response Parameters

Parameter	Type	Description
result	string	The result of the operation: success or error
totalresults	integer	The total number of results available
startnumber	integer	The starting number for the returned results
numreturned	integer	The number of results returned
products	array	An array of products matching the criteria passed

Example Request (PHP Curl)

            

                    $curl = curl_init();
                    
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/get-products",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                        http_build_query(
                                array(
                                    'pid' => '1'
                                )
                            ),
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                      ),
                    ));
                    
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    
                    curl_close($curl);
                    
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;
                    }

            
        

Example Request (jQuery AJAX)

            
                    var form = new FormData();
                    form.append("pid", "1");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "https://apiv2.keliweb.it/api/v2/keliweb/get-products",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        },
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form
                    }

                    $.ajax(settings).done(function (response) {
                        console.log(response);
                    });
            
        

Example Response (JSON payload)

            
                    {
                        "result"                                           : "success",
                        "totalresults"                                     : "1",
                        "startnumber"                                      : "0",
                        "numreturned"                                      : "1",
                        "products[product][0][pid] "                       : "> 1",
                        "products[product][0][gid] "                       : "> 1",
                        "products[product][0][type] "                      : "> hostingaccount",
                        "products[product][0][name] "                      : "> Starter Package",
                        "products[product][0][description] "               : "> Disk Space:1GB\\r\\nBandwidth: 3GB\\r\\nEmail Accounts:5\\r\\nSubdomains:0\\r\\nDatabases:0\\r\\nAddon Domains:0",
                        "products[product][0][module] "                    : ">",
                        "products[product][0][paytype] "                   : "> recurring",
                        "products[product][0][pricing][USD][prefix] "      : "> $",
                        "products[product][0][pricing][USD][suffix] "      : ">  USD",
                        "products[product][0][pricing][USD][msetupfee] "   : "> 0.00",
                        "products[product][0][pricing][USD][qsetupfee] "   : "> 0.00",
                        "products[product][0][pricing][USD][ssetupfee] "   : "> 0.00",
                        "products[product][0][pricing][USD][asetupfee] "   : "> 0.00",
                        "products[product][0][pricing][USD][bsetupfee] "   : "> 0.00",
                        "products[product][0][pricing][USD][tsetupfee] "   : "> 0.00",
                        "products[product][0][pricing][USD][monthly] "     : "> -1.00",
                        "products[product][0][pricing][USD][quarterly] "   : "> -1.00",
                        "products[product][0][pricing][USD][semiannually] ": "> 28.95",
                        "products[product][0][pricing][USD][annually] "    : "> 49.95",
                        "products[product][0][pricing][USD][biennially] "  : "> -1.00",
                        "products[product][0][pricing][USD][triennially] " : "> -1.00",
                        "products[product][0][customfields][customfield]"  : "",
                        "products[product][0][configoptions][configoption]": ""
                    }