API Email — Suggérer une adresse email (REST)

Support DQE
Support DQE
  • Mise à jour

Utilisez ce endpoint pour obtenir une liste de suggestions d'adresses email basées sur le prénom, le nom et les caractères déjà saisis par l'utilisateur dans le champ email.

Documentation Restful Email associée :

Requête GET

Endpoint

GET https://{SERVER_ADDRESS}/{VERSION}/emailsuggest/?FirstName={FIRST_NAME}&LastName={LAST_NAME}&Email={EMAIL}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}

Remplacez les valeurs entre accolades par vos propres informations.

Paramètre Description Obligatoire/Facultatif
FirstName Prénom saisi par l'utilisateur. Obligatoire
LastName Nom saisi par l'utilisateur. Obligatoire
Email Partie de l'adresse email déjà saisie par l'utilisateur. Obligatoire
Country Code pays ISO à 3 lettres. Obligatoire
Licence Code de licence associé à votre compte. Obligatoire

Requête POST

Endpoint

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

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

Paramètre Description Obligatoire/Facultatif
FirstName Prénom saisi par l'utilisateur. Obligatoire
LastName Nom saisi par l'utilisateur. Obligatoire
Email Partie de l'adresse email déjà saisie par l'utilisateur. Obligatoire
Country Code pays ISO à 3 lettres. Obligatoire
Licence Code de licence associé à votre compte. Obligatoire

Réponse

Réponse de succès

La réponse JSON est un dictionnaire contenant le nombre de résultats et un tableau de suggestions d'email.

Clé Description Type
Found Nombre de résultats de suggestion retournés. INTEGER
Suggestion Tableau des résultats de suggestion. ARRAY
Instance Valeur personnalisée renvoyée telle quelle dans la réponse. STRING
InputEmail Valeur de l'email telle que soumise dans la requête. STRING
Syntaxe ok ou ko, selon la syntaxe de l'email déjà saisi. STRING
List Liste des adresses email suggérées. ARRAY
ListCount Nombre d'adresses email suggérées dans List. INTEGER

Exemple :

{
  "Found": 1,
  "Suggestion": [
    {
      "Instance": "0",
      "InputEmail": "",
      "Syntaxe": "ok",
      "List": [
        "jlim@"
      ],
      "ListCount": 8
    }
  ]
}

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": "FirstName",
  "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

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

Utilisateurs qui ont trouvé cela utile : 0 sur 0