Ottieni Impostazioni dall'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

Usa questa pagina per leggere le impostazioni di una scansione, controllare ogni impostazione che puoi inviare quando crei o modifichi una scansione, e scoprire quali valori e modifiche sono consentiti.

Metodo Endpoint Scopo
GET /scans/[scanId]/settings Ottieni le impostazioni complete di una scansione.
GET /axe-versions Elenca le versioni di axe-core disponibili nella tua istanza di axe Monitor.
GET /presets Elenca i preset
GET /presets/[presetId]/editability Elenca quali impostazioni possono essere modificate nelle scansioni che utilizzano un preset.

Ottieni Impostazioni Scansione

Ritorna le impostazioni complete di una scansione. Puoi inviare questa risposta nuovamente a POST /scans or PATCH /scans/[scanId] senza modificarla.

Esempio di Richiesta

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

Parametri Obbligatori

Nome Tipo Descrizione
scanId Integer L'identificatore unico della scansione.

Esempio di Risposta

Stato: 200 OK

{
  "scanId": 12345,
  "presetId": null,
  "name": "Marketing Site - Production",
  "sites": ["https://www.example.com"],

  "axeCoreVersion": "latest",
  "standardLevel": "wcag22aa",
  "standardOptions": ["best-practice"],
  "customRules": [],
  "enablePdfUa": false,
  "publicShareLink": false,
  "axeReportsUpload": false,
  
  "depth": 3,
  "pageLimit": 100,
  "windowWidth": 1920,
  "windowHeight": 1080,
  "storeScreenshotsFileContent": false,
  "includeErrorPages": false,
  "excludeMimeTypes": [],
  "pdfTarget": -1,
  "pdfModifiedBetween": null,

  "commonComponents": [],
  "templateUris": [],
  "excludeCommonComponents": false,

  "scripts": [],
  "runSessionScriptFirst": false,
  "environmentVariables": [
    { "name": "ENV_API_KEY" }
  ],
  "userAgent": null,
  "referrer": null,
  "sessionEstablishment": {
    "authType": null,
    "authUserName": null
  },

  "restrictToFolder": false,
  "skipSpecificUrls": [],
  "mustHaveAll": [],
  "mustHaveAny": [],
  "mustNotHaveAny": [],
  "ignoreAllParams": false,
  "discardAnchorTags": false,
  "meaningfulParams": [],
  "meaninglessParams": [],

  "longPageOptimized": false,
  "pageWait": 0,
  "dynamicContentActive": false,
  "priority": 2,

  "scanGroups": [
    { "id": 7, "name": "Marketing Sites" }
  ],
  "teams": [
    { "name": "Digital Accessibility Team" }
  ],
  "notifyGroup": false,
  "notifyUsers": []
}

Nota: Password, keystore e valori delle variabili d'ambiente non vengono mai restituiti. Sono esclusi dalla risposta interamente, non restituiti come null. Le variabili d'ambiente sono elencate solo per nome.

Nota: presetId è il preset applicato alla scansione, o null se non ce n'è uno. Quando un preset è applicato, usa GET /presets/[presetId]/editability per vedere quali impostazioni puoi modificare.

Risposte di Errore

Codice di Stato HTTP Descrizione
401 La chiave API è mancante o non valida.
403 Non hai accesso a questa scansione.
404 La scansione non esiste.

Impostazioni complete della scansione disponibili tramite API

Questa sezione elenca ogni impostazione di scansione che puoi inviare a POST /scans e PATCH /scans/[scanId], e che GET /scans/[scanId]/settings restituisce. Le impostazioni sono raggruppate allo stesso modo delle impostazioni di scansione nell'interfaccia utente di axe Monitor, e l'API accetta gli stessi valori dell'interfaccia utente.

Eccezione: credenziali per avviare una sessione non sono modificabili tramite API per motivi di sicurezza. Le credenziali possono essere modificate solo dall'interfaccia utente di Axe Monitor.

Impostazioni Generali (Obbligatorie)

Nome Tipo Descrizione
name String Il nome della scansione.
sites String[] Gli URL di partenza per la scansione. Richiesti solo se non ci sono script nella scansione.

Standard di Accessibilità (Obbligatorio)

