API d'accessibilité web

L'API d'accessibilité web conçue pour être évolutive.

Pour commencer avec l'API d'A11yWatch, ajoutez votre autorisation dans l'en-tête au format JWT Bearer TOKEN. Pour en savoir plus, consultez la documentation OpenAPI, GraphQL ou gRPC. Un abonnement payant est requis pour accéder à l'API.

Authentification et utilisateur
- 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 stringAdresse e-mail du compte avec lequel vous souhaitez vous connecter.Requispassword stringMot de passe du compte avec lequel vous souhaitez vous connecter.Requis
  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" }'
Actions de rapport
- https://api.a11ywatch.com/api/scan
  POST
  url stringL'URL qui sera analysée et explorée.Requis
  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 stringL'URL qui sera analysée et explorée.Requissubdomains booleanInclure les sous-domaines correspondant au domaine.sitemap numberInclure les liens du plan du site - 0 désactivé, 1 scanner uniquement le plan du site et 2 étendre l'exploration avec le plan du site.tld booleanInclure toutes les extensions TLD qui correspondent au domaine.csv Header [Accept: text/csv]Traiter les données comme un fichier CSV plutôt que JSON.standard stringLa norme d'accessibilité web. L'un des WCAGA, WCAGAA, ou 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'
Gestion de site Web
- https://api.a11ywatch.com/api/website
  POST
  url stringL'URL du site Web.RequiscustomHeaders string[{key: string, value: string}]Un tableau d'objets avec des paires clé-valeur pour les configurations d'en-tête.mobile booleanL'analyse est-elle effectuée sur la vue mobile ?standard stringLa norme WCAG2.1 à utiliser, p. ex. WCAG2A, WCAG2AA et 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 stringL'URL du site Web.Requis
  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 stringL'URL du site Web.RequiscustomHeaders string[{key: string, value: string}]Un tableau d'objets avec des paires clé-valeur pour les configurations d'en-tête.mobile booleanL'analyse est-elle effectuée sur la vue mobile ?standard stringLa norme WCAG2.1 à utiliser, p. ex. WCAG2A, WCAG2AA et 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 L'URL du site Web.domain stringLe nom du site web.deleteMany booleanSupprimer tous les sites web et les données associées.
  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 L'URL qui sera analysée et explorée.Requisdownload booleanTélécharger le rapport au format Excel.csv booleanTraiter les données comme un fichier CSV plutôt que 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 L'URL du site Web.Requis
  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 L'URL qui sera analysée et explorée.Requis
  curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
Lister les résultats
- https://api.a11ywatch.com/api/list/website?offset=0
  GET
  offset numberLa position de la page pour obtenir l'ensemble paginé suivant.search stringRechercher des problèmes sur une page.
  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 position de la page pour obtenir l'ensemble paginé suivant.domain stringLe nom du site web.search stringRechercher des problèmes sur une page.
  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 position de la page pour obtenir l'ensemble paginé suivant.domain stringLe nom du site web.search stringRechercher des problèmes sur une page.
  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 position de la page pour obtenir l'ensemble paginé suivant.domain stringLe nom du site web.pageUrl stringL'URL du site Web.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'

Par défaut, les documents d'API d'A11yWatch montrent comment interagir avec l'API via HTTP en utilisant cURL. La plupart des itinéraires permettent d'envoyer des paramètres depuis l'URL ou le corps. Il est préférable de continuer à utiliser le corps pour les requêtes HTTP PUT et POST, car certains paramètres sont configurés sous forme de tableaux et d'autres formes qui ne sont pas des chaînes. Dans l'exemple, remplacez a11ywatch.com par le site web que vous souhaitez analyser. L'utilisation d'A11yWatch dans un CI peut réduire considérérablement les coûts de développement en prenant conscience des problèmes avant la mise en production.

Restez inclusif en toute confiance

Commencez dès maintenant avec A11yWatch pour des outils d'accessibilité web automatisés abordables et rapides.

Commencez

API d'accessibilité web

L'API d'accessibilité web conçue pour être évolutive.

Authentification et utilisateur

Actions de rapport

Gestion de site Web

Lister les résultats

Restez inclusif en toute confiance