Hoe gebruik je de Hoasted API in de klantenomgeving

Met de Hoasted klantenomgeving API kun je domeinen automatisch registreren, beheren en verlengen vanuit je eigen systemen, zoals WHMCS of HostFact. Dit voorkomt handmatig werk en maakt het mogelijk om je domeinbeheer volledig te automatiseren.

Deze API is bedoeld voor resellers, developers en agencies die domeinen willen koppelen aan hun eigen workflows of systemen.

Wat kun je met deze API?

Met deze API kun je onder andere:

• Domeinnamen registreren
• Domeinen verhuizen (transfers)
• Domeinen verlengen
• Beschikbaarheid van domeinen controleren
• Domeingegevens ophalen en beheren

Gebruik deze API als je domeinbeheer wilt integreren in je eigen platform of bestaande tools zoals WHMCS of HostFact.

API gegevens ophalen

Om gebruik te maken van de API heb je een API key en token nodig. Deze kun je eenvoudig ophalen via je klantenomgeving:

1. Log in op je Hoasted klantenaccount
2. Klik rechtsboven op je profiel
3. Ga naar API settings

4. Klik op show om je API key en token te bekijken

   

   Gebruik deze gegevens om authenticatie in te stellen in je applicatie of koppeling.

Authenticatie

De API maakt gebruik van een API key en token voor authenticatie. Deze gegevens moeten worden meegestuurd bij iedere request.

Zorg ervoor dat:

• Je API gegevens veilig worden opgeslagen
• Je deze nooit deelt met derden
• Je ze niet in publieke code repositories plaatst

Integratie met WHMCS en HostFact

Gebruik je WHMCS of HostFact? Dan kun je deze API direct inzetten voor automatische domeinregistraties.

• WHMCS: gebruik de Hoasted module of stel een custom registrar module in
• HostFact: configureer de koppeling met je API gegevens

Heb je nog geen koppeling? Neem contact op met support voor hulp bij de setup.

Direct gebruik (developers)

Werk je met een eigen systeem of maatwerk oplossing? Dan kun je de API direct aanroepen vanuit je applicatie.

Zorg ervoor dat je:

• De juiste endpoints gebruikt
• Authenticatie correct implementeert
• Responses goed verwerkt binnen je applicatie

In de volgende sectie vind je het API endpoint en voorbeeldgebruik.

API Endpoint:

POST https://www.hoasted.com/cp/domainsResellerAPI/api-router.php

Alle verzoeken worden als POST        verstuurd met Content-Type: application/x-www-form-urlencoded       . Alle antwoorden worden als JSON geretourneerd.

Authenticatie

Elk API-verzoek vereist de volgende parameters:

Je API-sleutel en e-mailadres ontvang je bij het aanmaken van je reseller-account.

Voorbeeld authenticatie met cURL:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=jouw@email.nl&token=JOUW_API_SLEUTEL&action=getDomainList'

Foutmelding bij ongeldige inloggegevens:

{"success": false, "message": "API credentials not correct"}

Beschikbare acties

Hieronder vind je een overzicht van alle beschikbare API-acties.

Acties - Gedetailleerde beschrijving

whois - Beschikbaarheid controleren

Controleer of een domeinnaam beschikbaar is voor registratie.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=whois&domain=mijnbedrijf&extension=nl'

Antwoord (beschikbaar):

{"success": true, "message": "Domain available", "available": true}

Antwoord (niet beschikbaar):

{"success": true, "message": "Domain not available", "available": false}

getOwner - Contactgegevens ophalen via handle

Haal de contactgegevens van een domein op aan de hand van een handle-code.

Parameters:

Handleprefixen:

• HO-         = Eigenaar/Registrant
• HA-         = Administratief contact
• HT-         = Technisch contact

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=getOwner&handle=HO-123'

Antwoord:

