Télécharger les résultats d’accessibilité JSON vers Axe Reports

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Utiliser la sous-commande bulk-reports pour télécharger les résultats vers Axe Reports

Not for use with personal data

Vous pouvez utiliser l’interface en ligne de commande (CLI) pour envoyer des résultats à Axe Reports avec la sous-commande bulk-reports. Vous aurez besoin d’une clé API, qui est décrite dans Obtention d'une clé API.

Pour créer les fichiers de résultats utilisés par cette commande, consultez la section Génération des résultats ci-dessous.

note

Le téléchargement des résultats avec bulk-reports ne remplit pas les métriques d'utilisation dans les rapports Axe (les rapports Utilisation par mois et URLs analysées). Ceux-ci sont remplis par le service d'utilisation à la place. Voir Visualisation de vos données d'utilisation dans les rapports Axe.

Commande bulk-reports

axe bulk-reports <results-dir> --send-axe-reports --axe-reports-api-key <api-key>

note

Axe Reports exige que le répertoire de rapports contienne des fichiers de résultats JSON.

Exemple

axe bulk-reports ./results --axe-reports-api-key 720abdd2-03a3-41bf-b820-0cc38af67057 --send-axe-reports

Options

Option	Description
--send-axe-reports	Nécessaire pour indiquer que les résultats des rapports Axe doivent être téléchargés en bloc.
--axe-reports-api-key	La clé API nécessaire pour télécharger les rapports vers le service Axe Reports de Deque.
--axe-reports-url	(Optionnel) L'URL du serveur de rapports Axe où les résultats seront téléchargés. La valeur par défaut est `https://axe-reports-server.dequecloud.com/`. Réglez ceci uniquement si votre organisation utilise un serveur de rapports Axe différent.
--axe-reports-dimensions	(Optionnel) Liste des dimensions JTBD (jobs-to-be-done) séparées par des virgules utilisées pour catégoriser le scan dans Axe Reports. Voir Dimensions JTBD.

Dimensions JTBD

L'option --axe-reports-dimensions marque les résultats téléchargés avec une ou plusieurs dimensions JTBD (jobs-to-be-done) afin que vous puissiez regrouper et filtrer les scans dans Axe Reports. Les dimensions sont des étiquettes libres que vous choisissez, telles qu'un nom d'équipe, une version ou un domaine d'application ; il n'y a pas de série de valeurs valides fixes. Séparez plusieurs dimensions par des virgules :

axe bulk-reports ./results --send-axe-reports --axe-reports-api-key <your-API-key> --axe-reports-dimensions checkout,mobile-web

Les dimensions sont enregistrées sur le projet dans la charge utile téléchargée, et non sur des pages individuelles, elles décrivent donc le téléchargement dans son ensemble.

La même option est disponible lors de la vérification d'une seule page (voir --axe-reports-dimensions) et lors de l'exécution d'un fichier de spécifications de flux de travail.

Variable d'environnement

Variable	Description
`AXE_REPORTER_API_KEY`	Votre clé API Axe Reports. Pour plus d'informations sur l'obtention d'une clé API, voir Obtention d'une clé API. En mettant votre clé API dans une variable d'environnement, vous pouvez éviter de l'ajouter aux fichiers archivés dans un dépôt Git.

La clé API est la seule valeur que vous pouvez définir avec une variable d'environnement. Pour télécharger vers un serveur de rapports Axe autre que celui par défaut, utilisez l'option --axe-reports-url.

Obtention d'une clé API

Pour obtenir une clé API, contactez directement votre représentant Deque, rejoignez-nous via notre centre de support, ou envoyez-nous un e-mail. Nous serons heureux de vous aider.

Génération des résultats

Il existe plusieurs manières de générer des résultats pour les télécharger vers Axe Reports. Cette section contient des liens vers des exemples de code montrant comment générer des résultats d'accessibilité.

Pour des exemples en Node.js et JavaScript, voir Exemples de code pour le package @axe-devtools/reporter