Overstap naar Axe Developer Hub API's voor Mobiele Resultaten

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

Als je de mobile-service REST API vanuit je eigen scripts hebt aangeroepen, moet je weten dat de mobile-service wordt uitgefaseerd. Resultaten zijn nu te vinden in de Axe Developer Hub. Raadpleeg de bijgewerkte API-documentatie op de volgende pagina's:

Deze pagina is ontworpen om API-gebruikers te helpen deze overgang te begrijpen. Je kunt deze pagina negeren als je onze SDK's, Appium-drivers of Mobiele Analyzers gebruikt.

Gebruik van de Axe Developer Hub API's

Bij elk van de Developer Hub API's moet je je Axe DevTools Mobile API-sleutel in de headers invoeren voor authenticatie.

Sleutel Waarde
X-API-Key YOUR_API_KEY

Gebruik het Projecten endpoint om een lijst van je mobiele projecten op te halen en toegang te krijgen tot de unieke project-ID voor elk project. Je hebt een project-ID nodig om het Sessies endpoint aan te roepen. Roep het Sessies endpoint aan met de project-ID om alle sessies voor een bepaald project op te halen. Elke sessie-ID uit dit antwoord kan worden doorgegeven aan het Resultaten endpoint.

Outputformaat

Resultaten worden geretourneerd als Axe Universal JSON, een standaardformaat dat door alle Axe-producten wordt gebruikt. Het bevat de toegankelijkheidstestresultaten, maar bevat geen screenshot of de mobiele weergavehiërarchie. Mobiele JSON bevat alle informatie die op het moment van de scan is vastgelegd, inclusief de toegankelijkheidstestresultaten, de volledige mobiele weergavehiërarchie en een screenshot. Hoewel Mobiele JSON niet beschikbaar is via de API, kun je je gegevens in dit formaat exporteren vanuit de Axe Developer Hub UI.

Migratie van de mobile-serviceREST API

Omdat resultaten van de Axe Developer Hub API's afkomstig zijn uit sessies in plaats van enkele scans, zal de functionaliteit anders zijn dan bij de mobile-service.

  • Gebruik de Sessies en Resultaten API voor volledige scansamenvattingen evenals gefilterde scansamenvattingen
  • Met de mobile-service API kon je scanresultaten posten naar het Mobiele Dashboard. Nu moet je onze SDK's of Appium-drivers gebruiken en startScanSession oproepen om resultaten naar de Axe Developer Hub te verzenden
  • Je kunt de namen van individuele scans niet programmatisch bijwerken, hoewel je de sessie in de Axe Developer Hub UI kun kunt hernoemen
  • Merk op dat je met de Axe Developer Hub API's niet langer de tag(s) van een scan kunt bijwerken of individuele scans kunt verwijderen
note

Oude scans blijven in de mobile-service en kunnen via de oude API nog steeds worden gelezen tot en met 31 december 2026.