Créer une nouvelle requête | Documentation | Email Verification Bulk API | WhoisXML API

Créer une nouvelle demande

POST https://emailverification.whoisxmlapi.com/api/bevService/request

Exemple de requête CURL

curl https://emailverification.whoisxmlapi.com/api/bevService/request -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "version": 3, "emails": ["alex@hotmail.edu", "bob@google.com", "mila@yahoo.com"], "format": "json"}'

Exemple de corps de requête POST

{
    "apiKey": "YOUR_API_KEY",
    "version": 3,
    "emails": [
        "alex@hotmail.edu",
        "bob@google.com",
        "mila@yahoo.com"
    ],
    "format": "json"
}

Paramètres d'entrée

apiKey

Nécessaire. Obtenez votre clé API personnelle sur la page Mes produits.

emails

Requis. Array.

Contient un tableau d'adresses électroniques à vérifier.

version

Optionnel. Nombre.

Définit la version de Email Verification API à utiliser.

Valeurs autorisées : 2 et 3.

Valeur par défaut : 2. Veuillez utiliser la version 3 de l'API après le 30 avril 2024.

REMARQUE : la version 2 de l'Email Verification API est en cours de suppression suite au lancement de la version 3, qui offre une meilleure stabilité et des résultats plus précis. Pour en savoir plus sur la nouvelle version, veuillez consultercette page de spécifications. Après le 30 avril 2024, l'API v2 sera supprimée et les requêtes ne seront plus servies.

format

Facultatif. string.

Permet de spécifier le format de réponse.

Valeurs autorisées : « xml », « json », « csv ».

Valeur par défaut : « json ».

Exemple de sortie

{
    "response": {
        "id": 5
    }
}

Code: 200 OK.
{
    "response": {
        "errors": [
            "The format field should have one of the following values: json, xml."
        ]
    }
}

Code: 400 Bad Request.
{
    "response": {
        "error": "Authorisation or authentication failed"
    }
}

Code: 401 Unauthorized.
{
    "response": {
        "error": "Insufficient balance"
    }
}

Code: 402 Payment Required.
response

L’objet response.

Contient le champ entier "id" en cas de succès.

En cas d’erreur, il contient sa description dans le champ 'erreur' . S’il y a plusieurs erreurs, leurs descriptions sont renvoyées dans le tableau 'errors' .

id

Entier.

ID de la demande de vérification nouvellement créée.

error

String.

Description de l’erreur.

errors

Tableau.

Plusieurs messages d’erreur.