Wooxy API v.3.0

Get Domain

The Get Domain method allows you to obtain detailed information about a domain.

IMPORTANT Minimum one domain identification (domainId | domain) is required.

Request

POST

/v3/domain/get

IMPORTANT: Do not send more than 10 concurrent API requests.

Body Example

                                        {
  "domainId": "YOUR_REGISTERED_DOMAIN_ID",
  "domain":   "YOUR_REGISTERED_Domain_NAME"
}

Parameters

Title	Type	Default	Description
domainId optional	string		A unique domainId that is already registered in the Wooxy system.
domain optional	string		A Unique DomainName that is already registered in the Wooxy system.

Response

                                        {
      "result": true,
      "data": {
        "domainId":   "YOUR_DOMAIN_ID",
        "domain":     "YOUR_DOMAIN_NAME",
        "isTrial":  false,
        "createdAt":  "2020-10-02 12:44:03"
      },
      "errors":[]
    }

Parameters

Title	Type	Description
result	boolean	The value indicates that the domain was successfully fetched from your account: true: The domain was successfully fetched.
data	object	An array of fetched information.
data.domainId	string	Unique domain ID in the Wooxy system.
data.domain	string	Verified domain name from your Wooxy account.
data.isTrial	boolean	Indicates if the domain trial one is automatically generated during the registration procedure: true: The domain is trial; false: The domain is not a trial.
data.createdAt	string	Domain creation time in `YYYY-MM-DD h:i:s` format.

Method Errors

                                        {
    "result": false,
    "data": [],
    "errors": [
        "Error description text"
    ]
}

Error
“Minimum one unique domain identification (domainId or domain) is required.”
“Domain not found in your account or not verified”
“Invalid authorization token!”
“Internal server error”
“Bad Request”
“No matches found for access token {accessToken}”
“User {id} not enabled”
“No data found for key {userId}”
“Access token check failed for key/secret $key/$accessToken”
“Argument {argument} required”
“Argument ‘domain’ must be a non-empty string”
“Argument ‘domainId’ must be a non-empty string”

Code Examples

PHP

                $accessToken = 'YOUR_API_KEY';
$url  = 'https://api.wooxy.com/v3/domain/get';
$body = json_encode([
    'domainId' => 'YOUR_DOMAIN_ID',
    'domain'   => 'YOUR_DOMAIN_NAME',
]);
/** * Request Example   */
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_INFILESIZE, null);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [ 
    "Access-Token: $accessToken", 
    'Content-Type: application/json', 
    'Content-Length: ' . strlen($body), 
]); 
$result = curl_exec($ch); 
if ($result === false) { 
    echo 'cURL error:' . curl_error($ch) . PHP_EOL;
} else { 
     echo strval($result) . PHP_EOL; 
} 
curl_close($ch);