Erste Schritte mit Projektmanagement-Automatisierung

Wenn Ihre Organisation eine große Anzahl von Projekten im Axe Developer Hub verwaltet oder häufig Mitarbeiter an- und abmeldet, können Sie diese Arbeit mit der Projekte-API automatisieren, anstatt durch die Benutzeroberfläche des Axe Developer Hub zu klicken.

Was Sie automatisieren können

Mithilfe Ihres API-Schlüssels kann Ihre Automatisierung:

• Projekte erstellen, aktualisieren und löschen.
• Jedes Projekt innerhalb Ihrer Organisation (als Org-Admin) oder jedes Projekt, dem Sie angehören, auflisten.
• Die Mitglieder eines Projekts auflisten, ein Mitglied mit einer Rolle hinzufügen, die Rolle eines Mitglieds ändern und ein Mitglied entfernen.

Sehen Sie sich die Projekte-API-Referenz für vollständige Anfragen- und Antwortdetails zu jeder Operation an.

Bevor Sie beginnen

• Projekt erstellen erfordert ein aktives Abonnement (Lizenz) für diesen Projekttyp. Wer auch immer ein Projekt erstellt, wird automatisch dessen Projekt-Admin.
• Projektrollen sind Admin und Mitglied. Ein Projekt-Admin kann das Projekt aktualisieren oder löschen und seine Mitglieder verwalten. Ein Projektmitglied hat Zugriff auf das Projekt, kann es jedoch nicht verwalten oder dessen Mitgliedschaft.
• Organisations-Admins können alle Projekte der lizenzierten Typen ihrer Organisation sehen und verwalten, unabhängig von ihrer eigenen Projektmitgliedschaft. Sie benötigen keine persönliche Lizenz, um ein bestehendes Projekt zu sehen, zu aktualisieren, zu löschen oder dessen Mitglieder zu verwalten. Das Erstellen eines Projekts ist die einzige Ausnahme: es ist immer eine aktive Lizenz erforderlich, unabhängig davon, ob der Anrufer ein Organisations-Admin ist oder nicht.
• Das Hinzufügen eines Mitglieds zu einem Projekt erfordert nicht, dass dieses Mitglied eine Lizenz besitzt. Die API registriert sie sofort als Projektmitglied, aber sie können auf das Projekt nicht zugreifen, bevor sie eine Lizenz besitzen. Der Zielbenutzer muss bereits der Organisation angehören. Sie können niemanden hinzufügen, der nicht bereits Mitglied der Organisation ist.
• Das Löschen eines Projekts ist endgültig. Es gibt keine Möglichkeit zur Selbstwiederherstellung eines gelöschten Projekts.

Jeder Projekttyp akzeptiert nur bestimmte test_language- und test_platform-Werte, die in Projekt-Typ-Konfigurationswerte aufgelistet sind. Wählen Sie den Typ sorgfältig aus: Ein Projekttyp kann nach der Erstellung nicht mehr geändert werden.

Holen Sie sich Ihren API-Schlüssel

1. Melden Sie sich beim Axe-Konto-Portal an.
2. Kopieren Sie einen Axe Developer Hub-API-Schlüssel für Web- oder CI/CD-Projekte oder einen Axe DevTools Mobile-API-Schlüssel für mobile Projekte. Verwenden Sie den X-API-Key-Headerwert dieses Schlüssels bei jeder Anfrage an die Projekte-API.

Erstellen Sie Ihr erstes Projekt automatisch

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"

Die Antwort enthält die neue project_id. Speichern Sie diese: Sie benötigen sie für jede nachfolgende Anfrage gegen dieses Projekt, einschließlich des Sendens von Testergebnissen.

Fügen Sie dem Projekt Teamkollegen hinzu

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"

Identifizieren Sie jeden Benutzer anhand ihrer Axe-Konto-E-Mail-Adresse. Der Zielbenutzer muss bereits Ihrer Organisation angehören. Das Hinzufügen erfordert keine Lizenz, aber sie können auf das Projekt nicht zugreifen, bevor sie eine besitzen.

Nächste Schritte

• Projekte-API-Referenz für die vollständige Endpunkt-Referenz, einschließlich Abrufen, Aktualisieren und Löschen von Projekten sowie der Verwaltung von Mitgliedschaften im großen Umfang mit den Batch-Operationen.
• Sitzungen- und Ergebnisse-API-Referenz für das Abrufen von Barrierefreiheits-Ergebnissen, sobald Ihre automatisierten Projekte diese erzeugen.