Ottieni ID tramite API
Gli utenti di Axe Monitor possono generare una chiave API in Axe Account e cercare gli ID richiesti per l'uso con altri endpoint API di Axe Monitor, senza utilizzare l'interfaccia utente.
Scopri di più su Per iniziare.
Endpoint
| Metodo | Endpoint | Scopo |
|---|---|---|
| GET | /lookups/presets |
Recupera gli ID preimpostati per applicare un preset a una scansione. Inoltre, quando una scansione è attualmente assegnata a un preset, verifica quali campi possono essere modificati. |
| GET | /lookups/teams |
Ottieni il nome del team e gli ID per fornire accesso alle scansioni tramite l'API. |
| GET | /lookups/scans |
Ottieni nomi di scansioni e ID per ottenere risultati, modificare o eseguire scansioni. |
| GET | /scans/[scanId]/runs |
Elenca tutte le esecuzioni di scansione per una scansione, con informazioni di riepilogo della scansione. Ti consente di recuperare runId. |
| GET | /lookups/scan-groups |
Ottieni nomi e ID dei gruppi di scansione per organizzare le scansioni tramite l'API. |
| GET | /lookups/scripts |
Ottieni ID per assegnare script condivisi alle scansioni tramite l'API. |
Preset
Puoi applicare le impostazioni del preset a una scansione tramite l'API, ma prima sono richiesti l'ID e il nome del preset. Utilizza questo endpoint per cercarli.
L'ID del preset è anche necessario per capire quali impostazioni di scansione sono modificabili quando un preset è già applicato.
Esempio di Richiesta
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/presets
X-API-Key: <your_api_key>
Content-Type: application/jsonEsempio di Risposta
Stato: 200 Successo
{
"presets": [
{ "id": 3, "name": "Gov Baseline" },
{ "id": 1, "name": "Marketing sites" }
]
}Team
Puoi assegnare permessi di team quando crei o modifichi una scansione tramite l'API. Utilizza questo endpoint per cercare nomi e ID dei team.
Esempio di Richiesta
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/teams
X-API-Key: <your_api_key>
Content-Type: application/jsonEsempio di Risposta
Stato: 200 Successo
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
]
}Scansioni
Gli ID e i nomi delle scansioni sono necessari per ottenere risultati, modificare ed eseguire scansioni. Utilizza questo endpoint per cercarli.
Esempio di Richiesta
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scans
X-API-Key: <your_api_key>
Content-Type: application/jsonEsempio di Risposta
Stato: 200 Successo
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
]
}Esecuzioni di Scansione
Gli ID delle esecuzioni di scansione possono essere recuperati con questo endpoint per ottenere dati di risultati dettagliati.
Esempio di Richiesta
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Esempio di Risposta
{
"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
}
]
}
]
}Gruppi di Scansione
Puoi organizzare le scansioni per gruppi di scansione quando crei o modifichi scansioni dall'API. Utilizza questo endpoint per cercare ID e nomi dei gruppi di scansione.
Esempio di Richiesta
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scan-groups
X-API-Key: <your_api_key>
Content-Type: application/jsonEsempio di Risposta
Stato: 200 Successo
{
"scanGroups": [
{ "id": 1234, "name": "Marketing" },
{ "id": 1200, "name": "Storefront" }
]
}Script Condivisi
Gli script condivisi che sono archiviati nella sezione Admin di Axe Monitor e utilizzati in diverse scansioni possono essere applicati quando crei o modifichi scansioni tramite l'API. Utilizza questo endpoint per cercare gli ID degli script condivisi.
Esempio di Richiesta
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scripts
X-API-Key: <your_api_key>
Content-Type: application/jsonEsempio di Risposta
Stato: 200 Successo
{
"scripts": [
{ "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
{ "id": 9, "name": "SSO login", "type": "SESSION" }
]
}