Rocket Validator es un servicio de validación de accesibilidad y HTML para todo el sitio web. Escanea automáticamente tu sitio web y valida cada página web interna encontrada utilizando dos validadores: Axe Core para encontrar problemas de accesibilidad, y el W3C Validator Nu para validación HTML.
Ambos validadores proporcionan una salida JSON con los resultados de la validación, conteniendo cada detalle sobre los problemas encontrados. Rocket Validator procesa estos resultados raw para proporcionar un informe más conciso y fácil de usar, agrupa los problemas por tipo y severidad, y aplica las reglas de silenciado que puedas haber configurado.
Sin embargo, hay casos donde puedes necesitar acceder a los resultados raw directamente, por ejemplo al integrar Rocket Validator con otros servicios, o cuando necesitas procesar los resultados de una manera que no está soportada por el informe estándar.
Por eso acabamos de lanzar el nuevo endpoint de la API de Validaciones Raw que te permite acceder a los resultados raw de las validaciones en su formato original.
¿Qué información adicional proporcionan las validaciones raw?
En el caso de los resultados del validador W3C Validator Nu, para la validación HTML, no hay mucha diferencia entre los resultados raw y los procesados, y la diferencia se debe principalmente a cómo está estructurada la información en la salida JSON, y diferencias mínimas en cómo se calcula la severidad de los problemas.
Por otro lado, los resultados de Axe Core proporcionan mucha más información en sus resultados raw. Mientras que en los resultados procesados solo mostramos los resultados de la lista de violations en los resultados, en los resultados raw también puedes encontrar la lista de validaciones incomplete (aquellas que no pudieron determinarse como exitosas o fallidas), las validaciones inapplicable para aquellas reglas que no pudieron encontrar un elemento coincidente en la página para probar, y la lista passes con todas las validaciones que pasaron.
Cómo usar el endpoint de la API de validaciones raw
Si quieres acceder a los resultados raw de las validaciones, necesitas decirle a Rocket Validator que mantenga estos resultados raw en el informe, de lo contrario los resultados raw se eliminan después del procesamiento.
Para habilitar el almacenamiento de resultados raw en el informe, puedes pasar una bandera booleana en la solicitud de crear informe para cada tipo de validación: store_raw_html_checks y/o store_raw_a11y_checks.
Por ejemplo, la siguiente solicitud habilitará el almacenamiento de resultados raw de Axe Core para el informe:
{
"data": {
"attributes": {
"starting_url": "https://dummy.rocketvalidator.com",
"store_raw_a11y_checks": true
}
}
}Finalmente, una vez que el informe se ha ejecutado, puedes acceder a los resultados raw de las validaciones llamando al nuevo endpoint de la API de validaciones raw con el ID de la página web. Por ejemplo, para obtener los resultados raw de Axe Core para una página web, llamarías:
GET /api/v1/reports/{{REPORT_ID}}/web_pages/{{WEB_PAGE_ID}}/raw_a11y_checkPuedes consultar la documentación para leer más sobre el nuevo endpoint de la API de Validaciones Raw.
Costo en créditos para validaciones raw
El nuevo endpoint de la API de Validaciones Raw está disponible para usuarios con un plan Enterprise, Agency o Pro.
Habilitar el almacenamiento de validaciones raw aumentará el número de créditos consumidos por el informe al costo de 1 crédito por validación raw almacenada.
Por ejemplo, ejecutar un informe con validaciones HTML y de accesibilidad en 10 páginas web normalmente consumirá 20 créditos (10 validaciones HTML y 10 validaciones de accesibilidad). Si habilitas el almacenamiento de validaciones raw en este informe, cobraremos 20 créditos adicionales (10 validaciones raw HTML almacenadas y 10 validaciones raw de accesibilidad almacenadas).
Considera no almacenar validaciones raw a menos que las necesites, o almacenar solo el tipo de validaciones raw que necesitas (HTML y/o accesibilidad).