Elke domeinnaam heeft een domeinhouder: de persoon of het bedrijf van wie de domeinnaam is. In je account is de domeinhouder een van je contacten. Met de Site.nl API kun je dat contact vanuit je eigen script aanmaken.
Sommige extensies hebben ook extra gegevens over de domeinhouder nodig. Voor .es is dat bijvoorbeeld een identiteitsnummer. Heeft het contact die gegevens? Dan is het klaar voor die extensie. Je kunt er dan meteen domeinnamen mee registreren.
Doe je het liever in je dashboard? Lees hoe je een contact klaarmaakt voor een domeinextensie. Werk je voor het eerst met onze API? Lees dan eerst hoe je aan de slag gaat met de API.
Wat je nodig hebt
Een API-sleutel. Maak er een aan in je dashboard onder Instellingen, op het tabblad API-sleutels. Vink onder API-eindpunten deze rechten aan:
- contacts.create: contacten aanmaken.
- contacts.required_info: de extra gegevens voor een extensie controleren en toevoegen.
- contacts.view: je contacten bekijken, en de extensies waarvoor ze klaar zijn.
Zet je API-sleutel bij elk verzoek in de header X-API-Key. Stuur de velden als JSON in de body.
Stap 1: maak het contact aan
POST https://backend.site.nl/v2/contactsStuur deze velden mee:
- first_name en last_name (verplicht).
- email (verplicht).
- phone_number (verplicht): alleen cijfers, zonder + of 00. Stuur het nationale nummer, of de landcode met het nummer erachter, zoals 31201234567 voor een Nederlands nummer.
- address (verplicht): met address_line_first, city, postal_code en country_id. Laat postal_code alleen weg als het land geen postcodes heeft.
- company_name: alleen als een bedrijf de domeinhouder is.
- vat_number: niet verplicht. Voor EU-landen controleren we het in de VIES-database van de EU.
De country_id vind je met GET /v2/countries. Daarvoor heb je geen API-sleutel nodig.
Het antwoord is het nieuwe contact, met zijn id. Dat ID heb je nodig in de volgende stappen. Klopt er iets niet? Dan krijg je INPUT_001, met onder fields het veld en het probleem. Bijvoorbeeld een telefoonnummer dat niet bij het land past.
Stap 2: controleer wat de extensie nodig heeft
GET https://backend.site.nl/v2/tlds/required_info?contact_id=3101&tld=.esHier is 3101 het ID van je contact en .es de extensie. We controleren het contact bij de registry. Je krijgt dan een van deze twee antwoorden:
- Een lege lijst: het contact is klaar voor deze extensie. Je hoeft niets meer te doen.
- Een lijst met required_info: de gegevens die de registry nog nodig heeft. Elk veld heeft een naam, en mandatory zegt of je het moet invullen. Bij sommige velden zie je ook de waarden waaruit je kunt kiezen (values) of het formaat (regex). Er kan ook een bericht van de registry bij staan.
De veldnamen beginnen met de naam van de registry, zoals Esnic.identificationNumber voor .es. Die naam heb je nodig in de volgende stap: het is het deel vóór de punt.
Stap 3: voeg de gegevens toe
PATCH https://backend.site.nl/v2/contacts/3101/required_infoStuur deze velden mee:
- registry: de naam van de registry, zoals Esnic.
- tld: de extensie, zoals .es.
- properties: elk veld uit stap 2 met zijn waarde. Gebruik de volledige veldnamen, zoals Esnic.identificationNumber.
We controleren de gegevens bij de registry. Accepteert de registry ze? Dan slaan we ze op en is het contact klaar. Weigert de registry ze? Dan wordt er niets opgeslagen en krijg je INPUT_002, met de velden die je moet verbeteren.
Sommige extensies willen voor een paar rollen een particulier als contact, ook als een bedrijf de domeinhouder is. Dan staat in het antwoord van stap 2 contact_roles met person. Stuur person dan mee met de gegevens: "contact_person" gebruikt de contactpersoon van het bedrijf, of stuur het ID van een van je contacten die een particulier is.
Stap 4: controleer of het contact klaar is
Doe stap 2 nog een keer. Is de lijst leeg? Dan is het contact klaar. Je kunt het ook zien met GET /v2/contacts: ready_tlds toont elke extensie waarvoor het contact klaar is.
Nu kun je een domeinnaam registreren met dit contact als domeinhouder. Stuur het ID mee als contact_id. Lees hoe je domeinnamen bestelt met de API.
Goed om te weten
- Je kunt de gegevens ook met een bestelling meesturen. Registreer of verhuis een domeinnaam en voeg de gegevens toe als required_info. We controleren ze en slaan ze op bij het contact.
- Past het contact niet bij de extensie? Sommige extensies accepteren alleen een bedrijf, of alleen een particulier. Dan krijg je REG_006. Gebruik dan een ander contact.
- REG_005 gekregen? Dan heeft het contact al alle gegevens voor deze extensie.
- Niet elke extensie heeft extra gegevens nodig. Voor .com geeft de controle in stap 2 bijvoorbeeld meestal meteen een lege lijst.
Hulp nodig? Neem contact met ons op via WhatsApp, Telegram of e-mail.
