L'API de vérification d'e-mail unitaire en temps réel permet, comme son nom l'indique, de vérifier l'existence d'une adresse e-mail en "temps réel".
La notion de "temps réel" signifie que le résultat de la vérification sera directement présent dans la réponse de l'API.
La requête
curl -X POST https://api.klemail.io/v1/verify/single/realtime \
-H "Authorization: Token YOUR-API-KEY-HERE" \
-H "Content-Type: application/json" \
--data '{"email":"[email protected]"}'
import requests
res = requests.post(
"https://api.klemail.io/v1/verify/single/realtime
json={"email": "[email protected]"},
headers={"Authorization": "Token YOUR-API-KEY-HERE"}
)
Cet endpoint permet de vérifier une adresse e-mail "rapidement". Cela signifie que le résultat de la vérification sera directement dans la réponse de l'API.
La requête pour vérifier une adresse e-mail doit être en POST, et l'e-mail doit être passé dans le body de la requête au format JSON.
En règle générale la vérification d'une adresse e-mail est rapide, cependant dans quelques cas particuliers nous avons constaté que la vérification peut prendre plus de temps. Pour cette raison, si la vérification ne se termine pas dans un délai de 60 secondes, la vérification sera annulée et le résultat BAD_OTHER sera renvoyé.
Si vous avez besoin d'appliquer un timeout inférieur à 60 secondes, nous vous conseillons d'utiliser les options fournit par les outils/bibliothèques que vous utilisez. Voici quelques exemples.
curl -X POST https://api.klemail.io/v1/verify/single/realtime \
-H "Authorization: Token YOUR-API-KEY-HERE" \
-H "Content-Type: application/json" \
--data '{"email":"[email protected]"}'
--max-time 15
import requests
res = requests.post(
"https://api.klemail.io/v1/verify/single/realtime
json={"email": "[email protected]"},
headers={"Authorization": "Token YOUR-API-KEY-HERE"}
timeout=15
)
Les résultats
Le résultat de cette requête est lui aussi au format JSON.
{
"email": "[email protected]",
"status": "GOOD",
"simple_status": "Good",
"generic_email": False,
"disposable_email": False,
"free_email": False,
"created_at": "2021-05-03T19:15:33.545840Z",
"modified_at": "2021-05-03T19:15:33.545840Z",
"started_at": "2021-05-03T19:13:15.176759Z",
"ended_at": "2021-05-03T19:15:33.492947Z",
}
Pour plus d'information sur les variables "status" et "simple_status", voir la terminologie