{
  "result": "success",
  "domain": {
    "Domain": "voorbeeld.nl",
    "Information": {
      "domainid": 123,
      "contacts": [
        {
          "Handle": "HO-123",
          "CompanyName": "Bedrijfsnaam B.V.",
          "Initials": "Jan",
          "SurName": "Jansen",
          "Address": "Voorbeeldstraat 1",
          "ZipCode": "1234 AB",
          "City": "Amsterdam",
          "State": "NH",
          "Country": "NL",
          "PhoneNumber": "+31.201234567",
          "EmailAddress": "jan@voorbeeld.nl",
          "type": "registrant"
        }
      ]
    },
    "Status": "success"
  }
}

getDomainList - Alle domeinen ophalen

Haal een lijst op van al je actieve domeinen, inclusief nameservers, verval- en registratiedatum, EPP-code en contactgegevens.

Parameters:

Performance tip: Als je alleen een overzicht nodig hebt van je domeinen met nameservers en datums, gebruik dan include_epp=0&include_whois=0&include_ns=0        . Dit is aanzienlijk sneller, vooral bij veel domeinen.

Let op: laat je include_epp op 1 staan, dan worden bij onder meer .be -domeinen e-mails met de verhuiscode verstuurd. Heb je de EPP-code niet nodig? Gebruik dan include_epp=0 .

Voorbeeld (snelle modus):

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=getDomainList&include_epp=0&include_whois=0&include_ns=0'

Voorbeeld (alle gegevens):

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=getDomainList'

Antwoord:

{
  "result": "success",
  "domains": [
    {
      "Domain": "voorbeeld.nl",
      "Information": {
        "nameservers": ["ns1.hoasted.com", "ns2.hoasted.com"],
        "expiration_date": "2027-01-15",
        "auto_renew": true,
        "regdate": "2020-01-15",
        "authkey": "dZk8Lp3x",
        "domainid": 123,
        "contacts": [
          {
            "Handle": "HO-123",
            "CompanyName": "Bedrijfsnaam B.V.",
            "Initials": "Jan",
            "SurName": "Jansen",
            "Address": "Voorbeeldstraat 1",
            "ZipCode": "1234 AB",
            "City": "Amsterdam",
            "State": "NH",
            "Country": "NL",
            "PhoneNumber": "+31.201234567",
            "EmailAddress": "jan@voorbeeld.nl",
            "type": "registrant"
          }
        ]
      },
      "Status": "success"
    }
  ]
}

Bij include_epp=0         is authkey         altijd ""        .

Bij include_whois=0         is contacts         altijd []        .

Bij include_ns=0        is nameservers        altijd []       .

getDomainInformation - Domeingegevens ophalen

Haal gedetailleerde informatie op van één specifiek domein, inclusief nameservers, EPP-code en contactgegevens.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=getDomainInformation&domain=voorbeeld.nl'

Antwoord:

{
  "result": "success",
  "domain": {
    "Domain": "voorbeeld.nl",
    "Information": {
      "nameservers": ["ns1.hoasted.com", "ns2.hoasted.com"],
      "expiration_date": "2027-01-15",
      "auto_renew": true,
      "regdate": "2020-01-15",
      "authkey": "dZk8Lp3x",
      "domainid": 123,
      "contacts": [...]
    },
    "Status": "success"
  }
}

getContactList - Alle contacten ophalen

Haal de WHOIS-contactgegevens op van al je actieve domeinen.

Parameters: Geen extra parameters vereist (alleen authenticatie).

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=getContactList'

Antwoord:

{
  "result": "success",
  "contacts": [
    {
      "Handle": "HO-123",
      "CompanyName": "Bedrijfsnaam B.V.",
      "Initials": "Jan",
      "SurName": "Jansen",
      "Address": "Voorbeeldstraat 1",
      "ZipCode": "1234 AB",
      "City": "Amsterdam",
      "State": "NH",
      "Country": "NL",
      "PhoneNumber": "+31.201234567",
      "EmailAddress": "jan@voorbeeld.nl"
    }
  ]
}

convertPhone - Telefoonnummer converteren

Converteer een telefoonnummer naar het internationale formaat (+landcode.nummer        ).

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=convertPhone&phone=0612345678'

Antwoord:

{"result": "success", "phone": "+31.612345678"}

saveContactDetails - Contactgegevens bijwerken

