axe Monitor API

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
Not for use with personal data

Einleitung

Die axe Monitor API bietet Entwicklern eine vereinfachte Möglichkeit, mit Daten von Barrierefreiheitstests außerhalb der axe Monitor Benutzeroberfläche zu interagieren. Mithilfe von RESTful Webdiensten ermöglicht die API den Zugriff auf:

  • Scans für einen Benutzer
  • Scan-Durchläufe für einen Scan
  • Seitendetails für einen Scan-Durchlauf
  • Problemspezifikationen für einen Scan-Durchlauf
  • Problemspezifikationen für eine Seite

Lizenzierte axe Monitor-Benutzer können die API mit externen Anwendungen verwenden, vorausgesetzt, dass die Nutzung den Bestimmungen der Abonnement-Lizenzvereinbarung entspricht.

Erste Schritte

  1. Erstellen Sie einen API-Schlüssel über das axe-Konto.

    Beachten Sie die unten stehenden regionalen Anweisungen:

    Führen Sie die folgenden Schritte aus, um Ihren API-Schlüssel zu generieren:

    • Auf der Seite API-Schlüssel im axe-Konto, wählen Sie die Schaltfläche „Neuen API-Schlüssel hinzufügen“.
      Der Dialog NEUEN API-SCHLÜSSEL HINZUFÜGEN erscheint.

    • Wählen Sie axe Monitor aus dem Produkt-Dropdown, benennen Sie Ihren API-Schlüssel und wählen Sie die Schaltfläche Speichern.

    • Unter der Spalte Aktionen kopieren Sie den API-Schlüssel in die Zwischenablage.

  2. Geben Sie die API-Basis-URL ein: Verwenden Sie Ihre bevorzugte API-Plattform, wie Postman oder SwaggerUI, oder Ihr Arbeitsverzeichnis, um auf die axe Monitor API zuzugreifen. Ersetzen Sie „yourcompany“ durch das Subdomain 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 aus dem axe-Konto authentifizieren.

X-API-Key: <your_api_key>

Optionale Header-Parameter

Name Typ Beschreibung
X-Pagination-Per-Page Integer Die maximale Anzahl von Elementen, die auf einer einzelnen Seite zurückgegeben werden. Standardwert: 10
X-Pagination-Page Integer Die angeforderte Seitennummer. Standardwert: 1

Beispiel CURL-Anfrage

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-Key: <your_api_key>'

Endpunkte

Alle Endpunkte können mit GET-Anfragen Informationen abrufen.

Endpunkt Zweck
/scans Listet alle Scans auf, auf die ein Benutzer zugreifen kann. Ermöglicht das Abrufen scanId.
/scans/[scanId]/runs Listet alle Scan-Durchläufe für einen Scan auf, mit Übersichtsinformationen zum Scan. Ermöglicht das Abrufen der runId.
/scans/[scanId]/runs/[runId]/pages Detaillierten Seiteninformationen für einen Scan-Durchlauf
/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-Durchlauf

Scans für einen Benutzer auflisten

Beispielanforderung

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-Fehlerantwort

Scan-Durchläufe für einen Scan

Beispielanforderung

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>

Erforderliche Parameter

Name Typ Beschreibung
scanId Zeichenkette Der eindeutige Identifikator des Scans.

Optionale Parameter

Name Typ Beschreibung
needsReview Zeichenkette „true“ oder „false“ ermöglicht die Steuerung, ob „Überprüfung erforderlich“-Probleme in der Antwort berücksichtigt werden.

Beispielantwort


{
  "scanRuns": [
    {
      "runNumber": 1,
      "status": "Completed",
      "queuedAt": "2025-08-21T06:50:27Z",
      "startedAt": "2025-08-21T06:50:37Z",
      "completedAt": "2025-08-21T06:51:52Z",
      "axeVersion": "4.10.3",
      "standard": "WCAG 2.1 AA",
      "score": 0,
      "issues": {
        "total": 392,
        "critical": 77,
        "serious": 315,
        "moderate": 0,
        "minor": 0
      },
      "pages": {
        "total": 18,
        "completed": 17,
        "critical": 17
      },
      "violationGroups": [
        {
          "name": "color",
          "pageCount": 17
        },
        {
          "name": "forms",
          "pageCount": 17
        },
        {
          "name": "name-role-value",
          "pageCount": 10
        },
        {
          "name": "parsing",
          "pageCount": 1
        },
        {
          "name": "text-alternatives",
          "pageCount": 13
        }
      ]
    }
  ]
}

Hinweis: Wenn Ihr Scan einen oder mehrere Begriffe im „Text finden“-Einstellung enthalten hat, umfasst die API-Antwort ein findText-Array.

Jeder Eintrag enthält:

  • Den eingegebenen Begriff.
  • Die Anzahl der Seiten, auf denen der Begriff identifiziert wurde.

Seitendetails für einen Scan-Durchlauf

Beispielanforderung

GET https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
 X-API-KEY: <your_api_key>

Erforderliche Pfadparameter

Name Typ Beschreibung
scanId Zeichenkette Der eindeutige Identifikator des Scans.
runNumber Ganzzahl Die spezifische Durchlaufnummer des Scans.

Optionale Anforderungsparameter

Name Typ Beschreibung
status Zeichenkette 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 absteigend.

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"
      "findtext"
[     "Accessibility Statement",
      "WCAG"

    }
  ]
}

Hinweis: Wenn die Einstellung „Text suchen“ für den Scan aktiviert ist, enthält das Array alle Phrasen aus der Einstellung „Text suchen“, die auf dieser Seite identifiziert wurden.

Problemdetails für eine Seite

Beispielanfrage

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 Typ Beschreibung
scanId String Die eindeutige Kennung des Scans.
runNumber Ganzzahl Die spezifische Laufnummer des Scans.
pageId String Die eindeutige Kennung der Seite.

Optionale Parameter

Name Typ Beschreibung
status string Filtert Probleme nach Status (offen, behoben oder ignoriert).
sortBy String Gibt die Spalte an, nach der sortiert werden soll (testPageTitle, testUrl, selector, createdAt oder status). Der Standardwert ist testPageTitle.
order String Gibt die Sortierrichtung an (aufsteigend oder absteigend). Der Standardwert ist absteigend.

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 Scanlauf

Beispielanfrage


GET 
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>

Erforderliche Parameter

Name Typ Erforderlich Beschreibung
scanId String Ja Die eindeutige Kennung des Scans.
runNumber Ganzzahl Ja Die spezifische Laufnummer des Scans.

Optionale Anforderungsparameter

Name Typ Erforderlich Beschreibung
status Zeichenkette Nein Filtert Probleme nach Status (offen, behoben oder ignoriert).
sortBy Zeichenkette Nein Gibt die Spalte an, nach der sortiert werden soll (testPageTitle, testUrl, selector, createdAt oder status). Standardwert ist testPageTitle.
order Zeichenkette Nein Gibt die Sortierrichtung an (asc oder desc). Standardwert ist desc.

Beispielantwort

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
      "issueGrouping": "string",
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
      "string"
      ],
      "source": "string",
      "tags": [
      "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2025-08-07T10:54:30.268Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

Fehler

HTTP-Statuscode Fehlertyp Beschreibung
401 Nicht autorisiert Der Benutzer ist nicht authentifiziert oder hat keine Zugriffsrechte.
400 Ungültige Anfrage Die Anfrage enthält ungültige Parameter.
500 Interner Serverfehler Beim Verarbeiten der Anfrage ist ein Fehler aufgetreten.

Is this page helpful?

Help us improve this page

Still need help?