Cet article traite des commandes WAPI propres au service WEDOS DNS. Pour savoir comment configurer WAPI et résoudre les problèmes courants, voir l’article WAPI – Manuel.
Cet article fournit des informations sur les requêtes suivantes :
- domains-list – lister les domaines du compte client
- domain-check – vérifier si le domaine est disponible
- domain-create – enregistrer un nouveau domaine
- domain-info – obtenir les informations du domaine
- domain-renew – renouveler un domaine
- domain-update-ns – modifier les serveurs DNS du domaine
- domain-transfer-check – vérifier la possibilité de transfert
- domain-transfer – transférer un domaine depuis un autre registrar
- domain-send-auth-info – envoyer l'AUTH-ID du domaine
- domain-update-keyset – modifier le keyset du domaine
- domain-tld-period-check – vérifier la disponibilité de la période
domains-list
Le domains-list requête renvoie la liste de tous les domaines du compte client et leur statut. Elle renvoie également les noms des domaines supprimés. Si plusieurs commandes sont associées à un domaine, la requête le renverra plusieurs fois avec le statut approprié (par exemple supprimé).
Paramètres
- status – filtrer par statut (facultatif)
Les états de domaine courants sont notamment :
- fee_waiting – en attente de paiement
- setup_processing – création en cours
- actif
- renew_processing – renouvellement en cours
- expiré
- désactivé
- annulé
- transfer_fee_waiting – en attente du paiement du transfert
- transfer_processing – transfert depuis un autre registrar en cours
- supprimé
Valeurs de retour
- 1000 – OK
Données de la réponse
La commande domains-list renvoie une liste de domaines, dans laquelle chaque domaine contient les entrées suivantes :
- name – nom de domaine
- status – statut du domaine
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domains-list",
"clTRID": "your ID",
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domains-list",
"data": {
"domain": {
"1": {
"name": "domain1.tld",
"status": "status"
},
"0": {
"name": "domain2.tld",
"status": "status"
}
}
}
}
}
domain-check
Utilisez domain-check requête pour vérifier si nous pouvons enregistrer un domaine.
Le domain-check requête est soumise à la limite de 100 requêtes de domaine par heure.
Nous ne pouvons pas enregistrer certains domaines, même s’ils n’existent pas actuellement. Les noms peuvent être réservés, bloqués ou leur enregistrement peut être restreint d’une autre manière. Cela dépend toujours du registre concerné, de ses règles ou de litiges en cours.
Paramètres
- name – nom de domaine sans www, ou plusieurs domaines séparés par des virgules
Valeurs de retour
- 1000 – le domaine est disponible à l'enregistrement, ou requête renvoyée (code de réponse pour une requête portant sur plusieurs domaines)
- 3201 – le nom de domaine est déjà utilisé
- 3204 – le domaine est en quarantaine
- 3205 – le domaine est réservé
- 3206 – le nom de domaine est bloqué
Données de la réponse
- name – nom de domaine
- code – valeur de retour pour ce domaine, incluse dans data uniquement si la requête porte sur plusieurs domaines
- result – valeur textuelle du code de réponse, incluse dans data uniquement si la requête porte sur plusieurs domaines
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-check",
"clTRID": "your ID",
"data": {
"name": "your domain without www, or multiple comma-separated domains"
}
}
}
Réponse JSON pour un seul domaine (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-check",
"data": {
"name": "your domain without www"
}
}
}
Réponse JSON pour plusieurs domaines (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-check"
"data":[
{
"name":"existing-domain.tld",
"code":3201,
"result":"Domain is registered"
},
{
"name":"free-domain.tld",
"code":1000,
"result":"OK"
}
]
}
}
}
domain-create
Utilisez domain-create requête pour enregistrer un nouveau domaine. La requête est synchrone ou asynchrone selon le TLD du domaine.
Le domain-create requête est soumise à la limite de 100 requêtes de domaine par heure.
Pour tous les domaines, nous et le registre exigeons le consentement du titulaire du domaine aux règles d’enregistrement des noms de domaine. Nos conditions générales exigent que vous informiez vos clients de nos conditions générales et de celles du registrar de domaines ! Le non-respect de cette obligation peut entraîner la suppression du domaine sans compensation en cas de litige.
Paramètres
- name – nom de domaine incluant le TLD – obligatoire
- period – nombre d'années – obligatoire
- dns ou nsset – une liste de serveurs DNS ou NSSET (domaines CZ uniquement) – obligatoire
- owner_c – ID du contact propriétaire – obligatoire
- admin_c – ID du contact administratif – facultatif
- règles – nom et prénom de la personne qui a accepté nos conditions générales et celles du registre (généralement le propriétaire du domaine)
Possible dns valeurs du paramètre :
- Valeur du paramètre dns vide – utiliser la valeur par défaut (serveurs DNS WEDOS). Attention, même si vous laissez le paramètre DNS vide, vous devez tout de même le spécifier ! Le paramètre NSSET doit toujours contenir une valeur (p. ex.
WEDOS). - Configuration DNS propre – ne peut pas être utilisé pour les domaines CZ (chaque enregistrement doit contenir un name champ, éventuellement addr_ip4 et addr_ip6, les serveurs individuels sont imbriqués dans l'élément server). Voir le modèle pour plus de détails.
Valeurs de retour
- 1000 – le domaine a été enregistré avec succès
- 1001 – demande d'enregistrement asynchrone acceptée
- 3002 – crédit insuffisant sur le compte de crédit
- 3201 – le nom de domaine est déjà utilisé
- 3204 – le domaine est en quarantaine
- 3205 – le domaine est réservé
- 3206 – le nom de domaine est bloqué
- 2201 – TLD non pris en charge
- 2203 – période invalide
- 3221 – échec de la création
- 4207 – échec de la création – erreur de connexion
Données de la réponse
Après l’enregistrement réussi du domaine, les éléments suivants sont renvoyés dans le nœud data :
- num – numéro de commande
- expiration – date d'expiration du domaine
- crédit – état du compte de crédit une fois l'opération terminée
- montant – solde du compte de crédit
- devise – devise
Modèles
Requête JSON avec NSSET WEDOS :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-create",
"clTRID": "your ID",
"data": {
"name": "domain.cz",
"period": "number of years",
"nsset": "WEDOS",
"owner_c": "owner contact ID",
"admin_c": "admin contact ID",
"rules": {
"fname": "Name",
"lname": "Surname"
}
}
}
}
Requête JSON avec DNS propre :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-create",
"clTRID": "your ID",
"data": {
"name": "domain.tld",
"period": "number of years",
"dns": {
"server1":
{
"name": "ns1.dns-provider.tld"
},
"server2":
{
"name": "ns2.dns-provider.tld"
}
}
},
"owner_c": "domain owner contact ID",
"admin_c": "domain admin contact ID",
"rules": {
"fname": "Name",
"lname": "Surname"
}
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-create",
"data": {
"num": "order number",
"expiration": "YYYY-MM-DD"
}
}
}
domain-info
Utilisez domain-info requête pour obtenir des informations sur un domaine donné.
La commande ne fonctionne que sur les domaines du compte client correspondant.
Paramètres
- name – nom de domaine, pour plusieurs domaines utilisez une chaîne séparée par des virgules (voir le modèle) – obligatoire
Valeurs de retour
- 1000 – la commande a réussi, l'élément data contient les informations sur le domaine
- 3222 – échec de la récupération de l'objet domaine
- 3216– échec de la récupération des informations sur le domaine
- 3223 – le domaine n'appartient pas à votre compte client
- 4205 – erreur de connexion avec le registre
La valeur de retour pour plusieurs domaines est toujours 1000. Les éventuelles valeurs d’erreur sont affichées dansdomainedonnées, comme indiqué dans le modèle.
Données de la réponse
L’élément data contient des informations sur le domaine en cas de succès. Les données précises dépendent du type de domaine et d’autres circonstances. Voici les plus importantes :
- name – nom de domaine
- status – statut du domaine
- owner_c – ID du propriétaire du domaine
- setup_date – date de création
- expiration – date d'expiration
- dns ou NSSET – liste des serveurs DNS ou NSSET
- éléments avec own_ préfixe – informations sur le propriétaire du domaine
Certaines informations sur le domaine ou son titulaire peuvent être masquées ; elles ont alors la valeur HIDDEN.
Modèles
Requête JSON avec 2 domaines :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-info",
"clTRID": "your ID",
"data": {
"name": "domain.name1, domain.name2"
}
}
}
Réponse JSON (domain.name1 OK, domain.name2 erreur) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-info",
"data": {
"domain": [{
"name": "domain.name1",
"status": "status",
"owner_c": "owner ID",
"nsset": "WEDOS",
"reg_owner": "",
"reg_creator": "",
"setup_date": "YYYY-MM-DD",
"expiration": "YYYY-MM-DD",
"reg_update": "",
"updated_date": "",
"transfer_date": "",
"dns": {
"server1":
{
"name": "ns1.server-provider.tld"
},
"server2":
{
"name": "ns1.server-provider.tld"
}
}
},
"own_company": "",
"own_name": "",
"own_lname": "",
"own_fname": "",
"own_email": "",
"own_email2": "",
"own_phone": "",
"own_fax": "",
"own_ic": "",
"own_dic": "",
"own_taxpayer": "",
"own_addr_street": "",
"own_addr_city": "",
"own_addr_zip": "",
"own_addr_country": "",
"own_addr_state": "",
"admin_c": "",
"own_other": {
"notify_email": "",
"ident_type": "",
"ident": ""
}
},
{
"name": "domain.name2",
"code": 3222,
"result": "Domain open failed"
}]
}
}
}
domain-renew
Le domain-renew requête permet de renouveler un domaine dont le renouvellement n'a pas encore été commandé.
Par défaut, le système tente automatiquement de renouveler les domaines 30 jours avant leur expiration. Vous pouvez désactiver ce comportement dans votre paramètres du compte ⧉.
Paramètres
- name – nom de domaine – obligatoire
- period – nombre d'années à renouveler – obligatoire
Valeurs de retour
- 1000 – Le domaine a été renouvelé avec succès
- 2203 – Période de renouvellement invalide
- 2269 – une demande de renouvellement existe déjà
Données de la réponse
En cas de succès, cette commande renvoie la nouvelle date d’expiration.
- expiration – nouvelle date d'expiration du domaine
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-renew",
"clTRID": "your ID",
"data": {
"name": "your domain name without www",
"period": "number of years"
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-renew",
"data": {
"expiration": "YYYY-MM-DD"
}
}
}
domain-update-ns
Utilisez domain-update-ns requête pour modifier les serveurs DNS ou le NSSET du domaine.
Paramètres
- name – nom de domaine – obligatoire
- dns ou nsset – serveurs DNS ou NSSET pour les domaines CZ – obligatoire
Possible dns valeurs du paramètre :
- Valeur du paramètre dns vide – utiliser la valeur par défaut (serveurs DNS WEDOS). Attention, même si vous laissez le paramètre DNS vide, vous devez tout de même le spécifier ! Le paramètre NSSET doit toujours contenir une valeur (p. ex.
WEDOS). - Configuration DNS propre – ne peut pas être utilisé pour les domaines CZ (chaque enregistrement doit contenir un name champ, éventuellement addr_ip4 et addr_ip6, les serveurs individuels sont imbriqués dans l'élément server). Voir le modèle pour plus de détails.
Valeurs de retour
- 1000 – Serveurs DNS définis avec succès
- 2209 – format de NSSET invalide (pour les domaines CZ)
- 2210 – format de serveur DNS invalide
Données de la réponse
La requête ne renvoie aucune donnée.
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-update-ns",
"clTRID": "your ID",
"data": {
"name": "domain.tld",
"dns": {
"server1":
{
"name": "ns1.own-dns-server.tld"
},
"server2":
{
"name": "ns1.own-dns-server.tld"
}
}
}
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-update-ns",
}
}
domain-transfer-check
Utilisez domain-transfer-check requête pour vérifier si le domaine peut être transféré d'un autre registrar vers nous.
Le domain-transfer-check requête est soumise à la limite de 100 requêtes de domaine par heure.
Paramètres
- name – nom de domaine sans www – obligatoire
Valeurs de retour
La requête renvoie généralement les valeurs suivantes :
- 1000 – Le transfert est possible
- 3217 – Échec de l'établissement de la connexion avec le registre
- 3218 – Le transfert n'est pas possible
Données de la réponse
La requête ne renvoie aucune donnée.
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-transfer-check",
"clTRID": "your ID",
"data": {
"name": "domain.tld"
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-transfer-check"
}
}
domain-transfer
Utilisez domain-transfer requête pour transférer un domaine d'un autre registrar vers WEDOS.
La requête n’est synchrone que pour les domaines CZ et EU : pour ceux-ci, si l’AUTH-ID est correct, le transfert est effectué immédiatement et vous en connaissez aussitôt le résultat. Pour les autres domaines, les transferts sont asynchrones et vous connaîtrez le résultat via une notification.
Le domain-transfer requête est soumise à la limite de 100 requêtes de domaine par heure.
Pour tous les domaines, nous et le registre exigeons le consentement du titulaire du domaine aux règles d’enregistrement des noms de domaine. Nos conditions générales exigent que vous informiez vos clients de nos conditions générales et de celles du registrar de domaines ! Le non-respect de cette obligation peut entraîner la suppression du domaine sans compensation en cas de litige.
Paramètres
- name – nom de domaine sans www – obligatoire
- auth_info – AUTH-ID du domaine – obligatoire
- owner_c – ID du propriétaire du domaine – obligatoire uniquement pour certains registres (SK, EU, gTLD)
- dns – configuration des serveurs DNS du domaine – facultatif ; disponible uniquement pour les registres qui la prennent en charge (EU, gTLD)
- règles – nom et prénom de la personne qui a accepté nos conditions générales et celles du registre (généralement le propriétaire du domaine) – obligatoire
Valeurs disponibles de dns paramètre :
- Paramètre DNS omis – le domaine conservera les paramètres actuels des serveurs DNS. Lors du transfert, les serveurs DNS actuels seront résolus. S'il n'est pas possible de résoudre les serveurs DNS actuels, le transfert peut aboutir à une erreur (gTLD).
- Paramètre DNS vide – le système tentera de définir les serveurs DNS WEDOS par défaut.
- Paramètre DNS avec serveurs – le système tentera de définir ces serveurs DNS.
Valeurs de retour
- 1000 – Domaine transféré avec succès
- 1001 – La demande de transfert a été acceptée, en attente de réalisation
- 2100 – Paramètre obligatoire manquant
- 2101 – Valeur de paramètre invalide
- 2201 – TLD invalide
- 2202 – Format du nom de domaine invalide
- 2204 – Identifiant du contact propriétaire du domaine non spécifié
- 2207 – Identifiant du contact propriétaire du domaine invalide
- 2210 – Format de serveur DNS invalide
- 2215 – l'AUTH-ID n'a pas été spécifié et est obligatoire pour ce domaine
- 2245 – Consentement manquant
- 2246 – Erreur dans les données de consentement
- 2252 – Nombre de requêtes de domaine dépassé
- 2263 – l'AUTH-ID est plus court que la longueur minimale requise
- 2271 – Format d'AUTH-ID invalide
- 3001 – Devise du compte de crédit invalide
- 3003 – Informations de facturation du compte de crédit invalides
- 3207 – Le domaine est déjà enregistré chez nous
- 3208 – Échec du transfert en raison d'un problème de date d'expiration
- 3217 – Impossible d'établir une connexion avec le registre
- 3218 – Transfert impossible
- 3219 – Demande de transfert déjà en attente pour ce domaine
- 3220 – Le domaine est déjà enregistré dans notre registre
- 3226 – Échec du transfert du domaine
- 3227 – Erreur d'autorisation auprès du registre de domaines
- 3258 – Indisponibilité du registre
- 3266 – Transfert impossible car le domaine a expiré
- 3267 – Échec de la résolution des serveurs DNS autoritaires
- 4002 – Échec du débit du crédit sur le compte de crédit
- 4003 – Échec de la création de la période de facturation
- 4206 – Impossible de déterminer si le domaine peut être transféré – erreur de connexion
- 4209 – Impossible de déterminer le type de transfert (avec / sans renouvellement)
- 5001 – Erreur interne de connexion
- 5002 – Échec du calcul du prix du transfert
- 5004 – Indisponibilité de la facturation
Données de la réponse
- num – numéro de commande
- expiration – date d'expiration du domaine
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-transfer",
"clTRID": "your ID",
"data": {
"name": "domain.tld",
"auth_info": "AUTH-ID",
"dns": {
"server1":
{
"name": "ns1.mydns.tld"
},
"server2":
{
"name": "ns2.mydns.tld"
}
}
},
"rules": {
"fname": "Name",
"lname": "Surname"
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-transfer",
"data": {
"num": "order number",
"expiration": "YYYY-MM-DD"
}
}
}
domain-send-auth-info
Utilisez domain-send-auth-info requête pour envoyer l'AUTH-ID d'un domaine à l'adresse e-mail du propriétaire du domaine.
Paramètres
- name – nom de domaine – obligatoire
Valeurs de retour
- 1000 – l'AUTH-ID est envoyé à l'e-mail du propriétaire du domaine
- 2243 – Envoi de auth_info non autorisé
- 3209 – Échec de l'envoi de auth_info
- 3210 – Échec de l'envoi de auth_info – le domaine est indisponible
- 3222 – Échec de la récupération du domaine
- 3223 – Le domaine n'appartient pas à ce compte client
- 4214 – Échec de l'envoi de auth_info – erreur de connexion – réessayez plus tard
Données de la réponse
La requête ne renvoie aucune donnée.
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-send-auth-info",
"clTRID": "your ID",
"data": {
"name": "domain.tld"
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-send-auth-info"
}
}
domain-update-keyset
Le domain-update-keyset requête permet de modifier les paramètres du KEYSET du domaine, c'est-à-dire d'activer, de désactiver ou de mettre à jour les paramètres DNSSEC.
Paramètres
- name – nom de domaine – obligatoire
- keyset – paramètres KEYSET – obligatoire
0 = pas de KEYSET / désactiver DNSSEC
1 = notre KEYSET / notre DNSSEC (si le domaine utilise nos serveurs DNS et est défini comme primaire)
chaîne = le nom de votre propre KEYSET (si le domaine n'utilise pas nos serveurs DNS ou est défini comme secondaire)
Valeurs de retour
- 1000 = OK
- 2202= nom du domaine existant invalide ou non pris en charge
- 2264 = nom de KEYSET invalide
- 2265 = pas de prise en charge de DNSSEC
- 2266 = action non prise en charge pour un domaine secondaire
- 2267 = action non prise en charge pour un domaine primaire
- 3260 = une commande DNSSEC est déjà en attente
- 3258 = indisponibilité du registre en cours
- 3263 = le domaine n'utilise pas notre DNS
- 3222= échec de l'ouverture du domaine
- 3223= accès refusé
- 3259 = KEYSET indisponible
- 3262 = Échec de la configuration DNSSEC
- 3264 = Le KEYSET est bloqué
Données de retour
La requête ne renvoie aucune donnée.
Modèles
Requête JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-update-keyset",
"clTRID": "your ID",
"data": {
"name": "domain name",
"keyset": "0/1/string",
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-update-keyset"
}
}
domain-tld-period-check
Utilisez domain-tld-period-check requête pour vérifier si une période d'enregistrement donnée peut être définie pour un TLD.
Paramètres
- tld – TLD
- period – nombre d'années
Valeurs de retour
- 1000 – la période peut être utilisée pour ce domaine
- 2203 –la période ne peut pas être utilisée pour ce domaine
Données de la réponse
La requête ne renvoie aucune donnée.
Modèles
Commande JSON :
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "domain-tld-period-check",
"clTRID": "your ID",
"data": {
"tld": "domain tld",
"period": "number of years"
}
}
}
Réponse JSON (OK) :
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "domain-tld-period-check"
}
}
