Fazer solicitações | Documentação | API de alerta de marca | API WhoisXML

Fazer solicitações

Ponto de extremidade da API

POST https://brand-alert.whoisxmlapi.com/api/v2
Leva até um minuto para ativar sua conta após o registro.

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 interface gráfica do usuário. Recomendamos usar o Postman com os pontos de extremidade das APIs WhoisXML ao explorar a funcionalidade das APIs, bem como quando estiver solucionando problemas com seu aplicativo.

A coleção Postman da API WhoisXML 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, entre em contato conosco.

Exemplo de corpo de solicitação POST

{
    "apiKey": "YOUR_API_KEY",
    "sinceDate": "2024-02-17",
    "mode": "purchase",
    "withTypos": false,
    "responseFormat": "json",
    "punycode": true,
    "includeSearchTerms": [
        "google",
        "blog"
    ],
    "excludeSearchTerms": [
        "analytics"
    ]
}

Cabeçalhos

X-Authentication-Token

Você pode usar esse cabeçalho ou o parâmetro apiKey para chamadas de API.

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

Parâmetros de entrada

apiKey

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

includeSearchTerms

Necessário. Conjunto de termos de pesquisa. Todos eles devem estar presentes no nome de domínio. Máximo de 4 itens. Não diferencia maiúsculas de minúsculas.

excludeSearchTerms

Opcional. Conjunto de termos de pesquisa. Todos eles NÃO devem estar presentes no nome de domínio. Máximo de 4 itens. Não diferencia maiúsculas de minúsculas.

sinceDate

Opcional. Data no formato "AAAA-MM-DD".

As datas permitidas estão no intervalo [Hoje menos 14 dias - Hoje].

Por padrão, a data de ontem.

Observe que os resultados de ontem geralmente estão disponíveis entre 10h e 12h UTC.

Se estiver presente, pesquise as atividades descobertas desde a data especificada. Às vezes, há uma latência entre a data real de adição/renovação/expiração e a data em que nosso sistema detectou essa alteração. Recomendamos usar esse campo em suas ferramentas de monitoramento para filtrar alterações diárias. alterações diárias.

modo

Opcional.

visualização - retorna apenas o número de domínios. Nenhum crédito é deduzido.

purchase (compra ) - retorna a lista real de domínios (limitada a 10.000). 1 solicitação custa 10 créditos DRS.

Valores aceitáveis: preview | purchase

Padrão: visualização

withTypos

Opcional. Se for verdadeiro, o conjunto de termos de pesquisa será enriquecido com seus possíveis erros de digitação. Por exemplo, para o termo "google", os erros de digitação podem ser: 'goigle', 'gokgle', 'golgle', 'gopgle', 'goglee', 'gooogle' etc.

Valores aceitáveis: false | true

Padrão: false

Com erros de digitação incluídos - 1 solicitação custa 300 créditos DRS.

Saiba mais: Perguntas frequentes sobre geração de erros de digitação

código de pontuação

Opcional. Se for verdadeiro, os nomes de domínio na resposta serão codificados em Punycode.

Valores aceitáveis: false | true

Padrão: true

formato de resposta

Opcional. Formato de saída da resposta.

Valores aceitáveis: json | xml

Padrão: json

Acesso gratuito

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

Limites de uso e limitação de solicitações

O número máximo de solicitações por segundo é 30. Caso o limite seja ultrapassado, suas solicitações subsequentes serão rejeitadas até o próximo segundo.

Essa API também está disponível com um balanceador de carga dedicado e um endpoint premium para permitir consultas mais rápidas como parte de nossos Premium API Services e Enterprise API Packages.