Utilisez cet endpoint pour suggérer des adresses e-mail à partir du nom, du prénom et d'une partie d'adresse e-mail saisis par l'utilisateur.
Documentation Email associée :
- Email introduction
- DQEEMAILLOOKUP — Email validation
- Email API Swagger documentation
- Email output columns
Requête GET
Endpoint
https://{SERVER_ADDRESS}/MAILSUGGEST/?Nom={NAME}&Prenom={FIRST_NAME}&Email={EMAIL}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}
Remplacez les valeurs entre accolades par vos propres informations :
| Paramètre | Valeur | Description | Obligatoire/Optionnel |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} |
Adresse du serveur DQE qui traitera les données. | Obligatoire |
| Licence | {LICENCE_CODE} |
Code de licence attribué à votre compte. | Obligatoire |
| Nom | {NAME} |
Nom saisi dans le formulaire. | Obligatoire ; peut être vide. |
| Prenom | {FIRST_NAME} |
Prénom saisi dans le formulaire. | Obligatoire ; peut être vide. |
{EMAIL} |
Partie de l'e-mail déjà saisie par l'utilisateur. | Obligatoire ; peut être vide. | |
| Pays | {COUNTRY_CODE} |
Code pays ISO à 3 lettres. | Optionnel. Valeur par défaut : FRA. |
Requête POST
Endpoint
https://{SERVER_ADDRESS}/MAILSUGGEST/
Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.
| Paramètre | Valeur | Description | Obligatoire/Optionnel |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Code de licence attribué à votre compte. | Obligatoire |
| Nom | {NAME} |
Nom saisi dans le formulaire. | Obligatoire ; peut être vide. |
| Prenom | {FIRST_NAME} |
Prénom saisi dans le formulaire. | Obligatoire ; peut être vide. |
{EMAIL} |
Partie de l'e-mail déjà saisie par l'utilisateur. | Obligatoire ; peut être vide. | |
| Pays | {COUNTRY_CODE} |
Code pays ISO à 3 lettres. | Optionnel. Valeur par défaut : FRA. |
Réponse
Réponse de succès
La réponse JSON est un dictionnaire contenant la clé suggest. Sa valeur est un tableau d'adresses e-mail suggérées.
| Clé | Description | Type |
|---|---|---|
| Instance | Numéro d'instance transmis en paramètre lors de la requête. | STRING(3) |
| syntaxe |
ok ou ko. |
STRING(2) |
| suggest | Liste des adresses e-mail suggérées. | ARRAY |
Exemple :
{
"Instance": "0",
"suggest": [
"ttesta@",
"testat@",
"t.testa@",
"testbtesta@",
"ttestb@",
"testatestb@",
"testa.testb@",
"testb.testa@",
"testb-testa@",
"testa-testb@",
"t-testa@",
"testa-t@"
],
"syntaxe": "ok"
}
Réponse d'erreur
| Type d'erreur | Type de réponse |
|---|---|
Paramètre Licence manquant |
400 Bad Request |
Paramètre Licence vide |
400 Bad Request |
| Numéro de licence incorrect | Réponse vide |
Voir aussi
Associé à