API di axe Monitor

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

Introduzione

L'API di axe Monitor offre agli sviluppatori un modo semplificato per interagire con i dati dei risultati dei test di accessibilità al di fuori dell'interfaccia utente di axe Monitor. Utilizzando i servizi web RESTful, l'API fornisce l'accesso a:

  • Scansioni per un utente
  • Esecuzioni di scansione per una scansione
  • Dettagli della pagina per una scansione
  • Dettagli del problema per un'esecuzione di scansione
  • Dettagli del problema per una pagina

Gli utenti con licenza axe Monitor possono utilizzare l'API con applicazioni esterne, a condizione che l'utilizzo sia conforme al Contratto di licenza di abbonamento.

Iniziare

  1. Crea una chiave API tramite axe Account.
    1. Nella pagina Chiavi API in axe Account, seleziona il pulsante "Aggiungi nuova chiave API".
    2. Apparirà una finestra modale. Seleziona axe Monitor dal menu a discesa del prodotto, assegna un nome alla tua chiave API e seleziona il pulsante Salva.
    3. Nella colonna Azioni, copia la chiave API negli appunti.
  2. Inserisci l'URL di base dell'API: Utilizzando la tua piattaforma API preferita, come Postman o SwaggerUI, oppure la tua directory di lavoro, accedi all'API axe Monitor. Sostituisci "yourcompany" con il sottodominio della tua istanza di axe Monitor.
https://yourcompany.dequecloud.com/monitor-public-api/v1/{endpoint}

  1. Aggiungi intestazioni:

    Per accedere all'API, è necessario autenticarsi utilizzando la chiave API dell'account axe.

X-API-Key: <your_api_key>

Parametri di intestazione facoltativi

Nome Tipo Descrizione
X-Pagination-Per-Page Integer Valore predefinito: 10 Numero massimo di elementi restituiti in una singola pagina
X-Pagination-Page Integer Valore predefinito: 1 Il numero di pagina richiesto

Esempio di richiesta CURL

curl -X 'GET' \
  'https://{base_url}/monitor-public-api/v1/scans/1/runs/1/issues?sortBy=testPageTitle&sortDir=desc' \
  -H 'accept: application/json' \
  -H 'X-API-KeyAuthorization: <your_api_key>' '

Endpoints

Tutti gli endpoint possono recuperare informazioni con richieste GET.

Endpoint Scopo
/scans Elenca tutte le scansioni a cui un utente può accedere. Permette di recuperare scanId.
/scans/[scanId]/runs Elenca tutte le esecuzioni di scansione per una scansione, con informazioni sulla panoramica della scansione. Permette di recuperare il runId.
/scans/[scanId]/runs/[runId]/pages Informazioni dettagliate sulla pagina per un'esecuzione di scansione
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues Problemi di accessibilità dettagliati per una pagina
/scans/[scanId]/runs/[runId]/issues Problemi di accessibilità dettagliati per un'esecuzione di scansione

Elenca le scansioni per un utente

Esempio di richiesta

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

Esempio di risposta

{
  "scans": [
    "id": 1,
    "name": "Test Scan",
    "groups": [
        "id": 1,
        "name": "Group A"
    ]
  ]
}

Esempio di risposta di errore

Esecuzioni di scansione per una scansione

Esempio di richiesta

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

Parametri richiesti

Nome Tipo Descrizione
scanId String Identificatore univoco della scansione.

Parametri facoltativi

Nome Tipo Descrizione
needsReview String "vero" o "falso" consente di controllare se i problemi "Necessita di revisione" vengono conteggiati nella risposta.

Esempio di risposta


