Axe Developer Hub APIs
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
Ein Überblick über die verfügbaren REST-APIs für Axe Developer Hub
Not for use with personal data
Der Axe Developer Hub stellt eine Reihe von REST-APIs zur Verfügung, die Sie mit Ihrem bestehenden Axe-Account-API-Schlüssel aufrufen können: Es sind keine separaten Anmeldedaten erforderlich. Verwenden Sie sie, um CI/CD-Pipelines auf Grundlage des Barrierefreiheitsstatus zu steuern, Barrierefreiheitsberichte programmgesteuert abzurufen und Ihre Projekte zu erstellen, zu verwalten und nachzuschlagen.
Welche API benötige ich?
| Ich möchte... | Nutzen Sie... |
|---|---|
| Authentifizierung einrichten, eine Projekt-ID finden und einen ersten Aufruf tätigen | Erste Schritte mit den Axe Developer Hub APIs |
| Projekte und deren Mitglieder erstellen und verwalten, Ihre Projekte auflisten oder eine Projekt-ID nach Name suchen | Projekte API-Referenz |
| Automatisierte Projekterstellung und Mitgliederverwaltung, Schritt für Schritt | Erste Schritte mit der Projektmanagement-Automatisierung |
| Einen Pull-Request oder Commit bei auftretenden Barrierefreiheitsfehlern fehlschlagen lassen, aus einer nicht GitHub CI/CD-Pipeline (GitLab, BitBucket und ähnlich) | Commit-Status API-Referenz |
| Dasselbe aus einer GitHub-Pipeline tun | Die GitHub Action verwenden, anstatt die REST-API direkt aufzurufen |
| Vollständige Barrierefreiheitsberichte für eine Sitzung abrufen oder die Sitzungen eines Projekts auflisten | Sitzungen und Ergebnisse API-Referenz |
| Einen zusammenfassenden Bericht herunterladen, wie es ältere Integrationen tun | Ergebnisse programmgesteuert abrufen (veraltet): stattdessen zur Sitzungen und Ergebnisse API migrieren |
Authentifizierung auf einen Blick
Jede API in dieser Liste authentifiziert sich auf die gleiche Weise, mit Ihrem Axe-Account-API-Schlüssel in einem X-API-Key-Header. Siehe Erste Schritte mit den Axe Developer Hub APIs, um einen Schlüssel zu erhalten, Ihre Projekt-ID zu finden und Ihren ersten Aufruf zu tätigen.