Werk de WHOIS-contactgegevens (eigenaar, admin, technisch contact) bij voor een specifiek domein.

Parameters:

Contactgegevens velden (per contacttype):

Gebruik de volgende prefixen voor elk contacttype:

Beschikbare velden per contact:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=saveContactDetails&domain=voorbeeld.nl&sld=voorbeeld&tld=nl&contactdetails[ownerInitials]=Jan&contactdetails[ownerSurName]=Jansen&contactdetails[ownerCompanyName]=Bedrijf+B.V.&contactdetails[ownerAddress]=Straat+1&contactdetails[ownerCity]=Amsterdam&contactdetails[ownerZipCode]=1234+AB&contactdetails[ownerCountry]=NL&contactdetails[ownerPhoneNumber]=+31.201234567&contactdetails[ownerEmailAddress]=jan@voorbeeld.nl'

getSyncData - Meerdere domeinen synchroniseren

Haal nameservers, vervaldatum en contactgegevens op voor een specifieke lijst domeinen. Deze actie haalt geen EPP-codes op, waardoor het sneller is dan getDomainList        .

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=getSyncData&domains[voorbeeld.nl]=1&domains[test.com]=1'

Antwoord:

{
  "result": "success",
  "domains": {
    "voorbeeld.nl": {
      "Domain": "voorbeeld.nl",
      "Information": {
        "nameservers": ["ns1.hoasted.com", "ns2.hoasted.com"],
        "expiration_date": "2027-01-15",
        "auto_renew": true,
        "contacts": [...]
      },
      "Status": "success"
    },
    "test.com": {
      "Status": "error",
      "Error_msg": "Domain not found"
    }
  }
}

DeleteDomain - Domein opzeggen

Zeg een domein op. De automatische verlenging wordt uitgeschakeld en het domein wordt op geannuleerd gezet.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=DeleteDomain&sld=voorbeeld&tld=nl'

Antwoord (succes):

{"result": "success"}

Antwoord (fout):

{"success": false, "message": "ERROR: Domain not found or not authorized"}

RegisterDomain - Domein registreren

Registreer een nieuw domein.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=RegisterDomain&sld=mijndomein&tld=nl&regperiod=1&firstname=Jan&lastname=Jansen&address1=Straat+1&city=Amsterdam&state=NH&postcode=1234+AB&country=NL&phonenumber=+31.201234567&email=jan@voorbeeld.nl&nameserver1=ns1.hoasted.com&nameserver2=ns2.hoasted.com'

Antwoord (succes):

{"result": "success", "msg": "Domain has been registered"}

Antwoord (fout):

{"result": "error", "msg": "Foutomschrijving"}

TransferDomain - Domein verhuizen

Start een domeinverhuizing naar Hoasted. Dezelfde contactparameters als RegisterDomain         zijn vereist.

Extra parameters:

Alle contactparameters van RegisterDomain         zijn ook van toepassing.

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=TransferDomain&sld=mijndomein&tld=com&regperiod=1&transfersecret=EPP_CODE_HIER&firstname=Jan&lastname=Jansen&address1=Straat+1&city=Amsterdam&state=NH&postcode=1234+AB&country=NL&phonenumber=+31.201234567&email=jan@voorbeeld.nl'

Antwoord (succes):

{"result": "success", "msg": "Domain transfer initiated successfully."}

GetNameservers - Nameservers ophalen

Haal de huidige nameservers op van een domein.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=GetNameservers&sld=voorbeeld&tld=nl'

Antwoord:

{"result": "success", "ns1": "ns1.hoasted.com", "ns2": "ns2.hoasted.com"}

SaveNameservers - Nameservers wijzigen

Wijzig de nameservers van een domein.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=SaveNameservers&sld=voorbeeld&tld=nl&nameserver1=ns1.ander.com&nameserver2=ns2.ander.com'

Antwoord:

{"result": "success"}

GetEPPCode - EPP/autorisatiecode ophalen

Haal de EPP-code (ook wel autorisatiecode of verhuiscode genoemd) op van een domein. Deze code is nodig om een domein te verhuizen naar een andere registrar.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=GetEPPCode&sld=voorbeeld&tld=nl'

