Get domains
Check all domains matching the following parameters
Endpoint
| Method | URI |
|---|---|
| POST |
https://apiv2.keliweb.it/api/v2/keliweb/get-clients-domains
|
Request Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
HTTP headers:
Authorization
|
string |
Bearer + the token to access APIs
|
Required |
limitstart
|
integer | The offset for the returned log data (default: 0) | Optional |
limitnum
|
integer | The number of records to return (default: 25) | Optional |
domainid
|
integer | The specific domain id to obtain the details for | Optional |
domain
|
string | The specific domain to obtain the details for | Optional |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
result
|
string | The result of the operation: success or error |
clientid
|
integer | The specific client id searched for |
domainid
|
integer | The specific domain id searched for |
totalresults
|
integer | The total number of results available |
startnumber
|
integer | The starting number for the returned results |
numreturned
|
integer | The total number of results returned |
domains
|
array | The domains that match 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-clients-domains",
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(
'clientid' => '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("clientid", "1");
var settings = {
"async": true,
"crossDomain": true,
"url": "https://apiv2.keliweb.it/api/v2/keliweb/get-clients-domains",
"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",
"clientid" : "1",
"domainid" : "",
"totalresults" : "2",
"startnumber" : "0",
"numreturned" : "2",
"domains[domain][0][id]" : "1",
"domains[domain][0][userid]" : "1",
"domains[domain][0][orderid]" : "1",
"domains[domain][0][regtype]" : "Register",
"domains[domain][0][domainname]" : "whmcs.rocks",
"domains[domain][0][registrar]" : "enom",
"domains[domain][0][regperiod]" : "1",
"domains[domain][0][firstpaymentamount]": "12.95",
"domains[domain][0][recurringamount]" : "12.95",
"domains[domain][0][paymentmethod]" : "authorize",
"domains[domain][0][paymentmethodname]" : "Credit Card",
"domains[domain][0][regdate]" : "2016-01-01",
"domains[domain][0][expirydate]" : "2017-01-01",
"domains[domain][0][nextduedate]" : "2016-01-01",
"domains[domain][0][status]" : "Active",
"domains[domain][0][subscriptionid]" : "",
"domains[domain][0][promoid]" : "0",
"domains[domain][0][dnsmanagement]" : "0",
"domains[domain][0][emailforwarding]" : "0",
"domains[domain][0][idprotection]" : "0",
"domains[domain][0][donotrenew]" : "0",
"domains[domain][0][notes]" : "",
"domains[domain][1][id]" : "2",
"domains[domain][1][userid]" : "1",
"domains[domain][1][orderid]" : "2",
"domains[domain][1][regtype]" : "Register",
"domains[domain][1][domainname]" : "whmcs.info",
"domains[domain][1][registrar]" : "enom",
"domains[domain][1][regperiod]" : "1",
"domains[domain][1][firstpaymentamount]": "12.95",
"domains[domain][1][recurringamount]" : "12.95",
"domains[domain][1][paymentmethod]" : "authorize",
"domains[domain][1][paymentmethodname]" : "Credit Card",
"domains[domain][1][regdate]" : "2016-01-01",
"domains[domain][1][expirydate]" : "2017-01-01",
"domains[domain][1][nextduedate]" : "2016-01-01",
"domains[domain][1][status]" : "Active",
"domains[domain][1][subscriptionid]" : "",
"domains[domain][1][promoid]" : "0",
"domains[domain][1][dnsmanagement]" : "0",
"domains[domain][1][emailforwarding]" : "0",
"domains[domain][1][idprotection]" : "0",
"domains[domain][1][donotrenew]" : "0",
"domains[domain][1][notes]" : ""
}