Nome Tipo Descrizione
axeCoreVersion String La versione di axe-core con cui eseguire la scansione. Usa un valore di versione da GET /axe-versions.
standardLevel String Lo standard di accessibilità contro cui effettuare il test, ad esempio wcag22aa. Usa un valore dai tag della versione di axe-core scelta.

Impostazioni di Base (Opzionali)

Nome Tipo Predefinito Descrizione
standardOptions String[] [] Set di regole extra da includere. Attualmente è supportato solo il best-practice.
customRules Array [] Aggiungi frasi o parole da usare con l'impostazione Trova Testo.
enablePdfUa Booleano falso Verifica i PDF rispetto al PDF/UA.
publicShareLink Booleano falso Crea un link di condivisione pubblica per i risultati della scansione.
axeReportsUpload Booleano falso Invia i risultati della scansione a Axe Reports.

Ambito di Scansione (Opzionale)

Nome Tipo Predefinito Descrizione
profondità Integer [] Quanti livelli di link scansionare a partire dagli URL iniziali.
limitePagine Integer [] Il numero massimo di pagine scansionate in ogni esecuzione.
larghezzaFinestra Integer 1920 Larghezza della finestra del browser, in pixel.
altezzaFinestra Integer 1080 Altezza della finestra del browser, in pixel.
salvaScreenshot Booleano falso Memorizza gli screenshot con i risultati della scansione.
salvaContenutoFile Booleano falso Memorizza il sorgente completo della pagina con i risultati della scansione.
includiPagineErrore Booleano falso Includi le pagine che restituiscono uno stato di errore HTTP.
escludiTipiMime String[] [] Tipi di file da saltare durante la scansione, per esempio application/pdf.
pdfTarget Integer -1 L'obiettivo di scansione PDF. -1 disattiva la scansione PDF. Non può essere usato quando application/pdf è in escludiTipiMime.
pdfModifiedFromDate Oggetto o null null Scansiona solo PDF modificati dopo una certa data.
pdfModifiedToDate Oggetto o null null Scansiona solo PDF modificati prima di una certa data.

Componenti Comuni (Opzionale)

Nome Tipo Predefinito Descrizione
componentiComuni Array [] Definizioni di componenti condivisi applicati sulle pagine.
templateUri String[] [] URL utilizzato per rilevare e consolidare i componenti comuni.
escludiComponentiComuni Booleano falso Escludi i risultati dei componenti comuni dai conteggi dei problemi.

Indicizzazione e Sessione (Opzionale)

Nome Tipo Predefinito Descrizione
script Array [] Script di attività e sessione. Ogni script ha { "name", “id”, "contents", "shared", "mimeType" }.
eseguiPrimaScriptSessione Booleano falso Esegui lo script di sessione prima degli script di pagina.
variabiliDiAmbiente Array [] Variabili disponibili agli script. Ogni voce è { "name" }. I valori non possono essere modificati e non sono inclusi nelle risposte per motivi di sicurezza.
userAgent Stringa o null null Sovrascrivi la stringa user agent del browser.
referrer Stringa o null null Il valore dell'intestazione HTTP Referer da inviare.
sessionEstablishment.authType Stringa o null null Il metodo di accesso, ad esempio basic o keystore.
sessionEstablishment.authUserName Stringa o null null Il nome utente utilizzato per accedere.
sessionEstablishment.script Oggetto [] Restituito quando la scansione ha uno script di autenticazione. Ogni script ha { "id", “name”, "contents", "mimeType", "shared" }.
sessionEstablishment.script.id Integer 0 Restituito quando la scansione ha uno script di autenticazione. Per aggiungere uno script condiviso durante l'uso dei punti finali Create o Edit Scan, vai in Amministratore → Script Condivisi nell'interfaccia di Axe Monitor. Modifica uno script e recupera l'ID dall'URL nella barra degli indirizzi: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
sessionEstablishment.script.name String [] Nome del file script di autenticazione applicato alla scansione.
sessionEstablishment.script.contents String [] Contenuti dello script di autenticazione applicato alla scansione.
sessionEstablishment.script.mimeType String [] Tipo di file dello script applicato alla scansione.
sessionEstablishment.script.shared Booleano falso Vero indica che lo script è uno script condiviso disponibile nella sezione Amministratore di Axe Monitor.

Ambito URL (Opzionale)

