API de Accesibilidad Web

La API de accesibilidad web diseñada para escalar.

Para comenzar con la API de A11yWatch, agregue su autorización en el encabezado con el formato JWT Bearer TOKEN. Para obtener más información, vaya a la documentación de OpenAPI, GraphQL o gRPC. Necesita una suscripción paga para acceder a la API.

Autenticación y Usuario
- https://api.a11ywatch.com/api/user
  GET
  curl --location --request GET 'https://api.a11ywatch.com/api/user' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/login
  POST
  email stringLa dirección de correo electrónico de la cuenta con la que desea iniciar sesión.Campo requeridopassword stringLa contraseña de la cuenta con la que desea iniciar sesión.Campo requerido
  curl --location --request POST 'https://api.a11ywatch.com/api/login' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "email": "example@email.com", "password": "somethingsafe" }'
Acciones de Reporte
- https://api.a11ywatch.com/api/scan
  POST
  url stringLa URL que se va a escanear y analizar.Campo requerido
  curl --location --request POST 'https://api.a11ywatch.com/api/scan' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/crawl
  POST
  url stringLa URL que se va a escanear y analizar.Campo requeridosubdomains booleanIncluir subdominios que coincidan con el dominio.sitemap numberIncluir enlaces del sitemap - 0 desactivado, 1 escanear solamente el sitemap y 2 extender el escaneo con el sitemap.tld booleanIncluya todas las extensiones de TLD que coincidan con el dominio.csv Header [Accept: text/csv]Tratar los datos como CSV en lugar de JSON.standard stringEl estándar de accesibilidad web. Uno de WCAGA, WCAGAA, o WCAGAAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/crawl' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/websites-sync
  POST
  curl --location --request POST 'https://api.a11ywatch.com/api/websites-sync' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json'
Gestión de Sitios Web
- https://api.a11ywatch.com/api/website
  POST
  url stringLa URL del sitio web.Campo requeridocustomHeaders string[{key: string, value: string}]Un array de objetos con pares clave-valor para las configuraciones de encabezado.mobile boolean¿El análisis se realiza en la vista móvil?standard stringEl estándar WCAG2.1 que se va a usar, p. ej. WCAG2A, WCAG2AA y WCAG2AAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "websiteUrl": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website?domain=https://mywebsite.com
  GET
  url stringLa URL del sitio web.Campo requerido
  curl --location --request GET 'https://api.a11ywatch.com/api/website?domain=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website
  PUT
  url stringLa URL del sitio web.Campo requeridocustomHeaders string[{key: string, value: string}]Un array de objetos con pares clave-valor para las configuraciones de encabezado.mobile boolean¿El análisis se realiza en la vista móvil?standard stringEl estándar WCAG2.1 que se va a usar, p. ej. WCAG2A, WCAG2AA y WCAG2AAA.
  curl --location --request PUT 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website
  DELETE
  url La URL del sitio web.domain stringEl nombre del sitio web.deleteMany booleanEliminar todos los sitios web y los datos relacionados.
  curl --location --request DELETE 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "domain": "a11ywatch.com" }'
- https://api.a11ywatch.com/api/report?url=https://mywebsite.com
  GET
  url La URL que se va a escanear y analizar.Campo requeridodownload booleanDescargar el informe en formato Excel.csv booleanTratar los datos como CSV en lugar de JSON.
  curl --location --request GET 'https://api.a11ywatch.com/api/report?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com
  GET
  url La URL del sitio web.Campo requerido
  curl --location --request GET 'https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com
  GET
  url La URL que se va a escanear y analizar.Campo requerido
  curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
Listar Resultados
- https://api.a11ywatch.com/api/list/website?offset=0
  GET
  offset numberLa posición de la página para obtener el siguiente conjunto paginado.search stringBuscar problemas en una página.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/website?offset=0' --header 'Authorization: $A11YWATCH_TOKEN' undefined
- https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com
  GET
  offset numberLa posición de la página para obtener el siguiente conjunto paginado.domain stringEl nombre del sitio web.search stringBuscar problemas en una página.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/pages?offset=0
  GET
  offset numberLa posición de la página para obtener el siguiente conjunto paginado.domain stringEl nombre del sitio web.search stringBuscar problemas en una página.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/pages?offset=0' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com
  GET
  offset numberLa posición de la página para obtener el siguiente conjunto paginado.domain stringEl nombre del sitio web.pageUrl stringLa URL del sitio web.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'

De forma predeterminada, los documentos de la API de A11yWatch demuestran cómo interactuar con la API a través de HTTP utilizando cURL. La mayoría de las rutas permiten enviar parámetros desde la URL o el cuerpo. Es mejor seguir utilizando el cuerpo para solicitudes HTTP PUT y POST ya que algunos parámetros están configurados como matrices y otras formas que no son cadenas. En el ejemplo, reemplace a11ywatch.com con el sitio web que desea analizar. El uso de A11yWatch en un CI puede ahorrar costos de desarrollo de manera drástica al concientizar antes de la implementación en producción.

Mantente inclusivo con confianza

Comience ahora con A11yWatch para obtener herramientas de accesibilidad web automatizadas económicas y rápidas.

Comience hoy

API de Accesibilidad Web

La API de accesibilidad web diseñada para escalar.

Autenticación y Usuario

Acciones de Reporte

Gestión de Sitios Web

Listar Resultados

Mantente inclusivo con confianza