Comment intégrer notre solution LIVE ENSOEMAIL
Historique
Date | Numéro de version | Description |
28/02/2022 | 1.0 | Version 1 – lancement de l’API EnsoEmail |
La solution EnsoEmail est mise à disposition via une API REST afin de vous accompagner dans vos processus de validation, vérification online.
La solution EnsoEmail s’appuie sur les technologies/ vérifications suivantes pour vous garantir un taux de 99% de fiabilité des résultats :
- Vérification syntaxique de l'e-mail
- Vérification du domaine
- Test SMTP
- Mail temporaire/Jetable
- Correction de faute de frappe
Authentification
Afin d’accéder à nos services, il est indispensable de s’authentifier via une clé unique sécurisé (ou token) qui vous est fourni par Data Enso.
Votre token doit être intégré dans le header sous le paramètre « api_key » et présent lors de chaque appel à l’API Enso Email.
Appels sur les serveurs
Les appels au service EnsoEmail doivent être réalisés sur l’URL suivante :
https://api.dataenso.com/mail
Appel API ENSOEMAIL
Afin de vérifier une adresse e-mail en temps réel et obtenir des résultats fiables, voici la liste des champs disponibles pour composer votre recherche.
Champ | Statut | Type | Example | Commentaires |
Api_key | Required | String | your-api-key | Token généré par Data Enso |
Required | String | email-test@dataenso.com | Adresse e-mail à vérifier |
Réponse de l’appel API
Après avoir réalisé l’appel à nos services, voici les champs disponibles en retour :Champ | Type | Example | Commentaires |
string | email-test@dataenso.com | L’adresse e-mail vérifiée. | |
result | string | « ok » | Le résultat de la vérification de l’e-mail : ok, catch_all, unknown, error, disposable, invalid |
resultcode | integer | 1 | Le résultat de la vérification de l’e-mail en « integer » : 1 (ok), 2 (catch_all), 3 (unknown), 4 (error), 5 (disposable), 6 (invalid) |
subresult | string | « ok » | Détail additionnel de la vérification : « unknown » « ok » « internal_error » « invalid_syntax » « no_local_ip_available » « dns_server_failed » « dns_no_mx » « dns_no_a » « could_not_connect » « no_code_in_banner » « invalid_banner_code » « no_code_in_ehlo_response » « no_code_in_helo_response » « no_code_in_mail_from_response » « no_code_in_rcpt_to_response » « ip_blocked » « no_mailbox » « mailbox_disabled » « mailbox_full » « greylisted » « connection_lost » « connection_timeout » « connection_refused » « connection_reset_by_peer » « connection_no_route_to_host » « host_not_accept_incoming_mail » « mail_service_unavailable » « bad_domain » « dns_error » « anti_spam_system » « dns_no_domain » « dns_refused » « timeout_error » |
didyoumean | string | Suggestion de correction automatique pour les fautes de frappe courantes. | |
error | string | Message d’erreur affiché ici si le résultat est « error ». | |
livemode | boolean | Si la demande a été faite avec une API Key de prod ou de test |
Exemple de requête
https://api.dataenso.com/mail/?mail=email-test@dataenso.com \
-h "api_key:your-token"
Réponse :
{
"email": "email-test@dataenso.com",
"result": "invalid",
"resultcode": 6,
"subresult": "no_mailbox",
"didyoumean": "",
"error": "",
"livemode": true
}
Exemple de codes retours
API Response
{
"email": "testemail@gmal.com",
"result": "invalid",
"resultcode": 6,
"subresult": "unknown",
"didyoumean": "testmail@gmail.com",
"error": "",
"livemode": true
}
API BAD API KEY Response
{
"email": "testemail@gmal.com",
"result": "error",
"resultcode": 4,
"subresult": "unknown",
"didyoumean": "testmail@gmail.com",
"error": "apikey_not_found",
"livemode": true
}
API Response Missing Email
{
"email": "",
"result": "error",
"resultcode": 4,
"subresult": "unknown",
"didyoumean": "",
"error": "No email specified",
"livemode": true
}
Pour recevoir par mail nos différentes Doc API merci de remplir le formulaire ci-dessous