API du Hub de Développeurs Axe

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

Un aperçu des API REST disponibles pour le Hub de Développeurs Axe

Not for use with personal data

Le Hub de Développeurs Axe expose un ensemble d'API REST que vous pouvez appeler avec votre clé API de Compte Axe existante : aucune autre identification séparée n'est nécessaire pour l'un d'eux. Utilisez-les pour gérer les pipelines CI/CD sur le statut d'accessibilité, récupérer les résultats d'accessibilité de manière programmée, et créer, gérer et consulter vos projets.

Quelle API Me Faut-il ?

Je veux... Utilisez...
Configurer l'authentification, trouver un ID de projet, et effectuer un premier appel Commencer avec les API du Hub de Développeurs Axe
Créer et gérer des projets et leurs membres, lister vos projets, ou rechercher un ID de projet par nom Référence de l'API Projets
Automatiser la création de projets et la gestion des membres, étape par étape Commencer avec l'Automatisation de la Gestion des Projets
Refuser une demande de tirage ou un commit lorsque des erreurs d'accessibilité sont trouvées, à partir d'un pipeline CI/CD non-GitHub (GitLab, BitBucket, et similaires) Référence de l'API Statut de Commit
Faire la même chose depuis un pipeline GitHub Utiliser l'Action GitHub au lieu d'appeler directement l'API REST
Récupérer les résultats d'accessibilité complets pour une session, ou lister les sessions d'un projet Référence de l'API Sessions et Résultats
Télécharger un rapport sommaire comme le faisaient les anciennes intégrations Obtenir les Résultats de Manière Programmée (Obsolète) : basculez vers l'API Sessions et Résultats à la place

Authentification, en un coup d'œil

Chaque API de cette liste s'authentifie de la même manière, avec votre clé API de Compte Axe dans un en-tête X-API-Key. Voir Commencer avec les API du Hub de Développeurs Axe pour obtenir une clé, trouver votre ID projet, et effectuer votre premier appel.