Resposta rápida
Como sei se a WebReaderAPI está funcionando?
Chame GET https://webreaderapi.com/api/v1/credits com a sua chave: é gratuito, e uma resposta normal significa que a API e a sua chave funcionam. Se uma página falhar, o código de erro diz o motivo, e WebReaderAPI não cobra nada por isso. Incidentes do nosso lado são registrados no changelog com a data.
Qual é o teste de saúde mais rápido?
O endpoint de créditos. Ele responde sem buscar nenhum site, então testa apenas o nosso lado: autenticação, a API e a sua conta.
curl -s https://webreaderapi.com/api/v1/credits -H "Authorization: Bearer $WEBREADER_API_KEY"
Quais erros vêm do site e quais vêm de nós?
O código de erro diz onde está o problema. Nenhum desses erros usa um crédito.
| Código | Onde está o problema | O que fazer |
|---|---|---|
blocked_by_robots | O robots.txt do site recusa o nosso crawler | Nada: o site disse não |
blocked_by_site_policy | O site declara ai-input=no | Nada: o site disse não |
target_refused | O site respondeu 403, 429, um desafio ou um login | Tente mais tarde, ou peça acesso ao site |
fetch_failed | DNS, TLS, conexão, ou uma página 404/410 | Verifique a URL; tente novamente mais tarde |
fetch_timeout | O site não respondeu a tempo | Tente novamente com um timeout maior |
concurrency_limit | Muitas requisições ao mesmo tempo da sua conta | Diminua o ritmo ou peça um limite maior |
invalid_api_key, insufficient_credits | Sua chave ou seu saldo | Verifique o dashboard |
A página de erros detalha cada caso, com um loop de nova tentativa.
Por que não há um número de uptime ao vivo aqui?
Porque ainda não medimos um com uma amostra pública, e um número inventado enganaria você. O sucesso de uma leitura depende principalmente do site lido, então uma única porcentagem diria pouco. Quando publicarmos números, eles virão com o método, a amostra e a data.
Onde os incidentes são anunciados?
No changelog, com a data, os endpoints afetados e o que foi feito. Se você vir erros repetidos do nosso lado (códigos diferentes dos causados pelo site de destino), escreva para [email protected] com o horário da requisição e o código de erro.
Status: perguntas frequentes
Verificar meus créditos custa alguma coisa?
Não. GET https://webreaderapi.com/api/v1/credits nunca usa um crédito, então você pode chamá-lo em um teste de saúde quantas vezes quiser, dentro do seu limite de concorrência.
Uma página falha para mim mas abre no meu navegador. Por quê?
Geralmente porque o site trata robôs de forma diferente das pessoas: ele pode recusar o nosso crawler no robots.txt ou responder a requisições automatizadas com uma página de desafio. Devolvemos a resposta dele e não cobramos nada. O código de erro e target_status mostram o que o site enviou.
Leituras com falha são cobradas?
Não. 1 crédito = 1 página lida sem navegador; 2 créditos quando a página precisa de um navegador para renderizar JavaScript. Uma requisição que falha, ou que o robots.txt de um site recusa, não é cobrada.