Scans maken, wijzigen en uitvoeren via 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-beheerders kunnen een API-sleutel genereren in Axe Account en scans systematisch maken, wijzigen of uitvoeren, zonder de gebruikersinterface te gebruiken.

Lees meer over Aan de slag.

Eindpunten

Methode Eindpunt Doel
POST /scans Een scan maken.
PATCH /scans/[scanId] Een of meer instellingen van een scan wijzigen.
POST /scans/[scanId]/runs Een nieuwe uitvoering in de wachtrij plaatsen.

Een Scan Maken

Maakt één scan van een enkel scaninstellingsobject. Om meerdere scans tegelijk te maken, verstuurt u één verzoek per scan.

Opmerking: Om uw referenties veilig te houden, accepteert de API geen wachtwoorden, keystore-bestanden of waarden van omgevingsvariabelen. Voeg deze waarden toe in de Axe Monitor-gebruikersinterface in de inloggegevens van de scan.

Voorbeeldverzoek

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

Vereiste Parameters

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 staan.
axeCoreVersie String De axe-core versie waarmee gescand moet worden. Gebruik een version waarde van GET /axe-versions.
standaardNiveau String De toegankelijkheidsstandaard waartegen getest moet worden, bijvoorbeeld wcag22aa.
diepte Integer Hoeveel linkniveaus vanaf de start-URL's moeten worden gecrawled.
paginaLimiet Integer Het maximale aantal pagina's dat in elke uitvoering wordt gescand.

Optionele Instellingen

Aanvullende scaninstellingen kunnen worden gebruikt met het Create Scan-eindpunt. Bekijk documentatie over Scaninstellingen.

Voorbeeldverzoek

{
  "name": "Marketing Site - Production",
  "sites": ["https://www.example.com"],
  "axeCoreVersion": "latest",
  "standardLevel": "wcag22aa",
  "standardOptions": ["best-practice"],
  "depth": 3,
  "pageLimit": 100,
  "skipSpecificUrls": ["https://www.example.com/logout"],
  "teams": [
    { "name": "Digital Accessibility Team" }
  ],
  "notifyGroup": true
}

Voorbeeldantwoord

Status: 201 Aangemaakt

{
  "scanId": 12345
}

Gebruik de geretourneerde [scanId] om de scan te lezen, bewerken of uitvoeren.

Opmerking: De API accepteert geen wachtwoorden, keystores of waarden van omgevingsvariabelen. Als uw scan inlogt op een site of scripts uitvoert die geheime waarden vereisen, maak dan de scan via de API en voeg die waarden vervolgens toe in axe Monitor onder Geavanceerde Instellingen, Een sessie starten.

Foutreacties

HTTP-statuscode Foutcode Wanneer het gebeurt
400 out_of_range Een getal ligt buiten het toegestane bereik.
400 unknown_version axeCoreVersie is niet beschikbaar in uw instantie.
400 conflicting_pdf_config pdfTarget is ingesteld, maar application/pdf staat in excludeMimeTypes.
400 conflicting_url_scope ignoreAllParams is waar en meaningfulParams of meaninglessParams is niet leeg.
400 unknown_reference Een scangroep of team bestaat niet.

Een scan bewerken

Wijzigt één of meer instellingen van een bestaande scan. Stuur alleen de instellingen die je wilt aanpassen; instellingen die je weglaat behouden hun huidige waarden.

Opmerking:

Voorbeeldverzoek

PATCH
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/settings
X-API-Key: <your_api_key>
Content-Type: application/json

Vereiste Parameters

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

Er is minimaal één extra instelling nodig om een wijziging door te voeren. Bekijk de documentatie van scaninstellingen .

Opmerking:

  • ‘null’ reset een veld naar de standaardwaarde
  • Arrays vervangen de opgeslagen waarde

Voorbeeldverzoek

{
  "name": "Marketing Site - Production (weekly)",
  "depth": 4,
  "pageLimit": 250
}

Voorbeeldantwoord

Status: 200 OK

{
  "scanId": 12345,
  "updatedFields": ["name", "depth", "pageLimit"]
}

updatedFields somt de gewijzigde instellingen op.

Foutreactie

HTTP-statuscode Foutcode Wanneer het gebeurt
400 field_locked_by_preset De preset die op de scan is toegepast, vergrendelt deze instelling.
400 field_not_editable De instelling kan niet worden gewijzigd nadat de scan is aangemaakt.

Een scanuitvoering starten

Plaatst een nieuwe uitvoering van een bestaande scan in de wachtrij. De uitvoering start wanneer axe Monitor deze uit de wachtrij haalt. Om de voortgang te controleren, gebruik GET /scans/[scanId]/runs.

Voorbeeldverzoek

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

Vereiste Parameters

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

Voorbeeldantwoord

Status: 202 Accepted

De reactie heeft geen inhoud.

Voorbeeld foutreactie

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Couldn't queue job since it's already running",
  "instance": "/v1/scans/20/runs"
}

Foutreacties

HTTP-statuscode Beschrijving
400 De scan is al bezig. Wacht tot de huidige uitvoering is voltooid en probeer het dan opnieuw.
404 De scan bestaat niet.

Is this page helpful?

Help us improve this page

Still need help?