Documentação da API
Integre o Broken Link Scan ao seu fluxo de trabalho. Escaneie sites, obtenha resultados e automatize o monitoramento — tudo por meio de uma API REST simples.
URL base
https://brokenlinkscan.com/api/v1 Autenticação
Todas as requisições API exigem uma chave API enviada pelo cabeçalho X-Api-Key. Você pode gerar sua chave API no painel.
curl -H "X-Api-Key: your_key" \
https://brokenlinkscan.com/api/v1/sitesLimitação de taxa
Usuários autenticados podem realizar 300 requisições por minuto. Se você exceder esse limite, a API retorna uma resposta 429 Too Many Requests.
Endpoints
/api/v1/sites Listar todos os sites monitorados do usuário autenticado.
/api/v1/sites Adicionar um novo site para monitorar.
{ "url": "https://example.com", "name": "My Site" } /api/v1/sites/:id Remover um site monitorado pelo ID.
/api/v1/sites/:id/scan Iniciar um scan sob demanda para um site.
/api/v1/scans Listar todos os scans.
page (int), limit (int, default 20)
/api/v1/scans/:token Obter o status de um scan específico.
/api/v1/scans/:token/results Obter os resultados detalhados do scan.
status, category, search, page, limit
/api/v1/scans/:token/export.json Exportar os resultados do scan como JSON.
/api/v1/scans/:token/export.csv Exportar os resultados do scan como CSV.
/api/v1/scans/bulk Verificar em massa uma lista de URLs em uma única requisição.
{ "urls": ["https://a.com", "https://b.com"] } Formato de resposta
Todas as respostas são JSON. Requisições bem-sucedidas retornam os dados diretamente. Erros incluem um campo message.
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
}{
"error": { "code": 401, "message": "Invalid API key" }
}Precisa de acesso à API?
A API REST está disponível no plano Pro. Faça upgrade hoje e comece a automatizar o monitoramento de links quebrados.
Fazer upgrade para Pro