Fazer solicitações | Documentação | API de captura de tela | API WhoisXML

Fazer solicitações

Ponto de extremidade 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 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.

Parâmetros de entrada

apiKey

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

url

Obrigatório. 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.

créditos

Opcional.

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.

Valores aceitáveis: SA | DRS

Padrão: SA

imageOutputFormat

Opcional. Formato de saída da resposta.

Valores aceitáveis: image | base64

Padrão: imagem

errorsOutputFormat

Opcional. Formato de saída dos erros.

Valores aceitáveis: JSON | XML

Padrão: JSON

tipo

Opcional. Tipo de saída de imagem.

Valores aceitáveis: jpg | png | pdf

Padrão: jpg

qualidade

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

Valores aceitáveis: 40 < qualidade < 99

Padrão: jpg

largura

Opcional. Largura da imagem (px).

Valores aceitáveis: 100 < largura < 3000

Padrão: 800

altura

Opcional. Altura da imagem (px).

Valores aceitáveis: 100 < largura < 3000

Padrão: 600

largura do polegar

Opcional. Largura do polegar da imagem (px).

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

Padrão: 0

modo

Opcional.

fast - aguardando o evento document.load.

lento - aguardando o evento de ociosidade da rede.

Valores aceitáveis: rápido | lento

Padrão: rápido

rolagem

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

scrollPosition

Opcional. Especifica o comportamento da rolagem

Valores aceitáveis: superior | inferior

Padrão: top

fullPage

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

noJs

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

atraso

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

Valores aceitáveis: 0 < atraso < 10000 ms

Padrão: 250

tempo limite

Opcional. 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 < tempo limite < 30000 ms

Padrão: 15000

escala

Opcional. valor do deviceScaleFactor para o emulador.

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

Padrão: 1,0

retina

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

ua

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

cookies

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

Verifique se a string de consulta está codificada corretamente.

móvel

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

touchScreen

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

paisagem

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

failOnHostnameChange

Opcional. Se especificado (qualquer valor), a API responderá com o código de erro HTTP 422 quando o nome de 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 ponto de extremidade premium para permitir consultas mais rápidas como parte de nossos Premium API Services e Enterprise API Packages.