Übergang zu Axe Developer Hub APIs für mobile Ergebnisse

Wenn Sie die mobile-service REST-API in Ihren eigenen Skripten verwendet haben, sollten Sie wissen, dass die mobile-service eingestellt wird. Ergebnisse sind nun im Axe Developer Hub verfügbar. Konsultieren Sie die gepflegte API-Dokumentation auf den folgenden Seiten:

• Projects API
• Sessions and Results API

Diese Seite soll API-Nutzern helfen, diesen Übergang zu verstehen.

Verwendung der Axe Developer Hub APIs

Mit jeder der Developer Hub APIs geben Sie Ihren Axe DevTools Mobile API-Schlüssel in die Header zur Authentifizierung ein.

Verwenden Sie den Projects-Endpunkt, um eine Liste Ihrer mobilen Projekte zurückzugeben und die einzigartige Projekt-ID für jedes zu erhalten. Sie benötigen eine Projekt-ID, um den Sessions-Endpunkt aufzurufen. Rufen Sie den Sessions-Endpunkt mit der Projekt-ID auf, um alle Sessions für ein bestimmtes Projekt abzurufen. Jede Session-ID aus dieser Antwort kann an den Results-Endpunkt übergeben werden.

Ausgabeformat

Ergebnisse werden als Axe Universal JSON zurückgegeben, ein Standardformat, das von allen Axe-Produkten verwendet wird. Es enthält die Ergebnisse der Barrierefreiheitstests, aber nicht einen Screenshot oder die mobile Ansichts-Hierarchie. Mobile JSON enthält alle Informationen, die zum Zeitpunkt des Scans erfasst wurden, einschließlich der Barrierefreiheitstestergebnisse, der gesamten mobilen Ansichtshierarchie und eines Screenshots. Obwohl Mobile JSON nicht über die API verfügbar ist, können Sie Ihre Daten in diesem Format aus der Axe Developer Hub-Benutzeroberfläche exportieren.

Migration von der mobile-serviceREST-API

Da Ergebnisse aus den Axe Developer Hub APIs aus Sessions und nicht aus einzelnen Scans stammen, wird die Funktionalität anders sein als bei der mobile-service.

• Verwenden Sie die Sessions and Results API für vollständige Scan-Zusammenfassungen sowie gefilterte Scan-Zusammenfassungen
• Mit der mobile-service API konnten Sie Scan-Ergebnisse an das Mobile Dashboard senden. Jetzt müssen Sie unsere SDKs oder Appium-Treiber verwenden und startScanSession aufrufen, um Ergebnisse an den Axe Developer Hub zu senden
  • Finden Sie eine automatisierte Testlösung, die am besten für Sie funktioniert - Automatisiertes Testen mit Axe DevTools Mobile
• Sie können die Namen einzelner Scans nicht programmatisch aktualisieren, obwohl Sie die Session in der Axe Developer Hub-Benutzeroberfläche können umbenennen können
• Beachten Sie, dass Sie mit den Axe Developer Hub APIs keine Tags eines Scans mehr aktualisieren oder einzelne Scans löschen können