Projekte API-Referenz

Die Projects API ermöglicht es Ihnen, Axe Developer Hub-Projekte und deren Mitgliedschaft programmgesteuert zu verwalten, indem Sie denselben Axe Account-API-Schlüssel verwenden, den Sie bereits für die anderen REST-APIs des Axe Developer Hub verwenden. Es gibt kein separates Anmeldeverfahren für das Projektmanagement. Für eine Schritt-für-Schritt-Einführung siehe Erste Schritte mit der Projektmanagement-Automatisierung.

Wenn Sie nur die ID eines Projekts anhand seines Namens herausfinden müssen, um die Sessions-und-Ergebnisse-API aufzurufen, siehe unten Projekte auflisten. Wenn Sie Ihre Projekt-ID bereits kennen, können Sie sie in Axe Developer Hub finden und direkt die Sessions-und-Ergebnisse-API aufrufen.

Authentifizierung

Alle Anfragen erfordern einen API-Schlüssel. Geben Sie ihn im X-API-Key-Header an:

X-API-Key: <DEQUE_API_KEY>

Finden Sie Ihren API-Schlüssel im Axe-Konto-Portal. Wählen Sie einen Axe Developer Hub-API-Schlüssel für Web- oder CI/CD-Projekte. Wählen Sie einen Axe DevTools Mobile-API-Schlüssel für mobile Projekte.

Behandeln Sie Ihren API-Schlüssel als Geheimnis: Speichern Sie ihn in einer Umgebungsvariable oder im Geheimnis-Speicher Ihrer CI/CD-Plattform, anstatt ihn in Ihren Anfragen zu kodieren.

Zugangskontrolle und Berechtigungen

• Ein Projekt erstellen erfordert ein aktives Abonnement (Lizenz) für diesen Projekttyp. Wer auch immer ein Projekt erstellt, wird automatisch dessen Projektadministrator.
• Projektrollen sind Administrator und Mitglied. Ein Projektadministrator kann das Projekt aktualisieren oder löschen und seine Mitgliedschaft verwalten. Ein Projektmitglied kann auf das Projekt zugreifen, es aber nicht verwalten oder die Mitgliedschaft ändern.
• Organisations-Admins können jedes Projekt ihrer Organisation, für das es eine Lizenz gibt, sehen und verwalten, unabhängig von ihrer eigenen Projektmitgliedschaft. Sie benötigen keine persönliche Lizenz, um ein bestehendes Projekt anzusehen, zu aktualisieren, zu löschen oder dessen Mitglieder zu verwalten. Ein Projekt erstellen ist die eine Ausnahme: es erfordert immer eine aktive Lizenz, egal ob der Anrufer ein Org-Admin ist oder nicht.
• Ein Mitglied zu einem Projekt hinzuzufügen, erfordert nicht, dass dieses Mitglied eine Lizenz besitzt. Die API registriert sie sofort als Projektmitglied, aber sie können erst auf das Projekt zugreifen, wenn sie eine Lizenz besitzen. Der Zielnutzer muss bereits der Organisation angehören. Sie können niemanden hinzufügen, der nicht bereits Organisationsmitglied ist.
• Das Löschen eines Projekts ist endgültig. Es gibt keine Selbstwiederherstellung für ein gelöschtes Projekt.
• In jedem Fall ist die Antwort auf das Produkt des API-Schlüssels beschränkt. Ein API-Schlüssel des Axe Developer Hub gibt nur Axe Developer Hub (Web)-Projekte zurück und verwaltet diese. Ein Axe DevTools Mobile-API-Schlüssel gibt nur Axe DevTools Mobile-Projekte zurück und verwaltet diese.

Ein inaktives Abonnement gibt 401 Unauthorized zurück.

Konfigurationswerte für Projekttypen

Jedes Projekt hat einen selected_project_type, und jeder Typ akzeptiert nur einen bestimmten, festen Satz von test_language / test_platform-Werten:

Ein Projekt-selected_project_type ist festgelegt, wenn das Projekt erstellt wird. Um einen anderen Typ zu verwenden, erstellen Sie ein neues Projekt.

Projekte auflisten

Gibt die Liste der Projekte zurück, auf die der authentifizierte API-Schlüssel zugreifen kann.

Anfrage

• Endpunkt: GET https://axe.deque.com/api-pub/v1/results/projects
• Header (erforderlich):
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

Abfrageparameter

Alle Abfrageparameter sind optional.

Antwortinhalt

Eine erfolgreiche Antwort gibt ein JSON-Array von Projektobjekten zurück. Jedes Projektobjekt enthält die folgenden Felder:

Antworten können zusätzliche Felder enthalten, die hier nicht aufgeführt sind, und im Laufe der Zeit können neue Felder hinzugefügt werden. Ignorieren Sie alle Felder, die Sie nicht erkennen, und verlassen Sie sich nicht auf nicht dokumentierte Felder.

Beispiel für den Antwortinhalt

