Documentación API
Integra Broken Link Scan en tu flujo de trabajo. Escanea sitios, obtén resultados y automatiza el monitoreo — todo a través de una API REST sencilla.
URL base
https://brokenlinkscan.com/api/v1 Autenticación
Todas las solicitudes API requieren una clave API enviada a través del encabezado X-Api-Key. Puedes generar tu clave API desde el panel de control.
curl -H "X-Api-Key: your_key" \
https://brokenlinkscan.com/api/v1/sitesLímite de solicitudes
Los usuarios autenticados tienen permitido realizar 300 solicitudes por minuto. Si excedes este límite, la API devuelve una respuesta 429 Too Many Requests.
Endpoints
/api/v1/sites Listar todos los sitios monitoreados del usuario autenticado.
/api/v1/sites Agregar un nuevo sitio para monitorear.
{ "url": "https://example.com", "name": "My Site" } /api/v1/sites/:id Eliminar un sitio monitoreado por ID.
/api/v1/sites/:id/scan Iniciar un escaneo bajo demanda para un sitio.
/api/v1/scans Listar todos los escaneos.
page (int), limit (int, default 20)
/api/v1/scans/:token Obtener el estado de un escaneo específico.
/api/v1/scans/:token/results Obtener los resultados detallados del escaneo.
status, category, search, page, limit
/api/v1/scans/:token/export.json Exportar los resultados del escaneo como JSON.
/api/v1/scans/:token/export.csv Exportar los resultados del escaneo como CSV.
/api/v1/scans/bulk Verificar en masa una lista de URLs en una sola solicitud.
{ "urls": ["https://a.com", "https://b.com"] } Formato de respuesta
Todas las respuestas son JSON. Las solicitudes exitosas devuelven los datos directamente. Los errores incluyen un campo message.
{
"data": [...],
"meta": { "page": 1, "limit": 20, "total": 42 }
}{
"error": { "code": 401, "message": "Invalid API key" }
}¿Necesitas acceso a la API?
La API REST está disponible en el plan Pro. Actualiza hoy y comienza a automatizar el monitoreo de tus enlaces rotos.
Actualizar a Pro