{
  "runs": [
    {
      "runNumber" : 1,
      "status" : "Complete",
      "queuedAt": "2024-09-30T05:11:42Z",
      "startedAt": "2024-09-30T05:11:45Z",
      "completedAt": "2024-09-30T05:12:30Z",
      "totalIssueCount": 29,
      "completedPages": 1,
      "axeVersion" : "4.9.0",
      "standard" : "WCAG 2.2 AA"
“score”: “0”
“issues”: “28” 
[ "criticalissues": “20”,
"seriousissues": “2”,
"moderateissues": “4”,
"minorissues": “2”, 
]
pages: “40”
[ "criticalpages": “20”,
“aria”: “2”,
“color”: “2”,
“forms”: “2”,
“keyboard”: “2”,
“language”: “2”,
“namerolevalue”: “2”,
“pdf”: “2”,
“parsing”: “2”,
“semantics”: “2”,
“sensoryvisual”: “2”,
“structure”: “2”,
“tables”: “2”,
“alttext”: “2”,
“timemedia”: “2” 
]
    }
  ]
}

Dettagli della pagina per un'esecuzione di una scansione

Esempio di richiesta

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

Parametri del percorso richiesti

Nome Tipo Descrizione
scanId String Identificatore univoco della scansione.
runNumber Integer Numero di esecuzione specifico della scansione.

Parametri di richiesta facoltativi

Nome Tipo Descrizione
status String Filtra le pagine in base allo stato (Completato, Non riuscito).
sortBy String Specifica la colonna in base alla quale ordinare (titolo, URL). Il valore predefinito è il titolo
order String Specifica la direzione di ordinamento (asc o desc). Il valore predefinito è desc.

Esempio di risposta

{
  "pages": [
    {
      "id": 0,
      "url": "string",
      "title": "string",
      "reasonForFailure": "string",
      "totalCriticalIssues": 0,
      "totalSeriousIssues": 0,
      "totalModerateIssues": 0,
      "totalMinorIssues": 0,
      "totalNeedsReview": 0,
      "totalFixedIssues": 0,
      "totalOpenIssues": 0,
      "health": "string",
      "status": "string",
      "scriptName": "string",
      "scriptStep": 0,
      "template": true,
      "date": "2024-12-02T15:03:40.211Z",
      "domainUrl": "string"
    }
  ]
}

Dettagli del problema per una pagina

Esempio di richiesta

GET 
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>

Parametri richiesti

Nome Tipo Descrizione
scanId String Identificatore univoco della scansione.
runNumber Integer Numero di esecuzione specifico della scansione.
pageId String Identificatore univoco della pagina.

Parametri facoltativi

Nome Tipo Descrizione
status String Filtra i problemi in base allo stato (aperti, risolti o ignorati).
sortBy String Specifica la colonna in base alla quale ordinare (testPageTitle, testUrl, selector, createdAt o status). Il valore predefinito è testPageTitle.
order String Specifica la direzione di ordinamento (asc o desc). Il valore predefinito è desc.

Esempio di risposta

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
“issuegroup”: “string”
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
        "string"
      ],
      "source": "string",
      "tags": [
        "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2024-12-02T14:59:24.232Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

Dettagli dei problemi per un'esecuzione di scansione

Esempio di richiesta


GET 
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>

Parametri richiesti

Nome Tipo Obbligatorio Descrizione
scanId String Sì Identificatore univoco della scansione.
runNumber Integer Sì Numero di esecuzione specifico della scansione.
pageId String Sì Identificatore univoco della pagina.

Parametri di richiesta facoltativi

Nome Tipo Obbligatorio Descrizione
status String No Filtra i problemi in base allo stato (aperti, risolti o ignorati).
sortBy String No Specifica la colonna in base alla quale ordinare (testPageTitle, testUrl, selector, createdAt o status). Il valore predefinito è testPageTitle.
order String No Specifica la direzione di ordinamento (asc o desc). Il valore predefinito è desc.

Esempio di risposta

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
“issuegroup”: “string”
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
        "string"
      ],
      "source": "string",
      "tags": [
        "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2024-12-02T14:59:24.232Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

Errori

Codice di stato HTTP Tipo di errore Descrizione
401 Non autorizzato L'utente non è autenticato o non ha diritti di accesso.
400 Richiesta non valida La richiesta contiene parametri non validi.
500 Errore interno del server Si è verificato un errore durante l'elaborazione della richiesta.

Is this page helpful?

Help us improve this page

Still need help?