IDs verkrijgen via de 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

Axe Monitor-gebruikers kunnen een API-sleutel genereren in Axe Account en IDs opzoeken die nodig zijn voor gebruik met andere Axe Monitor API-eindpunten, zonder de gebruikersinterface te gebruiken.

Lees meer over Aan de slag.

Eindpunten

Methode Eindpunt Doel
GET /lookups/presets Haal vooraf ingestelde IDs op om een preset toe te passen op een scan. En, als een scan momenteel is toegewezen aan een preset – kijk welke velden kunnen worden bewerkt.
GET /lookups/teams Krijg teamnamen en IDs om toegang te verlenen tot scans via de API.
GET /lookups/scans Verkrijg scannamen en IDs om resultaten te krijgen, scans te bewerken of uit te voeren.
GET /scans/[scanId]/runs Lijst alle scanuitvoeringen voor een scan op, met scanoverzichtsinformatie. Hiermee kunt u runId ophalen.
GET /lookups/scan-groups Verkrijg scanroepnamen en IDs om scans te organiseren via de API.
GET /lookups/scripts Verkrijg IDs om gedeelde scripts aan scans toe te wijzen via de API.

Presets

U kunt de preset-instellingen toepassen op een scan via de API, maar de preset-ID en naam zijn eerst vereist. Gebruik dit eindpunt om ze op te zoeken.

Preset-ID is ook nodig om te begrijpen welke scaninstellingen bewerkbaar zijn wanneer een preset al is toegepast.

Voorbeeldaanvraag

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

Voorbeeldantwoord

Status: 200 Succes

{
  "presets": [
    { "id": 3, "name": "Gov Baseline" },
    { "id": 1, "name": "Marketing sites" }
  ]
}

Teams

U kunt teamrechten toewijzen bij het maken of bewerken van een scan via de API. Gebruik dit eindpunt om teamnamen en IDs op te zoeken.

Voorbeeldaanvraag

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

Voorbeeldantwoord

Status: 200 Succes

{
  "teams": [
    { "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
    { "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
  ]
}

Scans

Scan-ID's en namen zijn nodig om resultaten te krijgen, te bewerken en scans uit te voeren. Gebruik dit eindpunt om ze op te zoeken.

Voorbeeldaanvraag

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

Voorbeeldantwoord

Status: 200 Succes

{
  "teams": [
    { "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
    { "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
  ]
}

Scanuitvoeringen

Scanuitvoerings-ID's kunnen worden opgehaald met dit eindpunt om gedetailleerde resultaten te krijgen.

Voorbeeldaanvraag

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

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

Scanroepen

U kunt scans organiseren op scanroepen bij het maken of bewerken van scans via de API. Gebruik dit eindpunt om scanroep-ID's en namen op te zoeken.

Voorbeeldaanvraag

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

Voorbeeldantwoord

Status: 200 Succes

{
  "scanGroups": [
    { "id": 1234, "name": "Marketing" },
    { "id": 1200, "name": "Storefront" }
  ]
}

Gedeelde scripts

Gedeelde scripts die zijn opgeslagen in het beheerbereik van Axe Monitor en worden gebruikt in verschillende scans, kunnen worden toegepast bij het maken of bewerken van scans via de API. Gebruik dit eindpunt om gedeelde script-ID's op te zoeken.

Voorbeeldaanvraag

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

Voorbeeldantwoord

Status: 200 Succes

{
  "scripts": [
    { "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
    { "id": 9, "name": "SSO login", "type": "SESSION" }
  ]
}

Is this page helpful?

Help us improve this page

Still need help?