Instellingen ophalen van 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

Gebruik deze pagina om de instellingen van een scan te lezen, elke instelling op te zoeken die je kunt verzenden wanneer je een scan maakt of bewerkt, en te zien welke waarden en bewerkingen zijn toegestaan.

Methode Endpoint Doel
GET /scans/[scanId]/settings Verkrijg de volledige instellingen van een scan.
GET /axe-versions Lijst de axe-core versies die beschikbaar zijn in je axe Monitor-instantie.
GET /presets Lijst presets
GET /presets/[presetId]/editability Lijst welke instellingen bewerkt kunnen worden op scans die een preset gebruiken.

Scaninstellingen verkrijgen

Retourneert de volledige instellingen van een scan. Je kunt deze respons terugsturen naar POST /scans or PATCH /scans/[scanId] zonder deze te wijzigen.

Voorbeeldverzoek

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

Vereiste parameters

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

Voorbeeldantwoord

Status: 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": []
}

Opmerking: Wachtwoorden, keystores en waarden van omgevingsvariabelen worden nooit geretourneerd. Ze worden volledig weggelaten uit de respons, niet geretourneerd als null. Omgevingsvariabelen worden alleen op naam vermeld.

Opmerking: presetId is de preset die op de scan is toegepast, of null als er geen is. Wanneer een preset is toegepast, gebruik GET /presets/[presetId]/editability om te zien welke instellingen je kunt bewerken.

Foutreacties

HTTP-statuscode Beschrijving
401 De API-sleutel ontbreekt of is ongeldig.
403 Je hebt geen toegang tot deze scan.
404 De scan bestaat niet.

Volledige scaninstellingen beschikbaar via API

Dit gedeelte somt elke scaninstelling op die je kunt verzenden naar POST /scans en PATCH /scans/[scanId], en die GET /scans/[scanId]/settings retourneert. Instellingen zijn gegroepeerd op dezelfde manier als de scaninstellingen in de axe Monitor-gebruikersinterface, en de API accepteert dezelfde waarden die de gebruikersinterface doet.

Uitzondering: sessiegegevens voor het starten van een sessie zijn om veiligheidsredenen niet te wijzigen via de API. Gegevens kunnen alleen worden gewijzigd via de Axe Monitor-gebruikersinterface.

Algemene instellingen (vereist)

Naam Type Beschrijving
naam String De naam van de scan.
sites String[] De start-URL's voor de scan. Alleen vereist als er geen scripts op de scan zijn.

Toegankelijkheidsstandaard (vereist)

Naam Type Beschrijving
axeCoreVersie String De axe-core versie waarmee gescand wordt. Gebruik een versie van GET /axe-versions.
standaardNiveau String De toegankelijkheidsstandaard waartegen getest wordt, bijvoorbeeld wcag22aa. Gebruik een waarde van de tags van de gekozen axe-core versie.

Basisinstellingen (optioneel)

Naam Type Standaard Beschrijving
standaardopties String[] [] Extra regels die moeten worden opgenomen. Momenteel wordt alleen best-practice ondersteund.
aangepasteRegels Array [] Voeg zinnen of woorden toe die gebruikt kunnen worden met de instelling Zoek Tekst.
schakelPdfUaIn Boolean onwaar Controleer pdf's volgens PDF/UA.
openbareDeellink Boolean onwaar Maak een openbare deellink aan voor de scanresultaten.
axeRapportenUploaden Boolean onwaar Verstuur scanresultaten naar Axe Reports.

Scanbereik (Optioneel)

Naam Type Standaard Beschrijving
diepte Integer [] Hoeveel linkniveaus er moeten worden gecrawld vanaf de start-URL's.
paginaLimiet Integer [] Het maximale aantal pagina's dat per run wordt gescand.
vensterBreedte Integer 1920 Browser vensterbreedte, in pixels.
vensterHoogte Integer 1080 Browser vensterhoogte, in pixels.
schermafdrukkenOpslaan Boolean onwaar Sla schermafdrukken op met de scanresultaten.
bestandInhoudOpslaan Boolean onwaar Sla de volledige paginabron op bij de scanresultaten.
foutPaginasOpnemen Boolean onwaar Pagina's opnemen die een HTTP-foutstatus retourneren.
mimeTypesUitsluiten String[] [] Bestandstypen die tijdens het crawlen moeten worden overgeslagen, bijvoorbeeld application/pdf.
pdfDoel Integer -1 Het doelscanobject voor PDF's. -1 schakelt PDF-scanning uit. Kan niet worden gebruikt wanneer application/pdf in mimeTypesUitsluiten staat.
pdfAangepastVanafDatum Object of nul nul Scan alleen PDF's die na een bepaalde datum zijn gewijzigd.
pdfAangepastTotDatum Object of nul nul Scan alleen PDF's die voor een bepaalde datum zijn gewijzigd.

