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

Fazer solicitações

Endpoint da API

OBTER https://website-screenshot.whoisxmlapi.com/api/v1?apiKey=YOUR_API_KEY&url=google.com&credits=DRS
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. Recomendamos usar o Postman com os WhoisXML APIs endpoints 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:

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

Parâmetros de entrada

apiKey

Required. Obtenha sua API KEY pessoal na página Meus produtos.

url

Required. O URL do site de destino.

Também há suporte para a especificação de números de porta, por exemplo, example.com:80.

Observe que, se o URL contiver alguns "caracteres especiais", por exemplo, '&, ?, #, =', você deverá codificar o URL.

credits

Optional.

SA - Os créditos da API de captura de tela serão levados em conta quando a API for chamada.

DRS - Os créditos do Domain Research Suite serão levados em conta quando a API for chamada.

Acceptable values: SA | DRS

Default: SA

imageOutputFormat

Optional. Formato de saída da resposta.

Acceptable values: image | base64

Padrão: image

errorsOutputFormat

Optional. Formato de saída dos erros.

Acceptable values: JSON | XML

Padrão: JSON

type

Optional. Tipo de saída de imagem.

Acceptable values: jpg | png | pdf

Padrão: jpg

quality

Optional. Qualidade da imagem. (somente para o tipo jpg ).

Valores aceitáveis: 40 < qualidade < 99

Padrão: jpg

width

Optional. Largura da imagem (px).

Valores aceitáveis: 100 < largura < 3000

Padrão: 800

height

Optional. Altura da imagem (px).

Valores aceitáveis: 100 < largura < 3000

Padrão: 600

thumbWidth

Optional. Largura do polegar da imagem (px).

Valores aceitáveis: 50 < thumbWidth < width param value

Padrão: 0

mode

Optional.

fast - aguardando o document.load event.

slow - aguardando o evento de ociosidade da rede.

Acceptable values: fast | slow

Padrão: rápido

scroll

Optional. Se especificado (qualquer valor), rola para baixo e para a scrollPosition (útil para capturas de tela de página inteira).

scrollPosition

Optional. Especifica o comportamento da scroll

Acceptable values: top | bottom

Padrão: top

fullPage

Optional. Se especificado (qualquer valor), faz uma captura de tela de página inteira.

noJs

Optional. Se especificado (qualquer valor), desativa o JS.

delay

Optional. Atraso personalizado (ms) antes da captura de tela.

Valores aceitáveis: 0 < delay < 10000 ms

Padrão: 250

timeout

Optional. Tempo limite personalizado (ms) para o carregamento da página. A API responderá com um erro se nosso servidor não conseguir carregar a página dentro do tempo limite especificado.

Valores aceitáveis: 1000 < timeout < 30000 ms

Padrão: 15000

scale

Optional. valor do deviceScaleFactor para o emulador.

Valores aceitáveis: 0,5 < scale < 4,0

Padrão: 1,0

retina

Optional. Se especificado (qualquer valor), emula a tela de retina.

ua

Optional. A cadeia de cabeçalho "User-Agent".

cookies

Optional. A string de cabeçalho 'Cookie' no seguinte formato: name1=value1;name2=value2.

Verifique se a string de consulta está codificada corretamente.

mobile

Optional. Se especificado (qualquer valor), emula o dispositivo móvel.

touchScreen

Optional. Se especificado (qualquer valor), emula o dispositivo com telas sensíveis ao toque.

landscape

Optional. Se especificado (qualquer valor), renderiza a página no modo paisagem (útil para emulação de smartphone).

failOnHostnameChange

Optional. Se especificado (qualquer valor), a API responderá com o código de erro 422 HTTP quando o domínio de destino for alterado devido a redirecionamentos.

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 minuto é 120. Caso o limite seja ultrapassado, suas solicitações subsequentes serão rejeitadas até o próximo minuto.

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.