Para equipos de desarrollo

Documentación de la API para proyectos y análisis web

La aplicación web usa una API para proyectos y análisis. Todo acceso a un proyecto se limita a la organización a la que pertenece.

Autenticación

Inicia sesión en POST /api/auth/login en el mismo dominio. El navegador recibe una cookie de sesión HttpOnly; la respuesta no incluye ningún token. Los endpoints de proyecto siguientes forman parte del BFF autenticado del navegador. Las solicitudes de escritura deben proceder del mismo origen. La API de backend subyacente permanece privada en la red de producción y usa internamente sesiones bearer. Por ahora no se ofrecen claves de API independientes ni una API externa pública para integradores.

Endpoints de proyectos y análisis

Endpoints de API disponibles
MétodoRutaDescripción
POST/api/auth/loginCorreo y contraseña → cookie de sesión HttpOnly
GET / POST/api/v1/projectsLeer / crear proyectos
POST/api/v1/projects/:id/scansIniciar un análisis de un proyecto propio
GET/api/v1/scans/:idLeer el estado de un análisis
GET/api/v1/scans/:id/summaryResumen y niveles de gravedad
GET/api/v1/scans/:id/pagesResultados de páginas paginados
GET/api/v1/scans/:id/export?format=csvExportar el informe como csv, json, html o pdf
GET / PUT/api/v1/projects/:id/monitoringLeer / configurar análisis programados

Análisis web público

POST /api/check con {"url":"https://example.com"} devuelve un análisis y un token de acceso. Consúltalo con GET /api/check/:id usando el token como bearer. El token pertenece exclusivamente a este análisis y no es un inicio de sesión. Obtienes un PDF en GET /api/check/:id/pdf; POST /api/check/:id/report con una dirección de correo encarga un envío único. Ambos necesitan el mismo token bearer del análisis. Una solicitud de contacto voluntaria en POST /api/check/:id/lead requiere además consent: true. No guardes el token en URL, registros ni enlaces públicos.

Errores y límites

Los datos no válidos devuelven 400, la falta de inicio de sesión 401, los accesos no permitidos 403 o 404, los límites agotados 429 y los servicios no disponibles temporalmente 503. La respuesta contiene un error comprensible. Las cuotas se comprueban en el servidor.

Informes

JSON sirve para tus propios análisis, CSV para hojas de cálculo, HTML para una documentación legible y PDF para un informe que puedes descargar directamente. POST /api/v1/scans/:id/email envía el informe una sola vez a la dirección confirmada de la cuenta. La exportación contiene los resultados de las páginas realmente analizadas e indica sus límites. Los datos de acceso, las direcciones de red internas y los destinos privados están bloqueados para el analizador.

¿Listo para el primer paso?

El escáner también funciona sin el widget instalado. Analiza primero una página importante de tu web.

Analizar gratisCrear un proyecto gratuito

Conocimiento práctico para tus próximos pasos

Todos los artículos de la sección de conocimiento