Gemeenschappelijke Componenten (Optioneel)

Naam Type Standaard Beschrijving
gemeenschappelijkeComponenten Array [] Gedeelde componentdefinities toegepast over pagina's heen.
sjabloonUris String[] [] URL gebruikt om gemeenschappelijke componenten te detecteren en te consolideren.
gemeenschappelijkeComponentenUitsluiten Boolean onwaar Laat gemeenschappelijke componentresultaten buiten de probleemtelling.

Crawlen en Sessie (Optioneel)

Naam Type Standaard Beschrijving
scripts Array [] Taak- en sessiescripts. Elk script heeft { "naam", „id“, "inhoud", "gedeeld", "mimeType" }.
runSessionScriptFirst Boolean onwaar Voer het sessiescript uit vóór paginascripts.
environmentVariables Array [] Variabelen beschikbaar voor scripts. Elke vermelding is { "name" }. Waarden kunnen niet worden gewijzigd en zijn niet opgenomen in antwoorden om veiligheidsredenen.
userAgent String of null nul Overschrijf de browser user agent string.
referrer String of null nul De waarde van de HTTP Referer-header die verzonden wordt.
sessionEstablishment.authType String of null nul De aanmeldmethode, bijvoorbeeld basic of keystore.
sessionEstablishment.authUserName String of null nul De gebruikersnaam die gebruikt wordt om in te loggen.
sessionEstablishment.script Object [] Wordt geretourneerd wanneer de scan een authenticatiescript heeft. Elk script heeft { "id", „naam“, "inhoud", "mimeType", "gedeeld" }.
sessionEstablishment.script.id Integer 0 Wordt geretourneerd wanneer de scan een authenticatiescript heeft. Om een gedeeld script toe te voegen bij gebruik van de Create of Edit Scan endpoints, ga naar Admin → Gedeelde Scripts in de Axe Monitor-gebruikersinterface. Bewerk een script en haal de ID uit de URL in de adresbalk: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
sessionEstablishment.script.name String [] Naam van het authenticatiescriptbestand dat op de scan wordt toegepast.
sessionEstablishment.script.contents String [] Inhoud van het authenticatiescript dat op de scan wordt toegepast.
sessionEstablishment.script.mimeType String [] Bestandstype van het script dat op de scan wordt toegepast.
sessionEstablishment.script.shared Boolean onwaar Waar geeft aan dat het script een gedeeld script is dat beschikbaar is in het Admin-gedeelte van Axe Monitor.

URL-bereik (Optioneel)

Naam Type Standaard Beschrijving
restrictToFolder Boolean onwaar Crawl alleen URL's onder het pad van de start-URL.
domeinen String[] [] Beperk de scan tot deze domeinen en hun subdirectories. Links naar andere domeinen worden niet gevolgd. Afgeleid van de ‘sites’-waarde. Standaard worden alleen domeinen in het ‘sites’-veld gescand.
skipSpecificUrls String[] [] URL-patronen die uit de crawl moeten worden gelaten.
mustHaveAll String[] [] Scan alleen URL's die al deze tekstreeksen bevatten.
mustHaveAny String[] [] Scan alleen URL's die ten minste één van deze tekstreeksen bevatten.
mustNotHaveAny String[] [] Sla URL's over die een van deze tekstreeksen bevatten.
ignoreAllParams Boolean onwaar Behandel URL's die alleen verschillen in queryparameters als dezelfde pagina. Wanneer waar, moeten meaningfulParams en meaninglessParams leeg zijn.
discardAnchorTags Boolean onwaar Behandel URL's die alleen verschillen in hun # fragment als dezelfde pagina.
meaningfulParams String[] [] Queryparameters die een URL een afzonderlijke pagina maken.
meaninglessParams String[] [] Queryparameters die genegeerd moeten worden bij het beslissen of twee URL's dezelfde pagina zijn.

