Criar uma nova solicitação | Documentação | IP Geolocation Bulk API | WhoisXML API

Criar uma nova solicitação

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

Exemplo de solicitação 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"}'

Exemplo de corpo de solicitação POST

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

Parâmetros de entrada

apiKey

Obrigatório. Obtenha sua chave de API pessoal na página Meus produtos.

terms

Necessário. Matriz.

Contém uma matriz de IPs, e-mails e nomes de domínio para obter a geolocalização.

format

Opcional. String.

Usado para especificar o formato da resposta.

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

Valor padrão: "json".

Saída de amostra

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

O objeto de resposta.

Contém o campo inteiro 'id' em caso de sucesso.

No caso de um erro, ele contém sua descrição no campo "error". Se houver vários erros, suas descrições serão retornadas na matriz "errors".

id

Inteiro.

ID da solicitação recém-criada.

error

Cordas.

Descrição do erro.

errors

Matriz.

Várias mensagens de erro.