Domains : availability

Aangemaakt : 01-11-2023
Laatste update: -

Omschrijving

Controleer de beschikbaarheid van één of meerdere domeinnamen

Endpoint

POST https://api.mijndomeinreseller.nl/v2/domain-availability

Parameters

Parameter	Datatype	Verplicht	Omschrijving
domain_names	Array	Ja	Array met de te controleren domeinnamen
idn_language	String	Nee	De taal van de IDN domeinnaam, enkel verplicht voor IDN domeinnamen

Antwoord

HTTP status code: 200 Ok

Parameter	Type	Omschrijving
Array: data[] met object:
domain_name	String	De gecontroleerde domeinnaam
status	String	De beschikbaarheids-status van de domeinnaam: free De domeinnaam is vrij en kan geregistreerd worden registered De domeinnaam is reeds geregistreerd reserved De domeinnaam is door de registry gereserveerd en kan niet op normale wijze geregistreerd. Neem contact op met de helpdesk voor meer informatie error Het was niet mogelijk om de beschikbaarheid te controleren, probeer het opnieuw
location	String	De locatie van de domeinnaam, deze parameter wordt alleen getoond bij de status registered: inyouraccount De domeinnaam is al in jouw eigen account geregistreerd inotheraccount De domeinnaam is al bij MijnDomeinReseller ondergebracht maar bij een andere klant. Je kunt de domeinnaam verhuizen via een push. external De domeinnaam is niet bij MijnDomeinReseller geregistreerd, je kunt de domeinnaam op normale wijze verhuizen.
premium_domain	Boolean	Of het een premium domeinnaam betreft
premium_price	Array	Array met objecten m.b.t. de premium prijs: type: type van de prijs: registration, transfer of renew currency: munteenheid van de prijs price: prijs Deze parameter wordt alleen getoond indien het een premium domeinnaam betreft

Voorbeeld

Beschrijving:
Controleer de beschikbaarheid voor meerdere domeinnamen

PHP
cURL

Opdracht in PHP:

<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/domain-availability";
$api_host = $env === "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$a_data = [ "domain_names" => ["somefreedomain.com","someregistereddomain.com","somepremiumdomain.blog"]];

$json_data = json_encode($a_data);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data );
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key","Content-Type: application/json"));
$output = curl_exec($ch);

if(curl_getinfo($ch, CURLINFO_HTTP_CODE) === 200) {
  $data = json_decode($output);

  foreach($data->data as $domain) {
    echo "Domain: " . $domain->domain_name . "<br>";
    echo "Status: " . $domain->status . "<br>";

    if($domain->status === "registered") {
      echo "Location: " . $domain->location . "<br>";
    }

    if($domain->premium_domain === true) {
      echo "Premium: yes<br>";
      foreach($domain->premium_price as $type=>$price) {
        echo "Price $type: ". $price->currency . " " . $price->price . "<br>";
      }
    }
    else {
      echo "Premium: no<br>";
    }

    echo "<br>";
  }
}

curl_close($ch);

Opdracht in cURL:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-d '{"domain_names":["somefreedomain.com","someregistereddomain.com","somepremiumdomain.blog"]}' \
https://api-test.mijndomeinreseller.nl/v2/domain-availability

Antwoord:

HTTP/1.1 200 Ok
Content-Type: application/json;charset=utf-8

{
  "data": [
    {
      "domain_name": "somefreedomain.com",
      "status": "free",
      "premium_domain": false,
    },
    {
      "domain_name": "someregistereddomain.com",
      "status": "registered",
      "location": "external",
      "premium_domain": false,
    },
    {
      "domain_name": "somepremiumdomain.blog",
      "status": "free",
      "premium_domain": true,
      "premium_price": {
        "register": {
          "currency": "USD",
	  "price": 123.45
        },
        "renew": {
          "currency": "USD",
	  "price": 123.45
        }
      }
    },
  ]
}