Creare, Modificare ed Eseguire Scansioni tramite API

Gli amministratori di Axe Monitor possono generare una chiave API in Axe Account e creare, modificare o eseguire scansioni sistematicamente, senza utilizzare l'interfaccia utente.

Scopri di più su Per iniziare.

Endpoint

Creare una Scansione

Crea una scansione partendo da un singolo oggetto di impostazioni di scansione. Per creare più scansioni contemporaneamente, invia una richiesta per ciascuna scansione.

Nota: Per mantenere sicure le tue credenziali, l'API non accetta password, file del keystore o valori di variabili d'ambiente. Aggiungi questi valori nell'interfaccia utente di Axe Monitor nei dettagli di accesso della scansione.

Esempio di Richiesta

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

Parametri Obbligatori

Impostazioni Opzionali

Impostazioni aggiuntive della scansione possono essere usate con l'endpoint Create Scan. Visualizza la documentazione delle Impostazioni della Scansione.

Esempio di Richiesta

{
  "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
}

Esempio di Risposta

Stato: 201 Creato

{
  "scanId": 12345
}

Usa il [scanId] restituito per leggere, modificare o eseguire la scansione.

Nota: L'API non accetta password, keystores o valori di variabili d'ambiente. Se la tua scansione accede a un sito o esegue script che necessitano di valori segreti, crea la scansione tramite API, quindi aggiungi questi valori in Axe Monitor sotto Impostazioni Avanzate, Avvio di una sessione.

Risposte di Errore

Modifica una Scansione

Aggiorna una o più impostazioni di una scansione esistente. Invia solo le impostazioni che desideri modificare; le impostazioni che lasci fuori manterranno i loro valori attuali.

Nota:

• Alcune impostazioni richiedono ID per essere modificate. Consulta la documentazione per ottenere gli ID.
• Quando una scansione ha un preset applicato, alcune impostazioni potrebbero non essere modificabili. Consulta la documentazione dei preset.
• Consulta l'elenco completo delle impostazioni della scansione che possono essere modificate via API.

Esempio di Richiesta

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

Parametri Obbligatori

È richiesta almeno un'ulteriore impostazione per effettuare una modifica. Consulta la documentazione delle impostazioni della scansione.

Nota:

• ‘null’ reimposta un campo ai suoi valori predefiniti
• Gli array sostituiscono il valore memorizzato

Esempio di Richiesta

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

Esempio di Risposta

Stato: 200 OK

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

updatedFields elenca le impostazioni che sono cambiate.

Risposta di Errore

Avvia un Esecuzione di Scansione

Mette in coda un nuovo esecuzione di una scansione esistente. L'esecuzione inizia quando axe Monitor la preleva dalla coda. Per controllare il suo progresso, usa GET /scans/[scanId]/runs.

Esempio di Richiesta

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

Parametri Obbligatori

Esempio di Risposta

Stato: 202 Accettato

La risposta non ha contenuti.

Esempio di Risposta di Errore

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

Risposte di Errore