Optimalisatie (Optioneel)

Naam Type Standaard Beschrijving
longPageOptimized Boolean onwaar Wachten voordat elke pagina wordt gescand. Stel de wachttijd in met pageWait.
pageWait Integer 0 Hoelang te wachten voordat elke pagina wordt gescand, in milliseconden. Toegestane bereik: 0 tot 120000.
waitAllPages Boolean true Past pageWait toe op elke pagina in de scan. Als false, wordt het alleen toegepast op de URL's in waitPageUrls.
waitPageUrls String[] [] De URL's waarop pageWait van toepassing is wanneer waitAllPages false is.
dynamicContentActive Boolean onwaar Wachten tot dynamische content, zoals animaties, lazy-loaded componenten en ingesloten media, geladen is voordat elke pagina wordt gescand. Stel de wachttijd in met dynamicContentWait.
dynamicContentWait Integer 0 Hoelang te wachten voor dynamische content voordat elke pagina wordt gescand. Gebruikt wanneer dynamicContentActive true is.
priority Integer 2 De plaats van de scan in de wachtrij. Toegestane bereik: 1 (hoogste) tot 3 (laagste).

Frequentie van Planning (Vereist voor geplande scans)

Naam Type Beschrijving
schedule Object Bevat optie voor handmatige (eenmalige) of geplande scans, en details indien de scan is gepland. Elke planning bevat { "frequencyType", “frequencyInterval”, "frequencyData", "startDate", "startTime", “endDate”, “maxOccurrences”, “timeoutMinutes”, “timeZone.” }. Het verzenden van null verwijdert de planning.
schedule.frequencyType String Vereist bij geplande scans. Hoe vaak de scan zich herhaalt. Handmatig creëert een scan zonder planning. Week zorgt voor wekelijkse scans, en Maand voor maandelijkse scans. M_DoW laat u een maandelijkse scan uitvoeren op een bepaalde dag van de week.
schedule.frequencyInterval Integer Vereist bij geplande scans. Hoeveel periodes u moet wachten tussen uitvoeringen (Week of Month). Bijvoorbeeld, 2 betekent elke 2 weken of maanden.
schedule.frequencyData String (als JSON) Op welke dagen de scan wordt uitgevoerd. De waarde is JSON geschreven als een string, en wat erin gaat hangt af van frequencyType. Week: JSON Array met de dagen van de week om op uit te voeren. Voorbeeld: "[1,3]" voert elke maandag en woensdag uit. Maand: JSON Object met de datum om elke maand op uit te voeren. Een getal van de dag, de string “First”, of de string “Last”. First en Last zijn hoofdlettergevoelig. Voorbeeld: "{\"dayOfMonth\":15}" voert uit op de 15e. M_DoW: JSON Object met een weekdag en welke in de maand. Voorbeeld: "{\"weekOfMonth\":2,\"dayOfWeek\":2}" voert uit op de tweede dinsdag. Gebruik weekOfMonth: 5 voor de laatste week van de maand, dus "{\"weekOfMonth\":5,\"dayOfWeek\":5}" is de laatste vrijdag van elke maand. Dagen worden genummerd 1 = maandag tot 7 = zondag.

Planningsdetails (Vereist voor geplande scans)

Naam Type Beschrijving
schedule.startDate Datum Vereist. Datum van de eerste uitvoering, als YYYY-MM-DD.
schedule.startTime Tijd-lokaal Vereist. Lokale tijd. elke uitvoering begint, als 24-uur HH:mm:ss, dus 14:30 uur is 14:30:00 (24-uur aangenomen). Geïnterpreteerd in timeZone.
schedule.endDate Datum Datum waarop de planning eindigt. Stel ofwel deze of maxOccurrences, niet allebei in.
schedule.maxOccurrences Integer Aantal uitvoeringen waarna de planning eindigt. Stel ofwel deze of endDate, niet allebei in.
schedule.timeoutMinutes Integer Maximale uitvoeringsduur in minuten, waarna de scan automatisch stopt. Handig wanneer een site een scan verhindert om te voltooien (zoals een URL die oneindig doorverwijst) of wanneer veel grote scans tegelijk uitgevoerd worden. Als het niet aanwezig is, is er geen timeout.
schedule.timeZone String IANA tijdzonenaam, zoals America/New_York. (Alle tijdzoneopties)

Teams en Delen (Optioneel)

