Crear una nueva solicitud | Documentación | IP Geolocation Bulk API | API WhoisXML

Crear una nueva solicitud

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

Muestra de solicitud 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"}'

Ejemplo de cuerpo de solicitud POST

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

Parámetros de entrada

apiKey

Es necesario. Obtenga su clave API personal en la página Mis productos.

términos

Necesario. Matriz.

Contiene una serie de IP, correos electrónicos y nombres de dominio para obtener la geolocalización.

formato

Opcional. Cadena.

Se utiliza para especificar el formato de la respuesta.

Valores permitidos: "xml", "json", "csv".

Valor por defecto: "json".

Muestra de salida

{
    "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.
respuesta

El objeto de respuesta.

Contiene el campo entero 'id ' en caso de éxito.

En caso de error, contiene su descripción en el campo ' error'. Si hay varios errores se devuelven sus descripciones en el array ' errores '.

id

Entero.

ID de solicitud recién creada.

error

Cuerda.

Descripción del error.

errores

Array.

Múltiples mensajes de error.