Nome Tipo Predefinito Descrizione
restrictionAllaCartella Booleano falso Indicizzare solo gli URL sotto il percorso dell'URL iniziale.
domini String[] [] Limita la scansione a questi domini e ai loro sottodirettori. I collegamenti ad altri domini non vengono seguiti. Derivati dal valore ‘sites’. Per impostazione predefinita, vengono scansionati solo i domini nel campo 'sites'.
saltaUrlSpecifici String[] [] Modelli di URL da escludere dall'indicizzazione.
deveContenerliTutti String[] [] Scansiona solo gli URL che contengono tutte queste stringhe di testo.
puòAverneQualsiasi String[] [] Scansiona solo gli URL che contengono almeno una di queste stringhe di testo.
nonDeveAverneAlcuno String[] [] Salta gli URL che contengono una qualsiasi di queste stringhe di testo.
ignoraTuttiIParametri Booleano falso Tratta gli URL che differiscono solo nei parametri di query come la stessa pagina. Quando è vero, meaningfulParams e meaninglessParams devono essere vuoti.
ignoraTagDiAncoraggio Booleano falso Tratta gli URL che differiscono solo nel loro # frammento come la stessa pagina.
parametriSignificativi String[] [] Parametri di query che rendono un URL una pagina separata.
parametriInutili String[] [] Parametri di query da ignorare quando si decide se due URL sono la stessa pagina.

Ottimizzazione (Opzionale)

Nome Tipo Predefinito Descrizione
paginaLungaOttimizzata Booleano falso Attendi prima di scansionare ogni pagina. Imposta il tempo di attesa con pageWait.
pageWait Integer 0 Quanto attendere prima di scansionare ogni pagina, in millisecondi. Intervallo consentito: da 0 a 120000.
waitAllPages Booleano true Applica pageWait a ogni pagina nella scansione. Quando false, si applica solo agli URL in waitPageUrls.
waitPageUrls String[] [] Gli URL a cui pageWait si applica quando waitAllPages è false.
dynamicContentActive Booleano falso Attendi il caricamento del contenuto dinamico, come animazioni, componenti caricati in modo lazy e media incorporati, prima di scansionare ogni pagina. Imposta il tempo di attesa con dynamicContentWait.
dynamicContentWait Integer 0 Quanto attendere per il contenuto dinamico prima di scansionare ogni pagina. Utilizzato quando dynamicContentActive è true.
priorità Integer 2 La posizione della scansione nella coda. Intervallo consentito: 1 (massimo) a 3 (minimo).

Frequenza di Pianificazione (Richiesto per scansioni pianificate)

Nome Tipo Descrizione
pianificazione Oggetto Contiene opzione per scansioni manuali (una tantum) o pianificate, e dettagli se la scansione è programmata. Ogni pianificazione contiene { "tipoFrequenza", “intervalloFrequenza”, "datiFrequenza", "dataInizio", "oraInizio", “dataFine”, “occorrenzeMassime”, “timeoutMinuti”, “fusoOrario.” }. Inviando null si rimuove la pianificazione.
pianificazione.tipoFrequenza String Richiesto con scansioni programmate. Quanto spesso si ripete la scansione. Manuale crea una scansione senza pianificazione. Settimana crea una scansione settimanale, e Mese crea una scansione mensile. M_GdS permette di eseguire una scansione mensile in un determinato giorno della settimana.
pianificazione.intervalloFrequenza Integer Richiesto con scansioni programmate. Quanti periodi attendere tra le esecuzioni (Week o Month). Per esempio, 2 significa ogni 2 settimane o mesi.
pianificazione.datiFrequenza Stringa (come JSON) In quali giorni esegue la scansione. Il valore è JSON scritto come una stringa, e ciò che va dentro dipende da frequencyType. Settimana: Array JSON con i giorni della settimana su cui eseguire. Esempio: "[1,3]" esegue ogni lunedì e mercoledì. Mese: Oggetto JSON con la data su cui eseguire ogni mese. Un numero del giorno, la stringa “Primo”, o la stringa “Ultimo”. “Primo” e “Ultimo” sono case-sensitive. Esempio: "{\"dayOfMonth\":15}" esegue il 15°. M_GdS: Oggetto JSON con un giorno della settimana e quale nel mese. Esempio: "{\"weekOfMonth\":2,\"dayOfWeek\":2}" esegue il secondo martedì. Usa weekOfMonth: 5 per l'ultima settimana del mese, quindi "{\"weekOfMonth\":5,\"dayOfWeek\":5}" è l'ultimo venerdì di ogni mese. I giorni sono numerati 1 = Lunedì a 7 = Domenica.

