REST API – Contacts de domaine

GET /contacts/check

Vérifie si un handle de contact est libre et quel est son statut auprès du registre.

Paramètres :

• tld – obligatoire, query, string – TLD pour lequel le contact est vérifié
• cname – obligatoire, query, string – handle (identifiant) du contact
• reg_key – facultatif, query, string – identifiant d’un registre précis (si le TLD prend en charge plusieurs registres ou modes)

Codes de retour :

• 1000 – le contact est libre et utilisable
• 2201 – TLD invalide
• 2216 – format d’identifiant de contact invalide
• 2218 – les contacts sont générés automatiquement auprès de ce registre (vous ne pouvez pas choisir le handle)
• 3228 – le registre ne prend pas en charge les contacts
• 3231 – le contact existe déjà
• 3233 – le contact ne peut pas être utilisé
• 3234 – le contact ne peut pas être utilisé – quarantaine
• 3235 – le contact ne peut pas être utilisé – réservé
• 3236 – le contact ne peut pas être utilisé – bloqué
• 3237 – le contact est déjà enregistré chez nous
• 4211 – échec de la vérification du contact – erreur de connexion

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/contacts/check?tld=eu&cname=CONTACT'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f1"
}

GET /contacts/{cname}

Renvoie des informations détaillées sur un contact.

Paramètres :

• cname – obligatoire, path – handle du contact
• tld – obligatoire, query, string – TLD sous lequel le contact est recherché
• auth_info – facultatif, query, string – code d’autorisation du contact (s’il est fourni, il doit correspondre au code défini sur l’objet, sinon une erreur est renvoyée)
• reg_key – facultatif, query, string – identifiant d’un registre précis

Codes de retour :

• 1000 – OK
• 2201 – TLD incorrectement spécifié
• 2216 – erreur de syntaxe de l’identifiant de contact
• 3215 – code d’autorisation invalide (fourni et ne correspondant pas)
• 3228 – le registre ne prend pas en charge les contacts
• 3229 – erreur lors du chargement du contact
• 3236 – le contact est bloqué
• 4212 – erreur de connexion
• 5001 – personne n’est connecté

Données de réponse :

• contact – objet contenant les coordonnées du contact :
  • contact_id, roid, status – identifiant, ROID et statut du contact auprès du registre
  • name, fname, lname, company – nom, prénom et nom de famille, ou raison sociale
  • addr_street, addr_city, addr_zip, addr_state, addr_country – adresse
  • phone, fax, email, email2 – coordonnées
  • ic, dic, taxpayer – numéro d’identification de l’entreprise (IČ), numéro de TVA (DIČ), statut d’assujetti à la TVA
  • reg_owner, reg_creator, reg_update – identifiants du bureau d’enregistrement
  • created_date, updated_date, transfer_date – dates de création, de mise à jour et de transfert
  • disclose – paramètres de divulgation des données (selon le registre)
  • other – données supplémentaires propres au registre

Exemple :

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/contacts/CONTACT?tld=eu'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f2",
  "data": {
    "contact": {
      "contact_id": "CONTACT",
      "status": "ok",
      "fname": "Esmeralda",
      "lname": "Excavadora",
      "company": null,
      "addr_street": "Street 123",
      "addr_city": "City",
      "addr_zip": "11000",
      "addr_country": "CZ",
      "phone": "+420.777123456",
      "email": "esmeralda@wedos.com",
      "created_date": "2024-01-10",
      "updated_date": null
    }
  }
}

POST /contacts/create

Crée un nouveau contact de domaine pour le TLD indiqué.

Paramètres :

• tld – obligatoire, string – TLD pour lequel le contact est créé
• reg_key – facultatif, string – identifiant d’un registre précis
• contact – obligatoire, object – coordonnées du contact ; les champs disponibles diffèrent selon le registre, généralement :
  • cname (facultatif) – handle de contact demandé ; omettez-le pour les registres qui génèrent les handles automatiquement
  • fname, lname – prénom et nom de famille (pour une personne physique)
  • company – raison sociale (pour une personne morale)
  • addr_street, addr_city, addr_zip, addr_state, addr_country – adresse
  • phone, fax, email, email2 – coordonnées
  • ic, dic, taxpayer – numéro d’identification de l’entreprise (IČ), numéro de TVA (DIČ), statut d’assujetti à la TVA
  • autres éléments selon le registre concerné

Codes de retour :

