Xynta Support - API-calls voor de module: domains

Hier vindt u een overzicht van alle beschikbare API-calls onder de module: domains

We hebben een aantal downloadbare bestanden voor u samengesteld welke u als voorbeeld kan gebruiken voor het uitvoeren van een geldige API-call.

m: `domains`, a: `check`

Met deze API-call kunt u de beschikbaarheid van een door u gekozen domeinnaam controleren. Het status veld geeft de volgende waarden terug:

available (de domeinnaam is beschikbaar)
unavailable (de domeinnaam is bezet)

Variabele	Verplicht	Toelichting
`Domain`	ja	Verstuur de domeinnaam als volgt: domeinnaam.nl

m: `domains`, a: `list`

Met deze API-call krijgt u een overzicht van alle (actieve) domeinnamen onder uw klantenaccount terug

success (het domeinnaam overzicht is succesvol opgehaald)

Variabele	Verplicht	Toelichting
Er zijn geen extra variabelen welke u mee kunt sturen met deze API-call

m: `domains`, a: `order`

Met deze API-call kunt u een nieuwe domeinnaam registreren of een bestaande domeinnaam verhuizen (Zie ook: Domeinnamen real-time bestellen). Het status veld geeft de volgende waarden terug:

success (de domeinnaam is succesvol besteld)
not-authorized (achteraf facturen is niet ingeschakeld voor uw klantenaccount)
not-found-service (de domeinnaam extensie wordt niet door ons aangeboden)
not-found-contact (het meegegeven contact kon niet worden gevonden)
not-available (de domeinnaam is al eerder besteld door u of een andere klant)
validation-domain (de domeinnaam bevat niet toegestane tekens)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u domeinnaam.nl wilt bestellen vult u hier domeinnaam in
`Tld`	ja	Als u domeinnaam.nl wilt bestellen vult u hier nl in
`OwnerHandle`	ja	Vul hier de Handle (unieke naam) van het houder contact in
`AdminHandle`	ja	Vul hier de Handle (unieke naam) van het administratieve contact in
`TechHandle`	ja	Vul hier de Handle (unieke naam) van het technische contact in
`DNS1`	ja	Vul hier uw eerste nameserver in, bijvoorbeeld ns1.naamservert.nl
`DNS2`	ja	Vul hier uw tweede nameserver in, bijvoorbeeld ns2.naamservert.nl
`DNS3`	nee	Vul hier uw derde nameserver in, bijvoorbeeld ns3.naamservert.nl
`AuthKey`	nee	Vul hier de domeinnaam verhuiscode in, alleen verplicht bij bepaalde verhuizingen

m: `domains`, a: `show`

Met deze API-call kunt u de gegevens (bijv. contacten, nameservers en abonnementen) van een domeinnaam opvragen. Het status veld geeft de volgende waarden terug:

success (de domeinnaam is gevonden)
not-authorized (u heeft geen toegang tot deze domeinnaam)
not-found (de domeinnaam kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u domeinnaam.nl wilt opvragen vult u hier domeinnaam in
`Tld`	ja	Als u domeinnaam.nl wilt opvragen vult u hier nl in

m: `domains`, a: `del`, t: `cancel` / `cancel-direct` / `undo`

Met deze API-call kunt u een domeinnaam per direct (cancel-direct) of per einde looptijd (cancel) opzeggen. Het status veld geeft de volgende waarden terug:

success (de domeinnaam is opgezegd)
pending-deletion (de domeinnaam is al opgezegd)
not-support (de domeinnaam kan niet worden opgezegd)
not-authorized (u heeft geen toegang tot deze domeinnaam)
not-found (de domeinnaam kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u domeinnaam.nl wilt opzeggen vult u hier domeinnaam in
`Tld`	ja	Als u domeinnaam.nl wilt opzeggen vult u hier nl in

m: `domains`, a: `edit-contact`

Met deze API-call kunt u de contacten (houder, administratief en technisch) van een domeinnaam wijzigen. Het status veld geeft de volgende waarden terug:

success (de domeinnaam contacten zijn gewijzigd)
error (de domeinnaam contacten zijn niet gewijzigd)
not-authorized (u heeft geen toegang tot deze domeinnaam)
not-found (de domeinnaam kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u domeinnaam.nl wilt wijzigen vult u hier domeinnaam in
`Tld`	ja	Als u domeinnaam.nl wilt wijzigen vult u hier nl in
`OwnerHandle`	ja	Vul hier de Handle (unieke naam) van het houder contact in
`AdminHandle`	ja	Vul hier de Handle (unieke naam) van het administratieve contact in
`TechHandle`	ja	Vul hier de Handle (unieke naam) van het technische contact in

m: `domains`, a: `edit-nameserver`

Met deze API-call kunt u de nameserver instellingen van een domeinnaam wijzigen. Het status veld geeft de volgende waarden terug:

success (de domeinnaam nameservers zijn gewijzigd)
warning (de domeinnaam nameservers zijn niet gewijzigd)
error (de domeinnaam nameservers zijn niet gewijzigd)
not-authorized (u heeft geen toegang tot deze domeinnaam)
not-found (de domeinnaam kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u domeinnaam.nl wilt wijzigen vult u hier domeinnaam in
`Tld`	ja	Als u domeinnaam.nl wilt wijzigen vult u hier nl in
`DNS1`	ja	Vul hier uw eerste nameserver in, bijvoorbeeld ns1.naamservert.nl
`DNS2`	ja	Vul hier uw tweede nameserver in, bijvoorbeeld ns2.naamservert.nl
`DNS3`	nee	Vul hier uw derde nameserver in, bijvoorbeeld ns3.naamservert.nl

m: `domains`, a: `lock`

Met deze API-call kunt u een domeinnaam vergrendelen (mits ondersteund door de domeinnaam extensie). Het status veld geeft de volgende waarden terug:

success (de domeinnaam is vergrendeld)
not-supported (het vergrendelen van de domeinnaam wordt niet ondersteund)
not-authorized (u heeft geen toegang tot deze domeinnaam)
not-found (de domeinnaam kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u domeinnaam.nl wilt vergrendelen vult u hier domeinnaam in
`Tld`	ja	Als u domeinnaam.nl wilt vergrendelen vult u hier nl in

m: `domains`, a: `unlock`

Met deze API-call kunt u een domeinnaam ontgrendelen (mits ondersteund door de domeinnaam extensie). Het status veld geeft de volgende waarden terug:

success (de domeinnaam is ontgrendeld)
not-supported (het ontgrendelen van de domeinnaam wordt niet ondersteund)
not-authorized (u heeft geen toegang tot deze domeinnaam)
not-found (de domeinnaam kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u domeinnaam.nl wilt ontgrendelen vult u hier domeinnaam in
`Tld`	ja	Als u domeinnaam.nl wilt ontgrendelen vult u hier nl in

m: `domains`, a: `get-authkey`

Met deze API-call kunt u de verhuiscode van een domeinnaam opvragen (mits ondersteund door de domeinnaam extensie). Het status veld geeft de volgende waarden terug:

success (de verhuiscode is opgevraagd)
warning (de verhuiscode kon niet worden opgevraagd)
error (de verhuiscode kon niet worden opgevraagd)
not-supported (het opvragen van een verhuiscode wordt niet ondersteund)
not-authorized (u heeft geen toegang tot deze domeinnaam)
not-found (de domeinnaam kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Domain`	ja	Als u de verhuiscode van domeinnaam.nl wilt opvragen vult u hier domeinnaam in
`Tld`	ja	Als u de verhuiscode van domeinnaam.nl wilt opvragen vult u hier nl in

m: `domains`, a: `list`, t: `contact`

Met deze API-call kunt u een overzicht van de aan uw klantenaccount toegevoegde contacten opvragen. Het status veld geeft de volgende waarden terug:

success (het contact is succesvol opgevraagd)
pending (het contact wordt momenteel aangemaakt)
not-authorized (u heeft geen toegang tot het contacten overzicht)
not-found (er konden geen contacten worden gevonden)

Variabele	Verplicht	Toelichting
Er zijn geen extra variabelen welke u mee kunt sturen met deze API-call

m: `domains`, a: `show`, t: `contact`

Met deze API-call kunt u een aan uw klantenaccount toegevoegd contact opvragen. Het status veld geeft de volgende waarden terug:

success (het contact is succesvol opgevraagd)
pending (het contact wordt momenteel aangemaakt)
not-authorized (u heeft geen toegang tot het contact)
not-found (het contact kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Handle`	ja	Vul hier de Handle (unieke naam) van het gewenste contact in

m: `domains`, a: `add`, t: `contact`

Met deze API-call kunt u een nieuw contact aan uw klantenaccount toevoegen. Het status veld geeft de volgende waarden terug:

success (het contact is succesvol toegevoegd)
error-processing (het contact kon niet worden toegevoegd)
validation-handle (het Handle-veld bevat een opmaak fout)
validation-emailaddress (het EmailAddress-veld bevat geen geldig e-mailadres)
validation-address (het Address-veld bevat geen geldig adres, een postbus is niet toegestaan)
validation-phonenumber (het PhoneNumber-veld bevat geen geldig telefoonnummer)
not-found (het contact kon niet worden toegevoegd)

Variabele	Verplicht	Toelichting
`Handle`	ja	Vul hier de Handle (unieke naam) van het gewenste contact in
`CompanyName`	nee	Vul hier de bedrijfs-, stichting of organisatie naam van het contact in
`CompanyNumber`	nee	Vul hier het KvK nummer van het contact in, alleen Nederlandse bedrijven
`TaxNumber`	nee	Vul hier het BTW nummer van het contact in, alleen bedrijven binnen de Europese Unie
`Initials`	ja	Vul hier de voornaam of voorletters van het contact in
`SurName`	ja	Vul hier de achternaam (en eventuele toevoegingen) van het contact in
`Address`	ja	Vul hier het adres van het contact in, een postbus is niet toegestaan
`ZipCode`	ja	Vul hier de postcode (bijvoorbeeld: 1234AB, geen spaties) van het contact in
`City`	ja	Vul hier de plaatsnaam (gebruik uitsluitend letters en spaties) van het contact in
`Country`	ja	Vul hier de ISO 3166-1 landcode van het contact in
`EmailAddress`	ja	Vul hier het e-mailadres van het contact in, deze moet bestaan en te bereiken zijn
`PhoneNumber`	ja	Vul hier het telefoonnummer van het contact in, gebruik alleen cijfers

m: `domains`, a: `edit`, t: `contact`

Met deze API-call kunt u een bestaand contact op uw klantenaccount wijzigen. Het status veld geeft de volgende waarden terug:

success (het contact is succesvol gewijzigd)
error-processing (het contact kon niet worden gewijzigd)
validation-handle (het Handle-veld bevat een opmaak fout)
validation-emailaddress (het EmailAddress-veld bevat geen geldig e-mailadres)
validation-address (het Address-veld bevat geen geldig adres, een postbus is niet toegestaan)
validation-phonenumber (het PhoneNumber-veld bevat geen geldig telefoonnummer)
pending-processing (het contact wordt momenteel verwerkt)
pending-modification (het contact wordt momenteel gewijzigd)
pending-deletion (het contact wordt momenteel verwijderd)
not-found (het contact kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Handle`	ja	Vul hier de Handle (unieke naam) van het bestaande contact in
`CompanyName`	nee	Vul hier de bedrijfs-, stichting of organisatie naam van het contact in
`CompanyNumber`	nee	Vul hier het KvK nummer van het contact in, alleen Nederlandse bedrijven
`TaxNumber`	nee	Vul hier het BTW nummer van het contact in, alleen bedrijven binnen de Europese Unie
`Initials`	ja	Vul hier de voornaam of voorletters van het contact in
`SurName`	ja	Vul hier de achternaam (en eventuele toevoegingen) van het contact in
`Address`	ja	Vul hier het adres van het contact in, een postbus is niet toegestaan
`ZipCode`	ja	Vul hier de postcode (bijvoorbeeld: 1234AB, geen spaties) van het contact in
`City`	ja	Vul hier de plaatsnaam (gebruik uitsluitend letters en spaties) van het contact in
`Country`	ja	Vul hier de ISO 3166-1 landcode van het contact in
`EmailAddress`	ja	Vul hier het e-mailadres van het contact in, deze moet bestaan en te bereiken zijn
`PhoneNumber`	ja	Vul hier het telefoonnummer van het contact in, gebruik alleen cijfers

m: `domains`, a: `check`, t: `contact`

Met deze API-call kunt u controleren of er al een contact bestaat voor een bepaalde contactpersoon of organisatie. Het status veld geeft de volgende waarden terug:

success (er is een overeenkomend contact gevonden)
not-found (er kon geen overeenkomend contact worden gevonden)

Variabele	Verplicht	Toelichting
`Initials`	ja	Vul hier de voorletters of voornaam van het contact in
`SurName`	ja	Vul hier de achternaam (en eventuele toevoegingen) van het contact in
`CompanyName`	nee	Vul hier de bedrijfs-, stichting of organisatie naam van het contact in

m: `domains`, a: `del`, t: `contact`

Met deze API-call kunt u een bestaand contact op uw klantenaccount verwijderen. Het status veld geeft de volgende waarden terug:

success (het contact is succesvol verwijderd)
pending-processing (het contact wordt momenteel verwerkt)
pending-modification (het contact wordt momenteel gewijzigd)
pending-deletion (het contact wordt momenteel verwijderd)
not-found (het contact kon niet worden gevonden)

Variabele	Verplicht	Toelichting
`Handle`	ja	Vul hier de Handle (unieke naam) van het bestaande contact in

API-calls voor de module: domains

m: domains, a: check

m: domains, a: list

m: domains, a: order

m: domains, a: show

m: domains, a: del, t: cancel / cancel-direct / undo

m: domains, a: edit-contact

m: domains, a: edit-nameserver

m: domains, a: lock

m: domains, a: unlock

m: domains, a: get-authkey

m: domains, a: list, t: contact

m: domains, a: show, t: contact

m: domains, a: add, t: contact

m: domains, a: edit, t: contact

m: domains, a: check, t: contact

m: domains, a: del, t: contact