Créer une nouvelle requête | Documentation | IP Geolocation Bulk API | WhoisXML API

Créer une nouvelle demande

POST https://ip-geolocation.whoisxmlapi.com/api/bgservice/request

Exemple de requête CURL

curl https://ip-geolocation.whoisxmlapi.com/api/bgservice/request -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "terms": ["[email protected]", "8.8.8.8", "yahoo.com"], "format": "json"}'

Exemple de corps de requête POST

{
    "apiKey": "YOUR_API_KEY",
    "terms": [
        "[email protected]",
        "8.8.8.8",
        "yahoo.com"
    ],
    "format": "json"
}

Paramètres d'entrée

apiKey

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

terms

Requis. Array.

Contient un ensemble d'adresses IP, d'adresses électroniques et de noms de domaine pour obtenir une géolocalisation.

format

Facultatif. Chaîne.

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

Entier.

ID de la demande nouvellement créée.

error

Chaîne de caractères.

Description de l'erreur.

errors

Array.

Plusieurs messages d'erreur.