Formuler des demandes

Postman collection

Postman est une application web et de bureau qui vous permet de faire des demandes à une API à partir d'une interface utilisateur graphique. Nous recommandons d'utiliser Postman avec les points d'extrémité des API WhoisXML pour explorer les fonctionnalités des API, ainsi que pour résoudre les problèmes liés à votre application.

La collection Postman de l'API WhoisXML est disponible aux liens suivants :

La collection comprend un environnement préconfiguré. Vous devrez configurer la clé_api pour déclencher chaque requête. Obtenez votre CLÉ d'API personnelle sur la page Mes produits. Si vous avez des questions relatives à l'API, contactez-nous.

Créer une nouvelle demande

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

Afin de vérifier les listes d'e-mails avec l'API Bulk, veuillez d'abord télécharger les e-mails sur le serveur, ce qui créera une requête et vous renverra son identifiant. Vous pourrez ensuite utiliser cet identifiant pour consulter le statut de la requête, télécharger les résultats, etc.

L'API attend que les paramètres soient encodés au format JSON dans le corps de chaque requête.

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", "emails": ["[email protected]", "[email protected]", "[email protected]"], "format": "json"}'

Exemple de corps de requête POST

{
    "apiKey": "YOUR_API_KEY",
    "emails": [
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ],
    "format": "json"
}

Input parameters

apiKey

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

emails

Requis. Array.

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

format

Facultatif. String.

Permet de spécifier le format de la 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 de la réponse.

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

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

id

Integer.

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

error

String.

Description de l'erreur.

errors

Array.

Plusieurs messages d'erreur.