O Rocket Validator é um serviço de validação de acessibilidade e HTML para todo o site. Analisa automaticamente o seu website e verifica cada página web interna encontrada usando dois verificadores: Axe Core para encontrar problemas de acessibilidade, e o W3C Validator Nu para validação HTML.
Ambos os validadores fornecem uma saída JSON com os resultados das verificações, contendo todos os detalhes sobre os problemas encontrados. O Rocket Validator processa estes resultados brutos para fornecer um relatório mais conciso e amigável ao utilizador, agrupar os problemas por tipo e gravidade, e aplicar as regras de silenciado que você pode ter configurado.
No entanto, existem casos onde você pode precisar de aceder aos resultados brutos diretamente, por exemplo, quando integra o Rocket Validator com outros serviços, ou quando precisa de processar os resultados de uma forma que não é suportada pelo relatório padrão.
É por isso que acabámos de lançar o novo endpoint da API de Verificações Brutas que lhe permite aceder aos resultados brutos das verificações no seu formato original.
Que informações adicionais fornecem as verificações brutas?
No caso dos resultados do verificador W3C Validator Nu, para a validação HTML, não há muita diferença entre os resultados brutos e os processados, e a diferença deve-se principalmente à forma como a informação é estruturada na saída JSON, e diferenças mínimas na forma como a gravidade dos problemas é calculada.
Por outro lado, os resultados do Axe Core fornecem muito mais informação nos seus resultados brutos. Enquanto nos resultados processados apenas mostramos os resultados da lista de violations nos resultados, nos resultados brutos também pode encontrar a lista de verificações incomplete (aquelas que não puderam ser determinadas como passou ou falhou), as verificações inapplicable para aquelas regras que não conseguiram encontrar um elemento correspondente na página para testar, e a lista passes com todas as verificações que passaram.
Como usar o endpoint da API de verificações brutas
Se quiser aceder aos resultados brutos das verificações, precisa de dizer ao Rocket Validator para manter estes resultados brutos no relatório, caso contrário os resultados brutos são eliminados após o processamento.
Para ativar o armazenamento de resultados brutos no relatório, pode passar uma flag booleana no pedido de criação de relatório para cada tipo de verificação: store_raw_html_checks e/ou store_raw_a11y_checks.
Por exemplo, o seguinte pedido irá ativar o armazenamento de resultados brutos do Axe Core para o relatório:
{
"data": {
"attributes": {
"starting_url": "https://dummy.rocketvalidator.com",
"store_raw_a11y_checks": true
}
}
}Finalmente, uma vez que o relatório tenha sido executado, pode aceder aos resultados brutos das verificações chamando o novo endpoint da API de verificações brutas com o ID da página web. Por exemplo, para obter os resultados brutos do Axe Core para uma página web, chamaria:
GET /api/v1/reports/{{REPORT_ID}}/web_pages/{{WEB_PAGE_ID}}/raw_a11y_checkPode consultar a documentação para ler mais sobre o novo endpoint da API de Verificações Brutas.
Custo de créditos para verificações brutas
O novo endpoint da API de Verificações Brutas está disponível para utilizadores com um plano Enterprise, Agency ou Pro.
Ativar o armazenamento de verificações brutas aumentará o número de créditos consumidos pelo relatório ao custo de 1 crédito por verificação bruta armazenada.
Por exemplo, executar um relatório com verificações HTML e de acessibilidade em 10 páginas web irá normalmente consumir 20 créditos (10 verificações HTML e 10 verificações de acessibilidade). Se ativar o armazenamento de verificações brutas neste relatório, cobraremos 20 créditos adicionais (10 verificações brutas HTML armazenadas e 10 verificações brutas de acessibilidade armazenadas).
Considere não armazenar verificações brutas a menos que precise delas, ou apenas armazenar o tipo de verificações brutas de que precisa (HTML e/ou acessibilidade).