Antwoord (succes):

{"result": "success", "eppcode": "dZk8Lp3x"}

Antwoord (niet ondersteund voor deze extensie):

{"result": "empty"}

GetContactDetails - WHOIS-gegevens ophalen

Haal de WHOIS-contactgegevens op van een domein.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=GetContactDetails&sld=voorbeeld&tld=nl'

Antwoord:

{
  "result": "success",
  "Registrant": {
    "Name": "Jan Jansen",
    "Company": "Bedrijfsnaam B.V.",
    "Address": "Voorbeeldstraat 1",
    "City": "Amsterdam",
    "Country": "NL",
    "Zip_Code": "1234 AB",
    "Email": "jan@voorbeeld.nl",
    "Telephone": "+31.201234567"
  }
}

SaveContactDetails - WHOIS-gegevens bijwerken

Werk de WHOIS-contactgegevens bij van een domein.

Parameters:

De contactgegevens worden meegegeven als geneste arrays, bijvoorbeeld:

• contactdetails[Registrant][Name]=Jan Jansen        
• contactdetails[Registrant][Company]=Bedrijfsnaam B.V.        
• contactdetails[Registrant][Email]=jan@voorbeeld.nl        

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=SaveContactDetails&sld=voorbeeld&tld=nl&contactdetails[Registrant][Name]=Jan+Jansen&contactdetails[Registrant][Company]=Bedrijf+B.V.&contactdetails[Registrant][Email]=jan@voorbeeld.nl'

Antwoord:

{"result": "success"}

DomainGetLockingStatus - Vergrendelingsstatus opvragen

Controleer of een domein vergrendeld (locked) is. Een vergrendeld domein kan niet per ongeluk worden verhuisd.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=DomainGetLockingStatus&sld=voorbeeld&tld=com'

Antwoord:

{"result": "success", "lockstatus": "locked"}

Mogelijke waarden voor lockstatus        : "locked"         of "unlocked"        .

DomainUpdateLockingStatus - Vergrendelingsstatus wijzigen

Vergrendel of ontgrendel een domein.

Parameters:

Voorbeeld (vergrendelen):

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=DomainUpdateLockingStatus&sld=voorbeeld&tld=com&lockstatus=1'

Voorbeeld (ontgrendelen):

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=DomainUpdateLockingStatus&sld=voorbeeld&tld=com'

RegisterNameserver - Eigen nameserver registreren

Registreer een eigen (child/glue) nameserver onder je domein. Dit is nodig wanneer je nameservers wilt gebruiken die onder je eigen domein vallen (bijv. ns1.jouwdomein.nl        ).

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=RegisterNameserver&sld=voorbeeld&tld=nl&nameserver=ns1.voorbeeld.nl&ipaddress=192.0.2.1'

ModifyNameserver - IP-adres van eigen nameserver wijzigen

Wijzig het IP-adres van een eerder geregistreerde eigen nameserver.

Parameters:

Voorbeeld:

curl -X POST 'https://www.hoasted.com/cp/domainsResellerAPI/api-router.php' \
  --data 'authemail=JOUW_EMAIL&token=JOUW_TOKEN&action=ModifyNameserver&sld=voorbeeld&tld=nl&nameserver=ns1.voorbeeld.nl&currentipaddress=192.0.2.1&newipaddress=198.51.100.1'

Foutafhandeling

Bij een fout retourneert de API een JSON-object met een foutmelding:

{"success": false, "message": "ERROR: omschrijving van de fout"}

Veelvoorkomende foutmeldingen:

Overzichtstabel

Veelvoorkomende problemen

Kom je een probleem tegen? Hieronder enkele veelvoorkomende situaties:

• 401 Unauthorized: controleer of je API key en token correct zijn
• 403 Forbidden: je account heeft mogelijk geen toegang tot de API
• Onverwachte errors: controleer je request en parameters

Hulp nodig?

Heb je vragen over de API of lukt het niet om een koppeling te maken? Neem dan contact op met onze support via het ticketsysteem of stuur een e-mail.