Holen Sie sich IDs per API
Axe Monitor-Benutzer können einen API-Schlüssel in Axe Account generieren und IDs nachschlagen, die für die Verwendung mit anderen Axe Monitor-API-Endpunkten erforderlich sind, ohne die Benutzeroberfläche zu nutzen.
Erfahren Sie mehr über Erste Schritte.
Endpunkte
| Methode | Endpunkt | Zweck |
|---|---|---|
| GET | /lookups/presets |
Abrufen von voreingestellten IDs, um ein Preset auf einen Scan anzuwenden. Und wenn ein Scan derzeit einem Preset zugewiesen ist – nachsehen, welche Felder bearbeitet werden können. |
| GET | /lookups/teams |
Erhalten Sie den Teamnamen & IDs, um über die API Zugang zu Scans zu gewähren. |
| GET | /lookups/scans |
Erhalten Sie die Scan-Namen & IDs, um Ergebnisse zu erhalten, Scans zu bearbeiten oder auszuführen. |
| GET | /scans/[scanId]/runs |
Listen Sie alle Scan-Läufe für einen Scan mit Scan-Übersichtsinformationen auf. Damit können Sie runId abrufen. |
| GET | /lookups/scan-groups |
Erhalten Sie Scan-Gruppennamen & IDs, um Scans über die API zu organisieren. |
| GET | /lookups/scripts |
Holen Sie sich IDs, um freigegebene Skripte via API Scans zuzuweisen. |
Voreinstellungen
Sie können die Preset-Einstellungen über die API auf einen Scan anwenden, aber zuerst werden die Preset-ID & der Name benötigt. Verwenden Sie diesen Endpunkt, um sie nachzuschlagen.
Die Preset-ID ist auch nötig, um zu verstehen, welche Scaneinstellungen bearbeitbar sind, wenn ein Preset bereits angewendet wurde.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/presets
X-API-Key: <your_api_key>
Content-Type: application/jsonBeispielantwort
Status: 200 Erfolg
{
"presets": [
{ "id": 3, "name": "Gov Baseline" },
{ "id": 1, "name": "Marketing sites" }
]
}Teams
Sie können Teamberechtigungen festlegen, wenn Sie einen Scan über die API erstellen oder bearbeiten. Verwenden Sie diesen Endpunkt, um Teamnamen und IDs nachzuschlagen.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/teams
X-API-Key: <your_api_key>
Content-Type: application/jsonBeispielantwort
Status: 200 Erfolg
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
]
}Scans
Scan-IDs und -Namen sind erforderlich, um Ergebnisse zu erhalten, Scans zu bearbeiten und auszuführen. Verwenden Sie diesen Endpunkt, um sie nachzuschlagen.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scans
X-API-Key: <your_api_key>
Content-Type: application/jsonBeispielantwort
Status: 200 Erfolg
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
]
}Scan-Läufe
Scan-Lauf-IDs können mit diesem Endpunkt abgerufen werden, um detaillierte Ergebnisedaten zu erhalten.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>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
}
]
}
]
}Scan-Gruppen
Sie können Scans nach Scan-Gruppen organisieren, wenn Sie Scans über die API erstellen oder bearbeiten. Verwenden Sie diesen Endpunkt, um Scan-Gruppen-IDs und -Namen nachzuschlagen.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scan-groups
X-API-Key: <your_api_key>
Content-Type: application/jsonBeispielantwort
Status: 200 Erfolg
{
"scanGroups": [
{ "id": 1234, "name": "Marketing" },
{ "id": 1200, "name": "Storefront" }
]
}Freigegebene Skripte
Freigegebene Skripte, die im Admin-Abschnitt von Axe Monitor gespeichert und über mehrere Scans verwendet werden, können bei der Erstellung oder Bearbeitung von Scans über die API angewendet werden. Verwenden Sie diesen Endpunkt, um IDs der freigegebenen Skripte nachzuschlagen.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scripts
X-API-Key: <your_api_key>
Content-Type: application/jsonBeispielantwort
Status: 200 Erfolg
{
"scripts": [
{ "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
{ "id": 9, "name": "SSO login", "type": "SESSION" }
]
}