{
"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"
}'
Después de registrarte, a cada desarrollador se le asigna una clave de acceso a la API personal, una combinación única de letras y dígitos proporcionada para acceder a nuestro endpoint de la API. Para autenticarte con el Auditoría de Accesibilidad de Sitios Web API simplemente incluye tu token de portador en el encabezado de Autorización.
| Encabezado | Descripción |
|---|---|
Autorización
|
Requerido
Debería ser Bearer access_key. Consulta "Tu Clave de Acceso a la API" arriba cuando estés suscrito.
|
Sin compromiso a largo plazo. Mejora, reduce o cancela en cualquier momento. La Prueba Gratuita incluye hasta 50 solicitudes.
Auditar páginas web o sitios web completos para WCAG 2.2, EN 301 549 (Ley de Accesibilidad Europea) y la Sección 508 en un navegador real. Informe en JSON, CSV o HTML
WCAG 2.0, 2.1 y 2.2 (niveles A, AA, AAA), EN 301 549 (Ley de Accesibilidad Europea), Sección 508 (EE. UU.) y RGAA, con prácticas recomendadas opcionales. Las comprobaciones son impulsadas por axe-core corriendo en un navegador Chromium real
Sí Da un dominio la API lo rastrea (enlaces internos y sitemap.xml) y audita hasta 10 páginas por llamada varias a la vez Obtienes un resumen de todo el sitio de cada regla fallida y el informe detallado de cada página También puedes enviar tu propia lista de URL
JSON para tu código CSV con una fila por cada elemento infractor para hojas de cálculo y herramientas de gestión de tickets y un informe HTML independiente listo para enviar a un cliente
No Las pruebas automatizadas encuentran una gran parte de los problemas de accesibilidad pero no todos ellos una revisión manual todavía es necesaria para reclamar plena conformidad Las páginas son auditadas en memoria y nada se almacena
Sí Envíe una plantilla HTML con un base_url para auditarla antes de que se envíe omita las reglas que ya ha triado con disable_rules y falle su compilación en la puntuación o en problemas críticos
El endpoint POST para auditar una página web devuelve puntajes de accesibilidad detallados, conteos de violaciones y una lista de problemas encontrados, incluyendo su gravedad. El endpoint para auditar un sitio web completo proporciona un resumen del estado de accesibilidad del sitio, incluyendo el número de páginas auditadas, reglas fallidas y informes detallados para cada página
Los campos clave incluyen `score`, `violations`, `incomplete`, `counts` y `summary` Para páginas individuales, campos como `url`, `title` y `lang` proporcionan contexto, mientras que `counts` desglosa los tipos de problemas encontrados, como violaciones críticas o serias
Los datos devueltos están estructurados en formato JSON, organizados en objetos anidados. Cada respuesta incluye metadatos sobre la auditoría (por ejemplo, `estándar`, `ventana de visualización`) y resultados detallados, como `cantidades` de violaciones y una lista de `violaciones` o problemas `incompletos`
Los parámetros incluyen `url` o `html` para la página a auditar `max_depth` para rastrear y `max_pages` para limitar el número de páginas auditadas Los usuarios también pueden especificar `standard` para elegir qué pautas de accesibilidad aplicar durante la auditoría
Los usuarios pueden personalizar las solicitudes especificando la `url` o proporcionando HTML en bruto ajustando `max_depth` para la profundidad de rastreo y estableciendo `max_pages` para controlar cuántas páginas se auditan También pueden seleccionar el `estándar` de accesibilidad para adaptar la auditoría a directrices específicas
Los datos de respuesta están organizados en un objeto principal que contiene metadatos sobre la auditoría y objetos anidados para resultados detallados Cada página de resultados se enumera bajo `pages`, con cada página conteniendo su propia `url`, `score` y `counts` de problemas encontrados
Los casos de uso típicos incluyen asegurar el cumplimiento de los estándares de accesibilidad antes de lanzar un sitio web identificar áreas de mejora en sitios existentes y generar informes para las partes interesadas para demostrar los esfuerzos de accesibilidad y cumplimiento
Si los resultados son parciales o vacíos, verifique el campo `counts` para obtener información sobre lo que se auditó. El array `incomplete` enumerará cualquier problema que no se pudo evaluar completamente. Los usuarios deben asegurarse de que las URL proporcionadas sean accesibles y estén correctamente formateadas para evitar resultados vacíos