Fazer solicitações

Coleção Postman

O Postman é um aplicativo de desktop e da Web que permite fazer solicitações a uma API a partir de uma interface gráfica de usuário. Recomendamos usar o Postman com os endpoints das WhoisXML APIs ao explorar a funcionalidade das APIs, bem como quando estiver solucionando problemas com seu aplicativo.

A coleção WhoisXML API Postman está disponível nos seguintes links:

• https://www.postman.com/whoisxmlapi-llc?tab=collections
• postman.whois.xml.api.zip

A coleção inclui um ambiente pré-configurado. Você precisará configurar a api_key para enviar cada solicitação. Obtenha sua chave de API pessoal na página Meus produtos. Se você tiver dúvidas relacionadas à API, fale conosco.

Criar uma nova solicitação

Para verificar listas de e-mails com a API em massa, primeiro envie os e-mails para o servidor, que criará uma solicitação e retornará seu ID para você. Em seguida, você pode usar esse ID para consultar o status da solicitação, baixar resultados etc.

A API espera que os parâmetros sejam codificados em JSON no corpo de cada solicitação.

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

Exemplo de corpo de solicitação POST

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

Parâmetros de entrada

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.