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 sur Axe Developer Hub, ou intègre et retire fréquemment des contributeurs, vous pouvez automatiser ce travail avec l'API de projets au lieu de cliquer dans l'interface utilisateur d'Axe Developer Hub.

note

Il n'y a pas de nouvelle référence à 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 d'Axe Developer Hub. Cela inclut l'API de sessions et résultats et l'API de statut de commit. Si vous pouvez déjà envoyer des résultats de test à Axe Developer Hub, vous avez déjà ce qu'il vous faut.

Ce que vous pouvez automatiser

En utilisant votre clé API, votre automatisation peut :

Créer, mettre à jour et supprimer des projets.
Lister tous les projets de votre organisation (en tant qu'admin d'organisation) 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 retirer un membre.

Voir l'Référence API de projets pour les détails complets des requêtes et réponses pour chaque opération.

Avant de commencer

Créer un projet nécessite un abonnement actif (licence) pour ce type de projet. Celui qui crée un projet devient automatiquement son administrateur de projet.
Rôles de projet sont admin et membre. Un admin de projet peut mettre à jour ou supprimer le projet et gérer ses membres. Un membre de projet peut accéder au projet mais ne peut pas le gérer ni ses membres.
Admins d'organisation peuvent voir et gérer chaque projet des types sous licence de leur organisation, indépendamment de leur propre appartenance à un projet. Ils n'ont pas besoin d'une licence personnelle pour voir, mettre à jour, supprimer ou gérer les membres d'un projet existant. Créer un projet est l'unique exception : cela nécessite toujours une licence active, que l'appelant soit un admin d'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 de restauration en libre-service pour un projet supprimé.

Chaque type de projet accepte uniquement des valeurs spécifiques de test_language et test_platform, listées dans Valeurs de configuration du type de projet. Choisissez le type avec soin : le type d'un projet ne peut pas être modifié une fois créé.

Obtenez votre clé API

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

Créez automatiquement votre premier projet

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 concernant ce projet, y compris l'envoi de résultats de test.

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 email de compte Axe. L'utilisateur cible doit déjà appartenir à votre organisation. Leur ajout ne nécessite pas qu'ils détiennent une licence, mais ils ne peuvent pas accéder au projet tant qu'ils ne le font pas.

Prochaines étapes

Commencez avec les API d'Axe Developer Hub pour l'authentification, la gestion des erreurs, et les autres tâches que vous pouvez automatiser avec la même clé API.
Référence API de projets pour la référence complète des points de terminaison, y compris la récupération, la mise à jour et la suppression de projets, et la gestion des membres à échelle avec les opérations par lots.
Référence API de sessions et résultats pour récupérer les résultats d'accessibilité une fois que vos projets automatisés les produisent.