[
  {
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright",
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-06-01T14:23:00.000Z",
    "updated_at": "2026-06-10T16:45:00.000Z",
    "run_by": "Jane Developer",
    "last_session_created_at": "2026-06-14T09:12:00.000Z",
    "has_git_information": true,
    "git_url": "https://github.com/example/webapp",
    "latest_session": {
      "id": "0d4a85a2-9e6f-44ef-b814-fee8412abeb0",
      "created_at": "2026-06-14T09:12:00.000Z",
      "git_branch": "main"
    }
  },
  {
    "project_id": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
    "name": "design-system",
    "selected_project_type": "axe-devtools-html",
    "test_language": null,
    "test_platform": null,
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-05-20T08:00:00.000Z",
    "updated_at": null,
    "run_by": null,
    "last_session_created_at": null,
    "has_git_information": false,
    "git_url": null,
    "latest_session": null
  },
  {
    "project_id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",
    "name": "ios-app-ci",
    "selected_project_type": "axe-devtools-mobile",
    "test_language": null,
    "test_platform": "XCUITest",
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-06-03T10:15:00.000Z",
    "updated_at": null,
    "run_by": "Jane Developer",
    "last_session_created_at": "2026-06-15T11:05:00.000Z",
    "has_git_information": false,
    "git_url": null,
    "latest_session": {
      "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
      "created_at": "2026-06-15T11:05:00.000Z",
      "git_branch": null
    }
  }
]

Um das Beispiel kurz zu halten, zeigt jedes latest_session-Objekt nur drei seiner Felder. Die API gibt mehr zurück.

Cursor-Paginierung

Die Paginierung ist optional. Weder page_size noch after senden, und die Antwort gibt Ihre vollständige Projektliste in einer einzigen Antwort zurück, ohne Cursor-Header.

Um stattdessen durch die Ergebnisse zu blättern, verwendet die Projekt-API die gleiche cursorbasierte Paginierung wie die Sitzungs-Endpunkt. Wenn es mehr Ergebnisse über die aktuelle Seite hinaus gibt, gibt die Antwort einen undurchsichtigen Cursor-Wert im x-pagination-cursor-Header zurück. Übergeben Sie diesen Wert als after Abfrageparameter in Ihrer nächsten Anfrage, um die nächste Seite abzurufen.

Wenn die Antwort kein x-pagination-cursor-Header hat, sind Sie auf der letzten Seite.

Ein Projekt-ID nach Namen suchen

Dieses Beispiel verwendet curl und jq, um die ID eines Projekts von seinem Namen aus zu finden:

curl -s \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  "https://axe.deque.com/api-pub/v1/results/projects" \
  | jq -r '.[] | select(.name == "webapp-ci") | .project_id'

Übermitteln Sie die zurückgegebene ID an die Sitzungs-Endpunkt, um die Sitzungen dieses Projekts aufzulisten.

Fehlerantworten bei der Projektauflistung

Ein Projekt abrufen

Gibt ein einzelnes Projekt nach seiner ID zurück, in der gleichen Form wie Projekte auflisten.

Anfrage

• Endpunkt: GET https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• Header (erforderlich):
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

Fehlerantworten beim Abrufen eines Projekts

Ein Projekt erstellen

Anfrage

• Endpunkt: POST https://axe.deque.com/api-pub/v1/results/projects
• Header (erforderlich):
  • X-API-Key: <DEQUE_API_KEY>
  • Content-Type: application/json
  • Accept: application/json

Anfrage-Inhalt

Beispiel für Anfrage-Inhalt

{
  "name": "webapp-ci",
  "selected_project_type": "axe-devtools-watcher",
  "test_language": "typescript",
  "test_platform": "Playwright"
}

Antwortinhalt

Gibt das erstellte Projekt zurück, in derselben Form wie Projekte auflisten. Wer ein Projekt erstellt, wird automatisch dessen Projekt-Administrator, sodass kein separater Mitgliedschaftsanruf erforderlich ist. Ein erfolgreicher Erstellvorgang gibt 201 Created zurück.

Fehlerantworten beim Erstellen eines Projekts

Ein Projekt aktualisieren

Anfrage

• Endpunkt: PATCH https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• Header (erforderlich):
  • X-API-Key: <DEQUE_API_KEY>
  • Content-Type: application/json
  • Accept: application/json

Anfrage-Inhalt

Beispiel für Anfrage-Inhalt

{
  "name": "webapp-ci-renamed"
}

Antwortinhalt

Gibt das aktualisierte Projekt zurück, in derselben Form wie Projekte auflisten. Eine erfolgreiche Aktualisierung gibt 200 OK zurück.

Fehlerantworten bei der Aktualisierung eines Projekts

Ein Projekt löschen

Anfrage

• Endpunkt: DELETE https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• Header (erforderlich):
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

Antwortinhalt

{ "deleted": true }

Fehlerantworten beim Löschen eines Projekts

Projektmitgliedschaft

