axe Monitor 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

Inleiding

De axe Monitor API biedt ontwikkelaars een gestroomlijnde manier om te communiceren met gegevens van toegankelijkheidstestresultaten buiten de gebruikersinterface van axe Monitor. Met behulp van RESTful-webservices biedt de API toegang tot:

  • Scans voor een gebruiker
  • Scanuitvoeringen voor een scan
  • Paginadetails voor een scanuitvoering
  • Probleemdeteails voor een scanuitvoering
  • Probleemdeteails voor een pagina

Gelicenseerde axe Monitor-gebruikers kunnen de API met externe applicaties gebruiken, mits het gebruik voldoet aan de Abonnementslicentieovereenkomst.

Aan de slag

  1. Maak een API-sleutel aan via axe Account.

    Raadpleeg de regiogebonden instructies hieronder:

    Voer de volgende stappen uit om uw API-sleutel te genereren:

    • Selecteer op de pagina API-sleutels in axe Account de knop „Nieuwe API-sleutel toevoegen“.
      De dialoog NIEUWE API-SLEUTEL TOEVOEGEN verschijnt.

    • Selecteer axe Monitor uit het productkeuzemenu, geef een naam aan uw API-sleutel en selecteer de knop Opslaan.

    • Kopieer onder de kolom Acties de API-sleutel naar uw klembord.

  2. Voer de basis-URL van de API in: Gebruik uw voorkeurs-API-platform, zoals Postman of SwaggerUI, of uw werkmap om toegang te krijgen tot de axe Monitor API. Vervang „yourcompany“ door het subdomein voor uw axe Monitor-instantie.

https://yourcompany.dequecloud.com/monitor-public-api/v1/{endpoint}

Headers toevoegen:

Om toegang te krijgen tot de API, moet u zich authenticeren met de API-sleutel van axe Account.

X-API-Key: <your_api_key>

Optionele headerparameters

Naam Type Beschrijving
X-Pagination-Per-Page Integer Het maximumaantal items dat in één pagina wordt geretourneerd. Standaardwaarde: 10
X-Pagination-Page Integer Het opgevraagde paginanummer. Standaardwaarde: 1

Voorbeeld CURL-aanvraag

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-Key: <your_api_key>'

Eindpunten

Alle eindpunten kunnen informatie opvragen met GET-verzoeken.

Eindpunt Doel
/scans Lijst van alle scans waartoe een gebruiker toegang heeft. Hiermee kunt u ophalen scanId.
/scans/[scanId]/runs Lijst van alle scanuitvoeringen voor een scan, met scanoverzichtsinformatie. Hiermee kunt u de runId.
/scans/[scanId]/runs/[runId]/pages Gedetailleerde pagina-informatie voor een scanuitvoering
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues Gedetailleerde toegankelijkheidsproblemen voor een pagina
/scans/[scanId]/runs/[runId]/issues Gedetailleerde toegankelijkheidsproblemen voor een scanuitvoering

Lijst van Scans voor een Gebruiker

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Voorbeeld Foutantwoord

Scanuitvoeringen voor een Scan

Voorbeeldverzoek

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

Vereiste Parameters

Naam Type Beschrijving
scanId String De unieke identificatie van de scan.

Optionele Parameters

Naam Type Beschrijving
needsReview String „true” of „false” maakt het mogelijk om te bepalen of „Moet worden beoordeeld” problemen in de reactie worden meegeteld.

Voorbeeldantwoord


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

Opmerking: Als uw scan een of meer zinnen heeft ingevoerd in de instelling „Tekst zoeken”, bevat de API-reactie een findText-array.

Elke opname bevat:

  • De ingevoerde zin.
  • Het aantal pagina's waar de zin werd geïdentificeerd.

Paginadetails voor een Scanuitvoering

Voorbeeldverzoek

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

Vereiste Padparameters

Naam Type Beschrijving
scanId String De unieke identificatie van de scan.
runNumber Integer Het specifieke uitvoeringsnummer van de scan.

Optionele Verzoekparameters

Naam Type Beschrijving
status string Filtert pagina's op status (Voltooid, Mislukt).
sortBy String Specificeert de kolom om op te sorteren (titel, url). Standaardwaarde is titel.
order String Specificeert de sorteerrichting (asc of desc). Standaardwaarde is desc.

Voorbeeldreactie

{
  "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"
      "findtext"
[     "Accessibility Statement",
      "WCAG"

    }
  ]
}

Opmerking: Wanneer de instelling Zoektekst is ingeschakeld voor de scan, bevat de lijst alle zinnen uit de instelling „Zoektekst“ die op die pagina zijn geïdentificeerd.

Details van een probleem voor een pagina

Voorbeeldverzoek

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

Vereiste parameters

Naam Type Omschrijving
scanId String De unieke identificatie van de scan.
runNumber Integer Het specifieke runnummer van de scan.
pageId String De unieke identificatie van de pagina.

Optionele parameters

Naam Type Omschrijving
status string Filtert problemen op status (open, opgelost of genegeerd).
sortBy String Specificeert de kolom om op te sorteren (testPaginaTitel, testUrl, selector, aangemaaktOp of status). Standaardwaarde is testPaginaTitel.
order String Specificeert de sorteerrichting (asc of desc). Standaardwaarde is desc.

Voorbeeldreactie

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

Details van een probleem voor een scanuitvoering

Voorbeeldverzoek


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

Vereiste parameters

Naam Type Vereist Omschrijving
scanId String Ja De unieke identificatie van de scan.
runNumber Integer Ja Het specifieke runnummer van de scan.

Optionele aanvraagparameters

Naam Type Vereist Beschrijving
status string Nee Filtert problemen op status (open, opgelost of genegeerd).
sortBy String Nee Geeft de kolom op om op te sorteren (testPageTitle, testUrl, selector, createdAt of status). Standaardwaarde is testPageTitle.
order String Nee Geeft de sorteerrichting op (asc of desc). Standaardwaarde is desc.

Voorbeeldreactie

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
      "issueGrouping": "string",
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
      "string"
      ],
      "source": "string",
      "tags": [
      "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2025-08-07T10:54:30.268Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

Fouten

HTTP-statuscode Fouttype Beschrijving
401 Niet gemachtigd De gebruiker is niet geauthenticeerd of heeft geen toegangsrechten.
400 OngeldigVerzoek Het verzoek bevat ongeldige parameters.
500 Interne Serverfout Er is een fout opgetreden tijdens het verwerken van het verzoek.

Is this page helpful?

Help us improve this page

Still need help?