Overstappen 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 stopgezet. 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.

De Axe Developer Hub API's gebruiken

Bij elke Developer Hub API geef je je Axe DevTools Mobile API Key door in de headers voor authenticatie.

Sleutel Waarde
X-API-Key YOUR_API_KEY

Gebruik de Projecten eindpunt om een lijst van je mobiele projecten terug te halen en de unieke Project ID voor elk hiervan te verkrijgen. Je hebt een Project ID nodig om het Sessies eindpunt aan te roepen. Roep het Sessies eindpunt aan met de project-ID om alle sessies voor een gegeven project op te halen. Elke sessie-ID van deze respons kan worden doorgegeven aan het Resultaten eindpunt.

Uitvoerformaat

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.

Migreren van de mobile-serviceREST API

Aangezien resultaten van de Axe Developer Hub API's uit sessies komen in plaats van uit enkele scans, zal de functionaliteit verschillend zijn dan met de mobile-service.

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

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