Dettagli Pianificazione (Richiesto per scansioni pianificate)

Nome Tipo Descrizione
pianificazione.dataInizio Data Richiesta. Data del primo esecuzione, come YYYY-MM-DD.
pianificazione.oraInizio Tempo-locale Richiesto. Ora locale. ogni esecuzione inizia, come orario HH:mm:ss a 24 ore, quindi 14:30 è 14:30:00 (si assume 24 ore). Interpretato in timeZone.
pianificazione.dataFine Data Data di fine della pianificazione. Imposta o questo o maxOccurrences, non entrambi.
pianificazione.occorrenzeMassime Integer Numero di esecuzioni dopo le quali termina la pianificazione. Imposta o questo o endDate, non entrambi.
pianificazione.timeoutMinuti Integer Durata massima di esecuzione in minuti, dopo la quale la scansione si interrompe automaticamente. Utile quando un sito impedisce il completamento della scansione (come un URL che reindirizza infinitamente) o quando si eseguono molte scansioni grandi contemporaneamente. Se non presente, non c'è timeout.
pianificazione.fusoOrario String Nome del fuso orario IANA, come America/New_York. (Tutte le opzioni dei fusi orari)

Team e Condivisione (Opzionale)

Nome Tipo Predefinito Descrizione
gruppiDiScansione Object[] [] Gruppi di scansione a cui appartiene la scansione. Ogni voce è { “id”, "name" }.
scanGroups.id String [] ID dei gruppi di scansione a cui appartiene la scansione.
scanGroups.name String [] Nomi dei gruppi di scansione a cui appartiene la scansione.
teams Object[] [] Team con accesso alla scansione. Ogni voce è { “id”, "name", “accessLevel” }.
teams.id String [] ID dei team con accesso alla scansione.
teams.name String [] Nomi dei team con accesso alla scansione.
teams.accessLevel String [] L'accesso “viewer” fornisce accesso come Visualizzatore Scansione al relativo team. L'accesso “member” fornisce accesso come Membro Scansione, e “admin” fornisce accesso come Amministratore Scansione.
scanGroups.id String [] ID dei gruppi di scansione. Per aggiungere gruppi di scansione quando si utilizzano gli endpoint Create o Edit Scan, vai su Admin → Gruppi di Scansione nell'interfaccia utente di Axe Monitor. Modifica uno script e recupera l'ID dall'URL nella barra degli indirizzi: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
scanGroups.name String [] Nome dei gruppi di scansione
scanGroups.accessLevel String [] “viewer”, “member” o “admin”
notifyGroup Booleano falso Invia un'email ai membri del gruppo di scansione quando un'esecuzione è completata.
notifyUsers Array [] Utenti specifici a cui inviare un'email quando un'esecuzione è completata.

Impostazioni di sola lettura

GET /scans/[scanId]/settings restituisce anche questi. Sono ignorati se inviati a POST o PATCH.

Nome Tipo Descrizione
scanId Integer L'identificatore unico della scansione.
presetId Intero o null Il preset applicato alla scansione, o null se non c'è nessuno.
scanGroups[].id Integer L'identificatore univoco di ciascun gruppo di scansione.

Esempio di Risposta

