Fazer solicitações | Documentação | WHOIS API | WhoisXML API

Fazer solicitações

Nosso Hosted Whois Web Service fornece detalhes de registro, também conhecidos como registros WHOIS, nome de um domínio, um endereço IP ou um email.

O WhoisXMLAPI.com fornece RESTful APIs. Ela foi projetada para a comunicação de servidor para servidor entre seu sistema e a rede WhoisXMLAPI.com usando o protocolo HTTPs. As respostas das consultas são entregues no formato XML ou JSON com base em suas solicitações, que são feitas por meio dos métodos GET/POST.

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

Endpoints da API

Você pode usar os seguintes pontos de extremidade para fazer solicitações à WHOIS API:

  • Use o método GET com parâmetros de consulta
  • Use o método POST com o corpo JSON
OBTER https://www.whoisxmlapi.com/whoisserver/WhoisService?apiKey=API_KEY&domainName=google.com
POST https://www.whoisxmlapi.com/whoisserver/WhoisService
Leva até um minuto para ativar sua conta após o registro.

Exemplo de solicitação cURL com corpo no formato JSON

curl --location 'https://www.whoisxmlapi.com/whoisserver/WhoisService' \
    --header 'Content-Type: application/json' \
    --data '{
        "domainName": "google.com",
        "apiKey": "API_KEY"
    }'

Exemplo de solicitação cURL com um cabeçalho de autorização

curl --location 'https://www.whoisxmlapi.com/whoisserver/WhoisService?domainName=google.com' \
--header 'Authorization: Bearer %accessToken%'

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 pontos de extremidade das WhoisXML APIs ao explorar a funcionalidade das APIs, bem como quando estiver solucionando problemas com seu aplicativo.

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

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

Autorização: necessária

Use sua chave de API pessoal ou o token OAuth de servidor para servidor para autenticar suas solicitações. O senhor pode encontrar sua chave de API na página My products (Meus produtos ). A chave apiKey tem a prioridade mais alta. Se o senhor fornecer o parâmetro apiKey o serviço ignorará o parâmetro Autorização se ele estiver presente.

Por meio do parâmetro de consulta

apiKey

Obtenha sua chave de API pessoal na página My products (Meus produtos ).

Por meio do cabeçalho

Autorização

Chave de API ou token OAuth de servidor para servidor.

Esquema de autenticação: Portador.

Exemplo:
- Authorization: Bearer %API_KEY%
- Authorization (Autorização): Portador %OAUTH_ACCESS_TOKEN%

Parâmetros de entrada: necessário

domainName

O domínio/IPv4/IPv6/endereço de e-mail para o qual os dados WHOIS são solicitados.

Parâmetros de entrada: opcional

outputFormat

Formato de saída da resposta.

Valores aceitáveis: JSON | XML

Padrão: XML

preferFresh

1 resulta na obtenção do registro WHOIS mais recente, mesmo que esteja incompleto.

Valores aceitáveis: 0 | 1

Padrão: 0

da

1 resulta em uma verificação rápida da disponibilidade do domínio, 2 é mais lento, porém mais preciso. Os resultados são retornados em WhoisRecord → domainAvailability (AVAILABLE | UNAVAILABLE | UNDETERMINED)

Valores aceitáveis: 0 | 1 | 2

Padrão: 0

ip

1 resulta no retorno de IPs para o nome de domínio.

Valores aceitáveis: 0 | 1

Padrão: 0

ipWhois

1 resulta no retorno do registro WHOIS para o IP de hospedagem se o registro WHOIS para o tld do domínio de entrada não for compatível.

Valores aceitáveis: 0 | 1

Padrão: 0

checkProxyData

1 resulta na obtenção de dados de proteção de proxy/WHOIS, se existirem, no elemento de esquema WhoisRecord → privateWhoisProxy.

Valores aceitáveis: 0 | 1

Padrão: 0

thinWhois

1 resulta no retorno de dados WHOIS somente do registro, sem buscar dados do registrador. Os dados de registro retornados correspondem ao elemento do esquema WhoisRecord → registryData.

Valores aceitáveis: 0 | 1

Padrão: 0

ignoreRawTexts

1 resulta na remoção de todo o texto bruto da saída.

Valores aceitáveis: 0 | 1

Padrão: 0

retorno de chamada

Uma função javascript usada quando outputFormat é JSON; essa é uma implementação conhecida como JSONP, que invoca o retorno de chamada na resposta retornada.

registryRawText

Uma cadeia de caracteres que representa o texto bruto do WHOIS do registro a ser analisado; funciona somente quando o parâmetro _parse é igual a 1.

registrarRawText

Uma cadeia de caracteres que representa o texto bruto do WHOIS do registrador a ser analisado; funciona somente quando o parâmetro _parse é igual a 1.

multiIdIana

1 resulta em uma correspondência IANA de várias IDs para analisar registrarName e obter registrarIANAID quando não é uma correspondência estrita.

Valores aceitáveis: 0 | 1

Padrão: 0

_parse

1 fornece análise para os textos brutos de entrada do WHOIS descritos abaixo.

Valores aceitáveis: 0 | 1

Padrão: 0

_hardRefresh

1 fornece dados em tempo real, mas custará 5 créditos de WHOIS API.

Valores aceitáveis: 0 | 1

Padrão: 0

Acesso gratuito

Após a inscrição, você recebe automaticamente um plano de assinatura gratuito limitado a 500 consultas.