{
"standard": "wcag22aa",
"viewport": "desktop",
"axe_version": "4.13.0",
"url": "https://example.com/",
"status": 200,
"title": "Example Domain",
"lang": "en",
"score": 100,
"counts": {
"violations": 0,
"violation_nodes": 0,
"critical": 0,
"serious": 0,
"moderate": 0,
"minor": 0,
"incomplete": 1,
"passes": 10,
"inapplicable": 52
},
"violations": [],
"incomplete": [
{
"id": "bypass",
"impact": "serious",
"level": "A",
"wcag": [
"2.4.1"
],
"help": "Page must have means to bypass repeated blocks",
"description": "Ensure each page has at least one mechanism for a user to bypass navigation and jump straight to the content",
"help_url": "https://dequeuniversity.com/rules/axe/4.13/bypass?application=axeAPI",
"tags": [
"cat.keyboard",
"wcag2a",
"wcag241",
"section508",
"section508.22.o",
"TTv5",
"TT9.a",
"EN-301-549",
"EN-9.2.4.1",
"RGAAv4",
"RGAA-12.7.1"
],
"node_count": 1,
"nodes": [
{
"target": "html",
"html": "<html lang=\"en\">",
"failure_summary": "Fix any of the following:\n No valid skip link found\n Page does not have a heading\n Page does not have a landmark region"
}
]
}
],
"duration_ms": 1838
}
curl --location --request POST 'https://zylalabs.com/api/13983/website+accessibility+audit+api/33863/audit+one+web+page+or+html+document+for+wcag+accessibility' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"url": "https://example.com"
}'
{
"url": "https://example.com/",
"scope": [
"example.com"
],
"standard": "wcag22aa",
"viewport": "desktop",
"axe_version": "4.13.0",
"pages_audited": 1,
"pages_failed": 0,
"not_audited": 0,
"truncated": false,
"duration_ms": 3045,
"discovery": {
"html_pages": 1,
"other_pages": 0,
"not_visited": 0,
"sitemap_urls": 0
},
"summary": {
"score": 100,
"worst_score": 100,
"counts": {
"violations": 0,
"violation_nodes": 0,
"critical": 0,
"serious": 0,
"moderate": 0,
"minor": 0,
"incomplete": 1,
"passes": 10,
"inapplicable": 52
},
"rules": []
},
"pages": [
{
"url": "https://example.com/",
"status": 200,
"title": "Example Domain",
"lang": "en",
"score": 100,
"counts": {
"violations": 0,
"violation_nodes": 0,
"critical": 0,
"serious": 0,
"moderate": 0,
"minor": 0,
"incomplete": 1,
"passes": 10,
"inapplicable": 52
},
"violations": [],
"duration_ms": 1777
}
]
}
curl --location --request POST 'https://zylalabs.com/api/13983/website+accessibility+audit+api/33864/audit+a+whole+website+or+a+list+of+urls+for+accessibility' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"url": "https://example.com"
}'
Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Auditoria de Acessibilidade de Website API basta incluir seu token Bearer no cabeçalho Authorization.
| Cabeçalho | Descrição |
|---|---|
Authorization
|
Obrigatório
Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.
|
Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.
Audite páginas da web ou sites inteiros para WCAG 2.2, EN 301 549 (Lei Europeia de Acessibilidade) e Seção 508 em um navegador real Relatório em JSON CSV ou HTML
WCAG 2.0, 2.1 e 2.2 (níveis A, AA, AAA), EN 301 549 (Lei de Acessibilidade Europeia), Seção 508 (EUA) e RGAA, com melhores práticas opcionais Os testes são realizados pelo axe-core funcionando em um navegador Chromium real
Sim Dê um domínio a API rastreia ele links internos e sitemap.xml e audita até 10 páginas por chamada várias de cada vez Você recebe um resumo geral de cada regra falhada e o relatório detalhado de cada página Você também pode enviar sua própria lista de URLs
JSON para seu código CSV com uma linha por elemento ofensivo para planilhas e ferramentas de tickets e um relatório HTML autônomo pronto para enviar a um cliente
Não Os testes automatizados encontram uma grande parte dos problemas de acessibilidade mas não todos eles uma revisão manual ainda é necessária para afirmar conformidade completa As páginas são auditadas na memória e nada é armazenado
Sim Envie um template HTML com um base_url para auditoria antes do envio pule regras que você já triou com disable_rules e falhe sua construção na pontuação ou em problemas críticos
O endpoint POST para auditar uma página da web retorna pontuações detalhadas de acessibilidade, contagens de violações e uma lista de problemas encontrados, incluindo sua gravidade. O endpoint para auditar um site inteiro fornece um resumo do status de acessibilidade do site, incluindo o número de páginas auditadas, regras que falharam e relatórios detalhados para cada página
Os campos principais incluem `pontuação`, `violações`, `incompleto`, `contagens` e `resumo` Para páginas individuais, campos como `url`, `título` e `lang` fornecem contexto, enquanto `contagens` detalha os tipos de problemas encontrados, como violações críticas ou graves
Os dados retornados estão estruturados no formato JSON, organizados em objetos aninhados. Cada resposta inclui metadados sobre a auditoria (por exemplo, `padrão`, `visualização`) e resultados detalhados, como `contagens` de violações e uma lista de `violações` ou problemas `incompletos`
Os parâmetros incluem `url` ou `html` para a página a ser auditada `max_depth` para rastreamento e `max_pages` para limitar o número de páginas auditadas Os usuários também podem especificar `standard` para escolher quais diretrizes de acessibilidade aplicar durante a auditoria
Os usuários podem personalizar as solicitações especificando a `url` ou fornecendo HTML bruto ajustando `max_depth` para a profundidade de rastreamento e definindo `max_pages` para controlar quantas páginas são auditadas. Eles também podem selecionar o `standard` de acessibilidade para adequar a auditoria a diretrizes específicas
Os dados de resposta estão organizados em um objeto principal contendo metadados sobre a auditoria e objetos aninhados para resultados detalhados Cada página de resultados está listada sob `pages` com cada página contendo sua própria `url` `score` e `counts` de problemas encontrados
Casos de uso típicos incluem garantir a conformidade com os padrões de acessibilidade antes de lançar um site identificar áreas para melhoria em sites existentes e gerar relatórios para as partes interessadas para demonstrar esforços de acessibilidade e conformidade
Se os resultados forem parciais ou vazios, verifique o campo `counts` para obter informações sobre o que foi auditado. O array `incomplete` listará quaisquer problemas que não puderam ser avaliados completamente. Os usuários devem garantir que as URLs fornecidas sejam acessíveis e estejam formatadas corretamente para evitar resultados vazios