Web Accessibility API – Validar la accesibilidad HTML a través de REST API

¿Qué es la API de Accesibilidad Web?

La API de Accesibilidad Web de Aspose.HTML Cloud le permite validar la accesibilidad de documentos HTML según los estándares WCAG. Esta API ayuda a asegurar que su contenido web sea accesible para todos los usuarios, incluidas las personas con discapacidades, verificando el cumplimiento de varios niveles WCAG (A, AA, AAA).

• Solo REST API: Esta API no está incluida en los SDK y está disponible exclusivamente a través de solicitudes HTTP directas.
• Punto final único: Toda la validación de accesibilidad se realiza a través de un solo punto final: POST https://api.aspose.cloud/v4.0/html/accessibility.
• Entrada flexible: Puede validar HTML desde una URL, contenido HTML sin procesar, contenido codificado en base64, o archivos almacenados en Aspose Cloud Storage.

Cómo funciona

Para validar la accesibilidad, envíe una solicitud POST al punto final con un objeto AccessibilityRequest. La solicitud puede especificar la fuente HTML (URL, contenido, base64 o ruta de almacenamiento) y varias opciones de validación. La API devuelve un informe detallado que indica si el documento pasa las verificaciones de accesibilidad y proporciona información sobre cualquier problema encontrado.

Objeto de solicitud

El cuerpo de la solicitud debe ser un objeto JSON con las siguientes propiedades:

• InputPath: URL o ruta de almacenamiento al archivo HTML
• InputBase64: contenido HTML codificado en base64
• InputContent: contenido HTML sin procesar
• StorageName: (opcional) nombre del almacenamiento si se usa Aspose Cloud Storage
• Options: opciones de validación de accesibilidad (ver abajo)

AccessibilityOptions

El objeto Options le permite controlar qué reglas y características de accesibilidad se verifican. Las propiedades disponibles son:

• AllLevels, LowestLevel, MiddleLevel, HighestLevel: qué niveles WCAG verificar
• WcagVersion: versión WCAG (ej., “2.1”)
• UseHtml, UseCss, UseScript, UseFailures, UseGeneral, UseAria: habilitar/deshabilitar tipos específicos de validación
• HtmlTags, ExcludeTags: listas separadas por comas de etiquetas a incluir/excluir
• MaxErrorsPerRule: limitar errores por regla

Descripciones detalladas de opciones:

• AllLevels (bool?): Verificar todos los niveles WCAG (A, AA, AAA).
• LowestLevel (bool?): Verificar solo el nivel WCAG A (nivel más bajo).
• MiddleLevel (bool?): Verificar solo el nivel WCAG AA (nivel medio).
• HighestLevel (bool?): Verificar solo el nivel WCAG AAA (nivel más alto).
• WcagVersion (string): Versión WCAG a usar para validación (ej., “2.1”).
• UseHtml (bool?): Habilitar validación HTML.
• UseCss (bool?): Habilitar validación CSS.
• UseScript (bool?): Habilitar validación JavaScript.
• UseFailures (bool?): Habilitar validación de fallos (verifica fallos conocidos).
• UseGeneral (bool?): Habilitar validación general (verificaciones amplias de accesibilidad).
• UseAria (bool?): Habilitar validación ARIA (verifica atributos y roles ARIA).
• HtmlTags (string): Lista separada por comas de etiquetas HTML a validar (ej., “img,button,input”).
• ExcludeTags (string): Lista separada por comas de etiquetas HTML a excluir de la validación.
• MaxErrorsPerRule (int?): Número máximo de errores a reportar por regla.

Puede combinar estas opciones para personalizar la validación de accesibilidad según sus necesidades. Por ejemplo, puede verificar solo ciertos niveles WCAG, enfocarse en etiquetas específicas, o habilitar/deshabilitar ciertos tipos de validación.

Objeto de respuesta

La respuesta contiene:

• Success: resultado general (aprobado/no aprobado)
• Rules: lista de reglas de validación y sus resultados
• Error: mensaje de error si la validación falló

Vea la Referencia de API para detalles completos.

Métodos de validación

La API de Accesibilidad Web proporciona varios métodos para validar la accesibilidad HTML:

• Validar por URL - Validar la accesibilidad de una página web usando su URL
• Validar por contenido HTML - Validar contenido HTML sin procesar
• Validar por Base64 - Validar HTML codificado en base64
• Validar archivo local - Subir y validar un archivo HTML local

Funcionalidad común

• Autenticación: Use sus credenciales de Aspose Cloud para autenticar solicitudes. Vea la Guía de autenticación para detalles.
• Subir archivos locales: Para validar un archivo local, súbalo a Aspose Cloud Storage primero. Vea Subir archivos para instrucciones.