Die Mitgliedschaft eines Projekts ist eine Unterressource des Projekts. Ein Projektadministrator kann das Projekt und seine Mitgliedschaft verwalten. Ein Projektmitglied (die member-Rolle in den unten stehenden Mitgliedschaftsoperationen) kann auf das Projekt zugreifen, es jedoch nicht verwalten. Die Mitgliedschaftsoperationen identifizieren Benutzer anhand ihrer E-Mail-Adresse. Das Hinzufügen eines Mitglieds erfordert nicht, dass dieses Mitglied eine Lizenz besitzt. Die API erfasst sie sofort, aber sie können nicht auf das Projekt zugreifen, bis sie eine Lizenz besitzen. Der Zielbenutzer muss bereits Ihrer Organisation angehören. Sie können niemanden hinzufügen, der nicht bereits Mitglied der Organisation ist.

Verwenden Sie nach Möglichkeit die folgenden Batch-Operationen. Alle drei Schreiboperationen akzeptieren mehrere Benutzer in einem einzigen Anruf. Dies reduziert die Anzahl der nötigen Anfragen. Wenn Sie die Mitgliedschaft für eine große Organisation verwalten, wenden Sie Backoff und Wiederholungen an, wenn Sie eine 429-Antwort erhalten. Siehe 429 Too Many Requests für das allgemeine Muster.

Projektmitglieder auflisten

• Endpunkt: GET https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• Header (erforderlich): X-API-Key: <DEQUE_API_KEY>, Accept: application/json

Antwortinhalt

{
  "members": [
    {
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": "admin",
      "email": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "active_license": true,
      "created_at": "2026-06-01T14:23:00.000Z"
    }
  ]
}

Projektmitglieder hinzufügen

• Endpunkt: POST https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• Header (erforderlich): X-API-Key: <DEQUE_API_KEY>, Content-Type: application/json, Accept: application/json

Anfrage-Inhalt

{
  "user_email_role_pairs": [
    { "user_email": "sam@example.com", "role": "member" },
    { "user_email": "alex@example.com", "role": "admin" }
  ]
}

user_email ist die E-Mail-Adresse des Axe Accounts des Benutzers. Der Abgleich ignoriert Groß- und Kleinschreibung und umgebende Leerzeichen. role akzeptiert admin oder member (contributor wird ebenfalls als Synonym für member akzeptiert). Jeder Benutzer kann in einer Anfrage nur einmal auftauchen. Das Hinzufügen eines Benutzers, der bereits zum Projekt gehört, ist für diesen Eintrag ein No-Op: es ändert seine bestehende Rolle nicht. Dies ist eine Stapeloperation. Ein ungültiger Eintrag lehnt die gesamte Anfrage ab, und die API schreibt nichts. Die Fehlermeldung listet jeden Eintrag auf, der fehlgeschlagen ist, sodass Sie einen Stapel in einem Durchgang korrigieren können.

Ein erfolgreicher Antrag gibt 201 Created mit { "created": true } zurück, unabhängig davon, ob der Antrag tatsächlich neue Mitgliedschaften hinzugefügt hat.

Mitgliedsrollen ändern

• Endpunkt: PATCH https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• Header (erforderlich): X-API-Key: <DEQUE_API_KEY>, Content-Type: application/json, Accept: application/json
• Anfrage-Inhalt: gleiche user_email_role_pairs-Form wie Projektmitglieder hinzufügen

Jedes user_email muss einem aktuellen Mitglied des Projekts angehören. Ein Projekt muss immer mindestens einen admin behalten. Die API lehnt eine Anfrage ab, die das Projekt ohne Admin zurücklässt. Ein allein verbleibendes Mitglied, das der einzige Admin des Projekts ist, kann seine eigene Rolle nicht ändern. Dies ist ein Batch-Vorgang. Ein ungültiger Eintrag lehnt die gesamte Anfrage ab, und die API schreibt nichts.

Eine erfolgreiche Anfrage gibt 200 OK mit { "ok": true } zurück.

Projektmitglieder entfernen

• Endpunkt: DELETE https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships?user_emails={comma-separated,url-encoded,emails}
• Header (erforderlich): X-API-Key: <DEQUE_API_KEY>, Accept: application/json

Übergeben Sie die E-Mail-Adressen der zu entfernenden Benutzer als kommagetrennte Liste in einem einzigen user_emails Query-Parameter und URL-kodieren Sie den Wert. Zum Beispiel kommt ein nicht kodiertes Literal + in einer Adresse als Leerzeichen an und wird als fehlerhaft abgelehnt. Es gibt keinen Anfrageinhalt. Das Entfernen eines Benutzers, der kein Mitglied ist, ist erfolgreich und entfernt nichts, sodass eine wiederholte Anfrage kein Fehler ist. Ein Projekt muss immer mindestens einen admin behalten. Die API lehnt eine Anfrage ab, die den letzten Admin des Projekts entfernt. Ein allein verbleibendes Mitglied, das der einzige Admin des Projekts ist, kann sich nicht selbst entfernen.

Eine erfolgreiche Anfrage gibt 200 OK mit den Adressen zurück, die entfernt wurden, und denen, die keinem Mitglied entsprachen, sodass Sie einen Tippfehler von einer vollendeten Entfernung unterscheiden können:

{
  "deleted": true,
  "removed": ["sam@example.com"],
  "unmatched": ["alx@example.com"]
}

Fehlermeldungen zur Projektmitgliedschaft