• 1000 – contact créé
• 2100 – paramètre obligatoire manquant
• 2101 – paramètres d’entrée invalides
• 2201 – TLD invalide
• 2216 – nom de contact invalide
• 2218 – les noms de contact sont créés automatiquement auprès de ce registre (vous ne pouvez pas indiquer le vôtre)
• 2219–2242 – éléments du contact manquants ou de format invalide (raison sociale, prénom, nom de famille, e-mail, téléphone, fax, numéro d’identification de l’entreprise, numéro de TVA, adresse, région, autres données)
• 3228 – le registre ne prend pas en charge les contacts
• 3230 – échec de la création du contact
• 3231 – le nom de contact est déjà utilisé
• 3233 – le contact ne peut pas être utilisé
• 3234 – le contact ne peut pas être utilisé – quarantaine
• 3236 – le contact ne peut pas être utilisé – bloqué
• 3237 – le contact est déjà enregistré chez nous
• 4211 – échec de la vérification – erreur de communication
• 4213 – échec de la création du contact – erreur de communication

Données de réponse :

• cname – handle du contact créé

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/create' \
  --data '{
    "tld": "eu",
    "contact": {
      "fname": "Esmeralda",
      "lname": "Excavadora",
      "addr_street": "Street 123",
      "addr_city": "City",
      "addr_zip": "11000",
      "addr_country": "CZ",
      "email": "esmeralda@wedos.com",
      "phone": "+420.777123456"
    }
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f3",
  "data": {
    "cname": "CONTACT"
  }
}

POST /contacts/{cname}/transfer

Transfère vers nous un contact depuis un autre bureau d’enregistrement (uniquement auprès des registres qui prennent en charge le transfert de contacts, par ex. CZ.NIC).

Paramètres :

• cname – obligatoire, path – handle du contact
• tld – obligatoire, string – TLD
• auth_info – obligatoire, string – code d’autorisation du contact
• reg_key – facultatif, string – identifiant d’un registre précis

Codes de retour :

• 1000 – OK
• 2100 – paramètre obligatoire manquant
• 2101 – paramètres d’entrée invalides
• 2201 – TLD invalide
• 2215 – paramètre auth_info manquant
• 2216 – identifiant de contact invalide
• 2244 – ce domaine ou ce registre ne prend pas en charge le transfert de contacts
• 3229 – le contact n’est pas disponible
• 3237 – le contact est déjà enregistré chez nous
• 3240 – erreur d’autorisation
• 3241 – échec du transfert
• 4216 – échec du transfert – erreur de connexion

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT/transfer' \
  --data '{"tld": "cz", "auth_info": "AUTHCODE123"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f4"
}

POST /contacts/{cname}/auth-info/send

Envoie le code d’autorisation du contact à son adresse e-mail de contact.

Paramètres :

• cname – obligatoire, path – handle du contact
• tld – obligatoire, string – TLD
• reg_key – facultatif, string – identifiant d’un registre précis

Codes de retour :

• 1000 – OK
• 2100 – paramètre obligatoire manquant
• 2101 – paramètres d’entrée invalides
• 2201 – TLD invalide
• 2216 – nom de contact invalide
• 2243 – l’envoi du code d’autorisation n’est pas autorisé pour ce contact
• 3213 – le contact est indisponible
• 3215 – échec de l’envoi du code
• 3228 – le registre ne prend pas en charge les contacts
• 4217 – échec de l’envoi – erreur de communication
• 5001 – erreur d’authentification

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT/auth-info/send' \
  --data '{"tld": "eu"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f5"
}

PATCH /contacts/{cname}

Modifie les coordonnées d’un contact existant. Ne peut pas être utilisé auprès des registres où les contacts ne sont pas modifiables (par ex. Ascio).

Paramètres :

• cname – obligatoire, path – handle du contact
• tld – obligatoire, string – TLD
• auth_info – facultatif, string – code d’autorisation du contact
• contact – obligatoire, object – coordonnées du contact à modifier (mêmes champs que dans POST /contacts/create ; seuls les champs indiqués sont modifiés)
• reg_key – facultatif, string – identifiant d’un registre précis

Codes de retour :

• 1000 – OK
• 2100 – paramètre obligatoire manquant
• 2101 – paramètres d’entrée invalides
• 2201 – TLD invalide
• 2207 – erreur de syntaxe
• 2216 – nom de contact invalide
• 2219–2241 – éléments modifiés manquants ou de format invalide (même étendue que pour la création d’un contact)
• 3211 – échec du chargement du contact
• 3238 – erreur d’autorisation
• 3239 – échec de la modification
• 4202 – contact indisponible – erreur de connexion
• 4215 – échec de l’exécution – erreur de connexion

Données de réponse : Aucune – le résultat est transmis directement dans les champs de la réponse code/msg.

Exemple :

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT' \
  --data '{"tld": "eu", "contact": {"email": "esmeralda-new@wedos.com"}}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f6"
}