Erste Schritte mit Projektmanagement-Automatisierung

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

Nutzen Sie Ihren bestehenden Axe-Konto-API-Schlüssel, um Projekt- und Mitgliederverwaltung zu automatisieren

Not for use with personal data

Wenn Ihre Organisation eine Vielzahl von Projekten im Axe Developer Hub verwaltet oder häufig Mitwirkende ein- und ausgliedert, können Sie diese Arbeit mit der Projekte-API automatisieren, anstatt manuell durch die Benutzeroberfläche des Axe Developer Hubs zu klicken.

note

Es gibt keine neuen Anmeldedaten einzurichten. Die Management-Automatisierung verwendet denselben Axe Account API-Schlüssel, den Sie bereits für die anderen REST-APIs des Axe Developer Hubs verwenden. Dazu gehören die Sitzungen- und Ergebnisse-API und die Commit-Status-API. Wenn Sie bereits Testergebnisse an den Axe Developer Hub senden können, haben Sie bereits das, was Sie benötigen.

Was Sie automatisieren können

Mit Ihrem API-Schlüssel kann Ihre Automatisierung:

Projekte erstellen, aktualisieren und löschen.
Alle Projekte in Ihrer Organisation (als Org-Admin) oder alle Projekte, denen Sie angehören, auflisten.
Mitglieder eines Projekts auflisten, ein Mitglied mit einer Rolle hinzufügen, die Rolle eines Mitglieds ändern und ein Mitglied entfernen.

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

Bevor Sie beginnen

Erstellen eines Projekts erfordert ein aktives Abonnement (Lizenz) für den Projekttyp. Wer ein Projekt erstellt, wird automatisch dessen Projekt-Administrator.
Projektrollen sind Administrator und Mitglied. Ein Projektadministrator kann das Projekt aktualisieren oder löschen und dessen Mitglieder verwalten. Ein Projektmitglied kann auf das Projekt zugreifen, es aber nicht verwalten oder dessen Mitglieder verwalten.
Org-Admins können jedes Projekt der lizenzierten Projekttypen Ihrer Organisation sehen und verwalten, unabhängig von ihrer eigenen Projektmitgliedschaft. Sie benötigen keine persönliche Lizenz, um ein bestehendes Projekt anzuzeigen, zu aktualisieren, zu löschen oder dessen Mitglieder zu verwalten. Das Erstellen eines Projekts ist die eine Ausnahme: Ein aktiver Lizenz wird immer benötigt, egal ob der Anrufer ein Org-Admin ist oder nicht.
Das Hinzufügen eines Mitglieds zu einem Projekt erfordert nicht, dass dieses Mitglied eine Lizenz besitzt. Die API verzeichnet sie sofort als Projektmitglieder, aber sie können erst auf das Projekt zugreifen, wenn sie eine Lizenz besitzen. Der Zielbenutzer muss bereits Mitglied der Organisation sein. Sie können niemanden hinzufügen, der nicht schon Organisationsmitglied ist.
Das Löschen eines Projekts ist endgültig. Es gibt keine Möglichkeit zur Selbstwiederherstellung für ein gelöschtes Projekt.

Jeder Projekttyp akzeptiert nur spezifische test_language und test_platform Werte, die in Projekt-Typ-Konfigurationswerte aufgeführt sind. Wählen Sie den Typ sorgfältig: ein Projekttyp kann nicht geändert werden, nachdem er erstellt wurde.

Holen Sie sich Ihren API-Schlüssel

Melden Sie sich am Axe Account Portal an.
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 Header-Wert dieses Schlüssels für jede 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 das neue project_id. Speichern Sie es: Sie benötigen es für jede nachfolgende Anfrage zu diesem Projekt, einschließlich des Sendens von Testergebnissen.

Fügen Sie dem Projekt Teammitglieder 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 seiner E-Mail-Adresse im Axe Account. Der Zielbenutzer muss bereits Ihrer Organisation angehören. Das Hinzufügen erfordert nicht, dass sie eine Lizenz besitzen, aber sie können erst auf das Projekt zugreifen, wenn sie dies tun.

Nächste Schritte

Starten Sie mit den APIs des Axe Developer Hubs für Authentifizierung, Fehlerbehandlung und die anderen Aufgaben, die Sie mit dem gleichen API-Schlüssel automatisieren können.
Projekte-API-Referenz für die vollständige Endpunktreferenz, einschließlich Abrufen, Aktualisieren und Löschen von Projekten und der Verwaltung von Mitgliedschaften im großen Maßstab mit den Batch-Operationen.
Sitzungen- und Ergebnisse-API-Referenz zum Abrufen von Barrierefreiheitsergebnissen, sobald Ihre automatisierten Projekte diese produzieren.