{
  "scanId": 0,
  "name": "string",
  "sites": [
    "string"
  ],
  "axeCoreVersion": "string",
  "standardLevel": "string",
  "standardOptions": [
    "string"
  ],
  "enablePdfUa": true,
  "depth": 0,
  "pageLimit": 0,
  "axeReportsUpload": true,
  "publicShareLink": true,
  "includeErrorPages": true,
  "storeFileContent": true,
  "storeScreenshots": true,
  "pdfModifiedFromDate": "2026-11-03",
  "pdfModifiedToDate": "2026-11-03",
  "pdfTarget": 0,
  "scanGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "teams": [
    {
      "id": "string",
      "name": "string",
      "accessLevel": "viewer"
    }
  ],
  "schedule": {
    "frequencyType": "Manual",
    "frequencyInterval": 0,
    "frequencyData": "string",
    "startDate": "2026-11-03",
    "startTime": "string",
    "endDate": "2026-11-03",
    "maxOccurrences": 0,
    "timeoutMinutes": 0,
    "timeZone": "string"
  },
  "scripts": [
    {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  ],
  "runSessionScriptFirst": true,
  "userAgent": "string",
  "referrer": "string",
  "sessionEstablishment": {
    "authType": "basic",
    "authUserName": "string",
    "script": {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  },
  "restrictToFolder": true,
  "skipSpecificUrls": [
    "string"
  ],
  "mustHaveAll": [
    "string"
  ],
  "mustHaveAny": [
    "string"
  ],
  "mustNotHaveAny": [
    "string"
  ],
  "ignoreAllParams": true,
  "discardAnchorTags": true,
  "meaningfulParams": [
    "string"
  ],
  "meaninglessParams": [
    "string"
  ],
  "domains": [
    "string"
  ],
  "excludeMimeTypes": [
    "string"
  ],
  "longPageOptimized": true,
  "pageWait": 0,
  "dynamicContentActive": true,
  "dynamicContentWait": 0,
  "waitAllPages": true,
  "waitPageUrls": [
    "string"
  ],
  "headlessMode": true,
  "eagerStrategy": true,
  "windowWidth": 0,
  "windowHeight": 0,
  "priority": 1,
  "templateUris": [
    "string"
  ],
  "commonComponents": [
    {
      "id": 0,
      "name": "string",
      "selectors": [
        "string"
      ]
    }
  ],
  "excludeCommonComponents": true,
  "customRules": [
    {
      "ruleId": "find-text",
      "options": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "notifyGroup": true,
  "notifyUsers": [
    "string"
  ],
  "presetId": 0,
  "draft": true
}

Elenco delle versioni di axe-core

Restituisce le versioni di axe-core disponibili nella tua istanza di axe Monitor, e gli standard che ciascuna supporta. Axe Monitor non rileva automaticamente le nuove versioni di axe-core, quindi utilizza questo endpoint per vedere quali versioni puoi impostare come axeCoreVersion di una scansione.

Esempio di Richiesta

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/axe-versions
X-API-Key: <your_api_key>

Esempio di Risposta

Stato: 200 OK

{
  "versions": [
    {
      "version": "latest",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    },
    {
      "version": "4.12.1",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    }
  ],
  "default": "latest"
}

Campi di risposta

Nome Tipo Descrizione
versions Array Le versioni di axe-core disponibili nella tua istanza.
versions[].version String L'identificatore della versione. Usa questo valore come axeCoreVersion di una scansione.
versions[].supported Booleano Se la versione è attualmente supportata.
versions[].tags String[] Gli standard e i set di regole che questa versione supporta. Usa questi valori per standardLevel e standardOptions di una scansione.
default String La versione predefinita di axe-core per la tua istanza.

Verifica modificabilità preset

Ritorna quali impostazioni possono essere modificate su scansioni che utilizzano un preset. Verifica prima di inviare PATCH /scans/[scanId]/settings a una scansione con un preset, così sai quali impostazioni accetterà.

Per trovare il preset di una scansione, leggi presetId da GET /scans/[scanId]/settings. Per trovare altri ID di preset, vai all'interfaccia utente di Axe Monitor e naviga su Admin → Preset. Modifica il tuo preset desiderato. Copia l'ID dall'URL nella barra degli indirizzi: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/presets/[ID]/edit

Esempio di Richiesta

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/presets/[presetId]/editability

X-API-KEY: <your_api_key>

Parametri Obbligatori

Nome Tipo Descrizione
presetId Integer L'identificatore univoco del preset.

Esempio di Risposta

Stato: 200 OK

{
  "presetId": 42,
  "fields": {
    "name": true,
    "depth": false,
    "pageLimit": false,
    "axeCoreVersion": false
  }
}

Campi di risposta

Nome Tipo Descrizione
presetId Integer L'identificatore univoco del preset.
fields Oggetto Ogni chiave è un nome di impostazione da Impostazioni di scansione avanzate. true significa che puoi modificarla nelle scansioni che utilizzano questo preset; false significa che il preset la blocca.

Inviare un'impostazione bloccata con un nuovo valore restituisce 400 field_locked_by_preset. Inviarla con il suo valore attuale ha successo e non cambia nulla.

Risposta di errore

Nome Tipo
401 La chiave API è mancante o non valida.
403 Non hai accesso a questo preset.
404 Il preset non esiste.

Is this page helpful?

Help us improve this page

Still need help?