Questa chiamata consente di interrogare il sistema per ottenere la disponibilità di un determinato dominio. Il fatto che un dominio è disponibile significa che è libero per la registrazione.
Parametri della richiesta
Parametro | Tipo | Descrizione |
|---|---|---|
domain | stringa | Il nome del dominio da controllare |
Parametri della risposta
Parametro | Tipo | Descrizione |
|---|---|---|
result | stringa | Il risultato dell’operazione: success o error |
domain | stringa | Il dominio che siamo controllando |
status | json | Lo stato del dominio: available o unavailable |
whois | stringa/null | null se il dominio è libero, una stringa di testo contenente le informazioni del WHOIS se il dominio è già registrato |
Esempio di richiesta (PHP cUrl)
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://my.supporthost.com/domainapi.php/domain/availability?domain=ivanmessina.it',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'X-Email: your_email',
'X-Api-Key: your_apikey'
),
));
$response = curl_exec($curl);
curl_close($curl);Esempio di risposta (JSON)
{
"result": "success",
"domain": "dominiolibero.it",
"status": "available",
"whois": null
}Risposte di errore
- Connection refused from unauthorized host. IP xxx.xxx.xxx.xxx is NOT allowed to access your account
- Invalid email or not a reseller.
- Invalid API key.
- The domain field is required.
