API Email — Valider une adresse email (REST)

Support DQE
Support DQE
  • Mise à jour

Utilisez ce endpoint pour valider une adresse email et obtenir des informations sur sa syntaxe, son domaine et son statut d'activité.

Documentation Restful Email associée :

Requête GET

Endpoint

GET https://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Email={EMAIL}&Licence={LICENCE_CODE}&Rectify={RECTIFY}&CheckUser={CHECK_USER}&TimeOut={TIME_OUT}

Remplacez les valeurs entre accolades par vos propres informations.

Paramètre Description Obligatoire/Facultatif
Email Adresse email à valider. Obligatoire
Licence Code de licence associé à votre compte. Obligatoire
Rectify Y pour recevoir une suggestion de correction lorsque la syntaxe est invalide ou le domaine inconnu. Facultatif
CheckUser N si vous ne souhaitez pas vérifier la partie avant le signe @ (nom d'utilisateur). Facultatif
TimeOut Temps de requête maximum pour la vérification, en secondes. Exemple : 0.5 pour 500 ms. Facultatif

Requête POST

Endpoint

POST https://{SERVER_ADDRESS}/{VERSION}/lookupemail/

Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.

Paramètre Description Obligatoire/Facultatif
Email Adresse email à valider. Obligatoire
Licence Code de licence associé à votre compte. Obligatoire
Rectify Y pour recevoir une suggestion de correction lorsque la syntaxe est invalide ou le domaine inconnu. Facultatif
CheckUser N si vous ne souhaitez pas vérifier la partie avant le signe @ (nom d'utilisateur). Facultatif
TimeOut Temps de requête maximum pour la vérification, en secondes. Exemple : 0.5 pour 500 ms. Facultatif

Réponse

Réponse de succès

La réponse JSON est un dictionnaire contenant le nombre de résultats et un tableau des adresses email validées.

Clé Description Type
Found Nombre d'adresses email retournées. INTEGER
Emails Tableau des résultats de validation, une entrée par adresse email soumise. ARRAY
ActivityCode Statut d'activité de l'adresse email. Voir la référence des codes de réponse de l'API. STRING
IdError Code retour de validation. Voir la référence des codes de réponse de l'API. STRING
Corrected 1 si une correction a été appliquée ; 0 sinon. INTEGER
SuggestedEmail Adresse email corrigée, renvoyée quand Rectify=Y et qu'une correction a été trouvée. STRING
InputEmail Adresse email telle que soumise dans la requête. STRING

Exemple :

{
  "Found": 1,
  "Emails": [
    {
      "ActivityCode": "",
      "IdError": "02",
      "Corrected": 0,
      "SuggestedEmail": "toto@gmail.com",
      "InputEmail": "toto@gmail.com"
    }
  ]
}

Réponse d'erreur

Type d'erreur Type de réponse
Paramètre obligatoire manquant ou vide 400 Bad Request
Licence invalide ou non autorisée 401 Unauthorized

Exemple (400) :

{
  "status": 400,
  "message": "Missing parameters",
  "details": "Email",
  "error": "bad request"
}

Exemple (401) :

{
  "status": 401,
  "message": "Your licence is not allowed to cover this functionnality",
  "details": "{WRONG LICENSE}",
  "error": "unauthorized_client"
}

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0