Commencez avec l'automatisation de la gestion de projet

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

Utilisez votre clé API de compte Axe existante pour automatiser la gestion de vos projets et de votre adhésion

Not for use with personal data

Si votre organisation gère un grand nombre de projets Axe Developer Hub ou intègre et désintègre fréquemment des contributeurs, vous pouvez automatiser ce travail avec l'API des Projets au lieu de cliquer dans l'interface utilisateur Axe Developer Hub.

note

Il n'y a pas de nouvelles informations d'identification à configurer. L'automatisation de la gestion utilise la même clé API de compte Axe que vous utilisez déjà pour le reste des API REST de l'Axe Developer Hub. Cela inclut l'API des Sessions et Résultats et l'API de l'État des Commit. Si vous pouvez déjà envoyer les résultats des tests à Axe Developer Hub, vous avez déjà ce qu'il vous faut.

Ce que vous pouvez automatiser

Avec votre clé API, votre automatisation peut :

Créer, mettre à jour et supprimer des projets.
Lister tous les projets de votre organisation (en tant qu'administrateur org) ou tous les projets auxquels vous appartenez.
Lister les membres d'un projet, ajouter un membre avec un rôle, changer le rôle d'un membre et supprimer un membre.

Voir la Référence de l'API des Projets pour tous les détails des demandes et réponses pour chaque opération.

Avant de commencer

Création d'un projet nécessite un abonnement actif (licence) pour le type de projet concerné. Celui qui crée un projet en devient automatiquement l'administrateur.
Les Rôles dans le projet sont administrateur et membre. Un administrateur de projet peut mettre à jour ou supprimer le projet et gérer ses membres. Un membre du projet peut accéder au projet mais ne peut pas le gérer ni gérer ses membres.
Les Administrateurs de l'Organisation peuvent voir et gérer chaque projet des types licenciés de leur organisation, qu'ils soient membres du projet ou non. Ils n'ont pas besoin de licence personnelle pour voir, mettre à jour, supprimer ou gérer les membres d'un projet existant. La création d'un projet est la seule exception : il nécessite toujours une licence active, que l'appelant soit administrateur de l'organisation ou non.
Ajouter un membre à un projet ne nécessite pas que ce membre détienne une licence. L'API les enregistre immédiatement comme membre du projet, mais ils ne peuvent pas accéder au projet tant qu'ils ne détiennent pas une licence. L'utilisateur cible doit déjà appartenir à l'organisation. Vous ne pouvez pas ajouter quelqu'un qui n'est pas déjà membre de l'organisation.
Supprimer un projet est définitif. Il n'y a pas d'option de restauration en libre-service pour un projet supprimé.

Chaque type de projet accepte uniquement des valeurs spécifiques pour test_language et test_platform, listées dans Valeurs de configuration du type de projet. Choisissez le type avec soin : vous ne pouvez pas changer le type d'un projet après sa création.

Obtenez votre clé API

Connectez-vous au Portail du Compte Axe.
Copiez une clé API Axe Developer Hub pour les projets web ou CI/CD, ou une clé API Axe DevTools Mobile pour les projets mobiles. Utilisez la valeur d'en-tête X-API-Key de cette clé pour chaque requête à l'API des Projets.

Créez votre premier projet automatiquement

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright"
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects"

La réponse inclut le nouveau project_id. Enregistrez-le : vous en aurez besoin pour chaque appel ultérieur à ce projet, y compris pour envoyer les résultats des tests.

Ajoutez des coéquipiers au projet

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "user_email_role_pairs": [
      { "user_email": "sam@example.com", "role": "member" }
    ]
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects/$PROJECT_ID/memberships"

Identifiez chaque utilisateur par son adresse e-mail de compte Axe. L'utilisateur cible doit déjà appartenir à votre organisation. Le fait de les ajouter ne nécessite pas qu'ils détiennent une licence, mais ils ne peuvent pas accéder au projet tant qu'ils n'en ont pas une.

Prochaines étapes

Référence de l'API des Projets pour la référence complète des points de terminaison, y compris la récupération, la mise à jour et la suppression des projets, ainsi que la gestion des membres à grande échelle avec les opérations par lots.
Référence de l'API des Sessions et Résultats pour récupérer les résultats d'accessibilité une fois que vos projets automatisés les produisent.