Naam Type Standaard Beschrijving
scanGroups Object[] [] Scan groepen waartoe de scan behoort. Elke invoer is { “id”, "name" }.
scanGroups.id String [] IDs van de scan groepen waartoe de scan behoort.
scanGroups.name String [] Namen van de scan groepen waartoe de scan behoort.
teams Object[] [] Teams met toegang tot de scan. Elke invoer is { “id”, "name", “accessLevel” }.
teams.id String [] IDs van de teams met toegang tot de scan.
teams.name String [] Namen van de teams met toegang tot de scan.
teams.accessLevel String [] “viewer” toegang biedt Scan Viewer toegang voor het betreffende team. “member” toegang biedt Scan Member toegang, en “admin” biedt Scan Admin toegang.
scanGroups.id String [] ID van de scan groepen. Om scan groepen toe te voegen bij het gebruik van de Create of Edit Scan eindpunten, ga naar Admin → Scan Groups in de Axe Monitor gebruikersinterface. Bewerk een script en haal de ID op uit de URL in de adresbalk: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
scanGroups.name String [] Naam van de scan groepen
scanGroups.accessLevel String [] “viewer”, “member”, of “admin”
notifyGroup Boolean onwaar E-mail scan groepsleden wanneer een run beëindigt.
notifyUsers Array [] Specifieke gebruikers om te e-mailen wanneer een run beëindigt.

Alleen-lezen instellingen

GET /scans/[scanId]/settings retourneert ook deze. Ze worden genegeerd als u ze naar POST of PATCH stuurt.

Naam Type Beschrijving
scanId Integer De unieke identificatie van de scan.
presetId Integer of null De preset toegepast op de scan, of null als er geen is.
scanGroups[].id Integer De unieke identificatie van elke scan groep.

Voorbeeldantwoord

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

Lijst axe-core Versies

Geeft de axe-core versies terug die beschikbaar zijn in uw axe Monitor-instantie en de standaarden die elk ervan ondersteunt. axe Monitor detecteert niet automatisch nieuwe axe-core versies, dus gebruik dit eindpunt om te zien welke versies u kunt instellen als de axeCoreVersion van een scan.

Voorbeeldverzoek

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

Voorbeeldantwoord

Status: 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"
}

Responsvelden

Naam Type Beschrijving
versies Array De axe-core versies die beschikbaar zijn in uw instantie.
versies[].version String De versie-identificatie. Gebruik deze waarde als een scan's axeCoreVersion.
versies[].supported Boolean Of de versie momenteel wordt ondersteund.
versies[].tags String[] De standaarden en regelsets die deze versie ondersteunt. Gebruik deze waarden voor een scan’s standardLevel en standardOptions.
standaard String De standaard axe-core versie voor uw instantie.

Preset Bewerkbaarheid Ophalen

Geeft terug welke instellingen kunnen worden bewerkt op scans die een preset gebruiken. Controleer dit voordat u PATCH /scans/[scanId]/settings naar een scan met een preset stuurt, zodat u weet welke instellingen het zal accepteren.

Om de preset van een scan te vinden, lees presetId van GET /scans/[scanId]/settings. Om andere presets ID's te vinden, ga naar de Axe Monitor gebruikersinterface en navigeer naar Admin → Presets. Bewerk uw gewenste preset. Kopieer de ID van de URL in de adresbalk: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/presets/[ID]/edit

Voorbeeldverzoek

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

X-API-KEY: <your_api_key>

Vereiste parameters

Naam Type Beschrijving
presetId Integer De unieke identificatie van de preset.

Voorbeeldantwoord

Status: 200 OK

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

Responsvelden

Naam Type Beschrijving
presetId Integer De unieke identificatie van de preset.
velden Object Elke sleutel is een instellingennaam van Geavanceerde Scaninstellingen. true betekent dat je deze kunt bewerken bij scans die dit preset gebruiken; false betekent dat het preset deze vergrendelt.

Het verzenden van een vergrendelde instelling met een nieuwe waarde resulteert in 400 field_locked_by_preset. Het verzenden met de huidige waarde slaagt en verandert niets.

Foutreactie

Naam Type
401 De API-sleutel ontbreekt of is ongeldig.
403 Je hebt geen toegang tot dit preset.
404 Het preset bestaat niet.

Is this page helpful?

Help us improve this page

Still need help?