Scans über die API erstellen, ändern und ausführen

Axe Monitor-Administratoren können in Axe Account einen API-Schlüssel generieren und Scans systematisch erstellen, ändern oder ausführen, ohne die Benutzeroberfläche zu verwenden.

Erfahren Sie mehr über Erste Schritte.

Endpunkte

Einen Scan erstellen

Erstellt einen Scan aus einem einzelnen Scan-Einstellungsobjekt. Um mehrere Scans gleichzeitig zu erstellen, senden Sie eine Anfrage pro Scan.

Hinweis: Um Ihre Anmeldedaten sicher zu halten, akzeptiert die API keine Passwörter, Keystore-Dateien oder Umgebungsvariablenwerte. Fügen Sie diese Werte in der Benutzeroberfläche von Axe Monitor in den Anmeldedaten des Scans hinzu.

Beispielanfrage

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>
Content-Type: application/json

Erforderliche Parameter

Optionale Einstellungen

Zusätzliche Scan-Einstellungen können mit dem Create Scan Endpunkt verwendet werden. Siehe Scan-Einstellungen Dokumentation.

Beispielanfrage

{
  "name": "Marketing Site - Production",
  "sites": ["https://www.example.com"],
  "axeCoreVersion": "latest",
  "standardLevel": "wcag22aa",
  "standardOptions": ["best-practice"],
  "depth": 3,
  "pageLimit": 100,
  "skipSpecificUrls": ["https://www.example.com/logout"],
  "teams": [
    { "name": "Digital Accessibility Team" }
  ],
  "notifyGroup": true
}

Beispielantwort

Status: 201 Created

{
  "scanId": 12345
}

Verwenden Sie die zurückgegebene [scanId], um den Scan zu lesen, zu bearbeiten oder auszuführen.

Hinweis: Die API akzeptiert keine Passwörter, Keystores oder Umgebungsvariablenwerte. Wenn Ihr Scan sich auf einer Website anmeldet oder Skripte ausführt, die geheime Werte benötigen, erstellen Sie den Scan über die API und fügen Sie dann diese Werte in Axe Monitor unter Erweiterte Einstellungen, Sitzung starten hinzu.

Fehlerantworten

Einen Scan bearbeiten

Aktualisiert eine oder mehrere Einstellungen eines vorhandenen Scans. Senden Sie nur die Einstellungen, die Sie ändern möchten; Einstellungen, die Sie weglassen, behalten ihre aktuellen Werte.

Hinweis:

• Einige Einstellungen erfordern IDs, um bearbeitet zu werden. Sehen Sie sich die Dokumentation zum Abrufen von IDs an.
• Wenn ein Scan mit einer Voreinstellung angewendet wurde, sind einige Einstellungen möglicherweise nicht bearbeitbar. Sehen Sie sich die Voreinstellungsdokumentation an.
• Sehen Sie sich die vollständige Liste der Scan-Einstellungen an, die über die API bearbeitet werden können.

Beispielanfrage

PATCH
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/settings
X-API-Key: <your_api_key>
Content-Type: application/json

Erforderliche Parameter

Mindestens eine zusätzliche Einstellung ist erforderlich, um eine Änderung vorzunehmen. Sehen Sie die Dokumentation zu Scan-Einstellungen an.

Hinweis:

• ‚null‘ setzt ein Feld auf seinen Standardwert zurück
• Arrays ersetzen den gespeicherten Wert

Beispielanfrage

{
  "name": "Marketing Site - Production (weekly)",
  "depth": 4,
  "pageLimit": 250
}

Beispielantwort

Status: 200 OK

{
  "scanId": 12345,
  "updatedFields": ["name", "depth", "pageLimit"]
}

updatedFields listet die geänderten Einstellungen auf.

Fehlerantwort

Einen Scanlauf starten

Stellt einen neuen Lauf eines vorhandenen Scans in die Warteschlange. Der Lauf startet, wenn axe Monitor ihn aus der Warteschlange abruft. Um den Fortschritt zu überprüfen, verwenden Sie GET /scans/[scanId]/runs.

Beispielanfrage

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

Erforderliche Parameter

Beispielantwort

Status: 202 Accepted

Die Antwort hat keinen Inhalt.

Beispiel für eine Fehlerantwort

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Couldn't queue job since it's already running",
  "instance": "/v1/scans/20/runs"
}

Fehlerantworten