Guia do usuário da API Bulk Whois (antigo) | Documentação | Bulk WHOIS API | WhoisXML API

Guia do usuário da Bulk Whois API (antigo)

A Bulk Whois API fornece registros Whois para uma lista de Domínios/IPs por meio de uma única consulta à REST API. Ela foi projetada para comunicação de servidor para servidor entre seu sistema e a rede WhoisXmlApi.com usando protocolos HTTP ou HTTPS padrão. As respostas da consulta são fornecidas no formato XML ou JSON com base em suas solicitações que são feitas por meio de métodos POST.

Para começar, você precisa de uma conta no WhoisXmlApi.com. A autenticação é necessária todas as vezes para usar a API. As primeiras 500 chamadas à Bulk Whois API são gratuitas quando você se registra em uma conta gratuita. 

Como fazer uma chamada para o Bulk Whois API Web Service

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/bulkWhois

Forneça os parâmetros codificados em JSON no corpo da solicitação, definindo o cabeçalho Content-Type para application/json. A resposta do servidor conterá o campo solicitado, que será necessário para recuperar os registros WHOIS solicitados.

Exemplo de resposta JSON

{
  "domains": [
    "google.com",
    "yahoo.com"
  ],
  "username": "your_username",
  "password": "********",
  "outputFormat": "JSON"
}

Parâmetros de entrada

domínios

Obrigatório. Uma matriz de domínios para os quais os dados WHOIS são solicitados

nome de usuário

Obrigatório. Nome de usuário da sua conta

senha

Obrigatório. A senha de sua conta.

Certifique-se de que ele esteja codificado por URL se contiver caracteres especiais (&, %, * etc.).

outputFormat

Formato de saída da resposta.

Valores aceitáveis: JSON | XML

Padrão: XML

Saída de amostra

{
  "noDataAvailable": false,
  "message": "OK",
  "messageCode": 200,
  "requestId": "ece0f949-c22a-4ecc-..."
}

Obtenção de registros Whois

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/getRecords

Como o processamento de todos os domínios de entrada pode levar algum tempo, você terá que consultar repetidamente esse recurso até que os recordsLeft retornado seja 0.

Defina o valor maxRecords para 1 se não for necessário monitorar o progresso de cada registro.

Caso contrário, cada elemento da matriz whoisRecords contém o whoisRecordStatus campo:

  • 0 - processado;
  • 1/2 - dados incompletos / ausentes;
  • 3 - processamento.

Exemplo de solicitação JSON

{
  "requestId": "ece0f949-c22a-4ecc-...",
  "maxRecords": 1,
  "username": "your_username",
  "password": "********",
  "startIndex": 1,
  "outputFormat": "JSON"
}

Parâmetros de entrada

nome de usuário

Obrigatório. Nome de usuário da sua conta

senha

Obrigatório. A senha de sua conta.

Certifique-se de que ele esteja codificado por URL se contiver caracteres especiais (&, %, * etc.).

requestId

Obrigatório. String.

Identificador de solicitação em massa.

maxRecords

Necessário. Número.

Quantidade máxima de registros WHOIS a serem retornados.

startIndex

Opcional. Número.

O primeiro registro WHOIS a ser retornado pelo servidor.

Valores aceitáveis: 1+

Padrão: 1

outputFormat

Opcional. Formato de saída da resposta.

Valores aceitáveis: JSON | XML

Padrão: XML

Download do resultado CSV

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/download

Exemplo de solicitação JSON

{
  "requestId": "ece0f949-c22a-4ecc-...",
  "username": "your_username",
  "password": "********",
  "searchType": "all"
}

Parâmetros de entrada

nome de usuário

Obrigatório. Nome de usuário da sua conta

senha

Obrigatório. A senha de sua conta.

Certifique-se de que ele esteja codificado por URL se contiver caracteres especiais (&, %, * etc.).

requestId

Obrigatório. String.

Identificador de solicitação em massa.

searchType

Opcional. String.

noError permite filtrar registros com erros de processamento, sem dados etc.

Valores aceitáveis: all | noError

Padrão: todos

Recuperação da lista de suas solicitações

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/getUserRequests

Exemplo de solicitação JSON

{
  "noDataAvailable": false,
  "userRequests": [
    {
      "requestId": "f1008d3e-7774-495b-...",
      "time": 1498282373092,
      "status": "Completed",
      "totalRecords": 4,
      "fetchedRecords": 0
    }
  ]
}

Parâmetros de entrada

nome de usuário

Obrigatório. Nome de usuário da sua conta

senha

Obrigatório. A senha de sua conta.

Certifique-se de que ele esteja codificado por URL se contiver caracteres especiais (&, %, * etc.).

outputFormat

Opcional. Formato de saída da resposta.

Valores aceitáveis: JSON | XML

Padrão: XML

Acesso gratuito

Depois de se inscrever, você recebe automaticamente um plano de assinatura gratuito limitado a 500 .