Einleitung
Die axe Monitor-API bietet Entwicklern eine optimierte Möglichkeit, mit den Ergebnisdaten der Barrierefreiheitstests außerhalb der axe Monitor-Benutzeroberfläche zu interagieren. Mithilfe von RESTful-Webdiensten bietet die API Zugriff auf:
Scans eines Benutzers
Scanläufe eines Scans
Seitendetails für einen Scan-Lauf
Problemdetails für einen Scan-Lauf
Problemdetails für eine Seite
Lizenzierte axe Monitor-Benutzer können die API mit externen Anwendungen verwenden, vorausgesetzt, die Nutzung entspricht der Abonnement-Lizenzvereinbarung.
Erste Schritte
Erstellen Sie einen API-Schlüssel über das axe Account.
Wählen Sie auf der Seite „API-Schlüssel“ im axe Account die Schaltfläche „Neuen API-Schlüssel hinzufügen“ aus.
Ein Modalfenster wird angezeigt. Wählen Sie „axe Monitor“ aus der Produkt-Dropdownliste aus, benennen Sie Ihren API-Schlüssel und wählen Sie die Schaltfläche „Speichern“ aus.
Kopieren Sie den API-Schlüssel in der Spalte „Aktionen“ in Ihre Zwischenablage.
Geben Sie die API-Basis-URL ein: Greifen Sie über Ihre bevorzugte API-Plattform, z. B. Postman oder SwaggerUI, oder Ihr Arbeitsverzeichnis auf die axe Monitor-API zu. Ersetzen Sie „IhrUnternehmen“ durch die Subdomäne für Ihre axe Monitor-Instanz.
https://yourcompany.dequecloud.com/monitor-public-api/v1/{endpoint}
Kopfzeilen hinzufügen:
Um auf die API zuzugreifen, müssen Sie sich mit dem API-Schlüssel vom axe-Konto authentifizieren.
X-API-Key: <your_api_key>
Name
Art
Beschreibung
X-Pagination-Per-Page
Integer
Standardwert: 10
Die maximale Anzahl der auf einer einzelnen Seite zurückgegebenen Elemente
X-Pagination-Page
Integer
Standardwert: 1
Die angeforderte Seitenzahl
Beispiel einer CURL-Anforderung
curl -X 'GET' \
'https://{base_url}/monitor-public-api/v1/scans/1/runs/1/issues?sortBy=testPageTitle&sortDir=desc' \
-H 'accept: application/json' \
-H 'X-API-KeyAuthorization: <your_api_key>' '
Endpunkte
Alle Endpunkte können Informationen mit GET-Anfragen abrufen.
Endpunkt
Zweck
/scans
Listen Sie alle Scans auf, auf die ein Benutzer zugreifen kann. Ermöglicht das Abrufen scanId.
/scans/[scanId]/runs
Listet alle Scanläufe für einen Scan mit Übersichtsinformationen zum Scan auf. Ermöglicht Ihnen das Abrufen der runId.
/scans/[scanId]/runs/[runId]/pages
Detaillierte Seiteninformationen zu einem Scanlauf
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues
Detaillierte Zugänglichkeitsprobleme für eine Seite
/scans/[scanId]/runs/[runId]/issues
Detaillierte Zugänglichkeitsprobleme für einen Scan-Lauf
Scans für einen Benutzer auflisten
Beispielhafte Anfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>
Beispielantwort
{
"scans": [
"id": 1,
"name": "Test Scan",
"groups": [
"id": 1,
"name": "Group A"
]
]
}
Beispiel für eine Fehlerantwort
Scanläufe für einen Scan
Beispielhafte Anfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>
Erforderliche Parameter
Name
Art
Beschreibung
scanId
String
Die eindeutige Kennung des Scans.
Optionale Parameter
Name
Art
Beschreibung
needsReview
String
Mit „true“ oder „false“ können Sie steuern, ob Probleme vom Typ „Benötigt Überprüfung“ in der Antwort gezählt werden.
Beispielantwort
{
"runs": [
{
"runNumber" : 1,
"status" : "Complete",
"queuedAt": "2024-09-30T05:11:42Z",
"startedAt": "2024-09-30T05:11:45Z",
"completedAt": "2024-09-30T05:12:30Z",
"totalIssueCount": 29,
"completedPages": 1,
"axeVersion" : "4.9.0",
"standard" : "WCAG 2.2 AA"
“score”: “0”
“issues”: “28”
[ "criticalissues": “20”,
"seriousissues": “2”,
"moderateissues": “4”,
"minorissues": “2”,
]
pages: “40”
[ "criticalpages": “20”,
“aria”: “2”,
“color”: “2”,
“forms”: “2”,
“keyboard”: “2”,
“language”: “2”,
“namerolevalue”: “2”,
“pdf”: “2”,
“parsing”: “2”,
“semantics”: “2”,
“sensoryvisual”: “2”,
“structure”: “2”,
“tables”: “2”,
“alttext”: “2”,
“timemedia”: “2”
]
}
]
}
Seitendetails für einen Scan-Durchlauf
Beispielhafte Anfrage
GET https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages X-API-KEY: <your_api_key>
Erforderliche Pfadparameter
Name
Art
Beschreibung
scanId
String
Die eindeutige Kennung des Scans.
runNumber
Integer
Die spezifische Laufnummer des Scans.
Optionale Anforderungsparameter
Name
Art
Beschreibung
status
String
Filtert Seiten nach Status (Abgeschlossen, Fehlgeschlagen).
sortBy
String
Gibt die Spalte an, nach der sortiert werden soll (Titel, URL). Der Standardwert ist Titel
order
String
Gibt die Sortierrichtung an (aufsteigend oder absteigend). Der Standardwert ist „desc“.
Beispielantwort
{
"pages": [
{
"id": 0,
"url": "string",
"title": "string",
"reasonForFailure": "string",
"totalCriticalIssues": 0,
"totalSeriousIssues": 0,
"totalModerateIssues": 0,
"totalMinorIssues": 0,
"totalNeedsReview": 0,
"totalFixedIssues": 0,
"totalOpenIssues": 0,
"health": "string",
"status": "string",
"scriptName": "string",
"scriptStep": 0,
"template": true,
"date": "2024-12-02T15:03:40.211Z",
"domainUrl": "string"
}
]
}
Problemdetails für eine Seite
Beispielhafte Anfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>
Erforderliche Parameter
Name
Art
Beschreibung
scanId
String
Die eindeutige Kennung des Scans.
runNumber
Integer
Die spezifische Laufnummer des Scans.
pageId
String
Die eindeutige Kennung der Seite.
Optionale Parameter
Name
Art
Beschreibung
status
String
Filtert Probleme nach Status (offen, behoben oder ignoriert).
sortBy
String
Gibt die Spalte an, nach der sortiert werden soll (testPageTitle, testUrl, Selektor, createdAt oder status). Der Standardwert ist testPageTitle.
order
String
Gibt die Sortierrichtung an (aufsteigend oder absteigend). Der Standardwert ist „desc“.
Beispielantwort
{
"issues": [
{
"issueId": 0,
"ruleId": "string",
"description": "string",
"help": "string",
"helpUrl": "string",
"impact": "string",
“issuegroup”: “string”
"needsReview": true,
"isExperimental": true,
"isManual": true,
"summary": "string",
"selector": [
"string"
],
"source": "string",
"tags": [
"string"
],
"igt": "string",
"testName": "string",
"createdAt": "2024-12-02T14:59:24.232Z",
"testUrl": "string",
"testPageTitle": "string",
"status": "string"
}
]
}
Problemdetails für einen Scan-Durchlauf
Beispielhafte Anfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>
Erforderliche Parameter
Name
Art
Erforderlich
Beschreibung
scanId
String
Ja
Die eindeutige Kennung des Scans.
runNumber
Integer
Ja
Die spezifische Laufnummer des Scans.
pageId
String
Ja
Die eindeutige Kennung der Seite.
Optionale Anforderungsparameter
Name
Art
Erforderlich
Beschreibung
status
String
Kein
Filtert Probleme nach Status (offen, behoben oder ignoriert).
sortBy
String
Kein
Gibt die Spalte an, nach der sortiert werden soll (testPageTitle, testUrl, Selektor, createdAt oder status). Der Standardwert ist testPageTitle.
order
String
Kein
Gibt die Sortierrichtung an (aufsteigend oder absteigend). Der Standardwert ist „desc“.
Beispielantwort
{
"issues": [
{
"issueId": 0,
"ruleId": "string",
"description": "string",
"help": "string",
"helpUrl": "string",
"impact": "string",
“issuegroup”: “string”
"needsReview": true,
"isExperimental": true,
"isManual": true,
"summary": "string",
"selector": [
"string"
],
"source": "string",
"tags": [
"string"
],
"igt": "string",
"testName": "string",
"createdAt": "2024-12-02T14:59:24.232Z",
"testUrl": "string",
"testPageTitle": "string",
"status": "string"
}
]
}
Fehler
HTTP-Statuscode
Fehlertyp
Beschreibung
401
Nicht autorisiert
Der Benutzer ist nicht authentifiziert oder verfügt nicht über die erforderlichen Zugriffsrechte.
400
Ungültige Anfrage
Die Anfrage enthält ungültige Parameter.
500
Interner Serverfehler
Beim Verarbeiten der Anfrage ist ein Fehler aufgetreten.