Umstellung auf Axe Developer Hub APIs für mobile Ergebnisse

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

Wenn Sie die mobile-service REST-API aus Ihren eigenen Skripten aufgerufen haben, sollten Sie wissen, dass die mobile-service außer Dienst gestellt wird. Die Ergebnisse befinden sich jetzt im Axe Developer Hub. Verweisen Sie auf die gepflegte API-Dokumentation auf den folgenden Seiten:

Diese Seite soll API-Nutzern helfen, diesen Übergang zu verstehen. Sie können diese Seite ignorieren, wenn Sie unsere SDKs, Appium-Treiber oder Mobile Analyzers verwenden.

Verwendung der Axe Developer Hub APIs

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

Schlüssel Wert
X-API-Key YOUR_API_KEY

Verwenden Sie den Projekte-Endpunkt, um eine Liste Ihrer mobilen Projekte abzurufen und die eindeutige Projekt-ID für jedes Projekt zu erhalten. Sie benötigen eine Projekt-ID, um den Sitzungen-Endpunkt aufzurufen. Rufen Sie den Sitzungen-Endpunkt unter Verwendung der Projekt-ID auf, um alle Sitzungen für ein bestimmtes Projekt abzurufen. Jede Sitzungs-ID aus dieser Antwort kann an den Ergebnisse-Endpunkt übergeben werden.

Ausgabeformat

Die 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 keinen Screenshot oder die mobile Ansichtshierarchie. Mobile JSON enthält alle Informationen, die zum Zeitpunkt des Scans erfasst wurden, einschließlich der Ergebnisse der Barrierefreiheitstests, 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 UI exportieren.

Migration von der mobile-serviceREST-API

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

  • Verwenden Sie die Sitzungen und Ergebnisse-API für vollständige und gefilterte Scan-Zusammenfassungen
  • Mit der mobile-service API konnten Sie Scan-Ergebnisse an das Mobile Dashboard POSTen. Jetzt müssen Sie unsere SDKs oder Appium-Treiber verwenden und startScanSession aufrufen, um Ergebnisse an Axe Developer Hub zu senden
  • Sie können die Namen einzelner Scans nicht programmgesteuert aktualisieren, aber Sie können die Sitzung in der Axe Developer Hub UI umbenennen
  • Beachten Sie, dass Sie mit den Axe Developer Hub APIs keine Tags eines Scans mehr aktualisieren oder einzelne Scans löschen können
note

Alte Scans bleiben in der mobile-service und können bis zum 31. Dezember 2026 weiterhin über die alte API abgerufen werden.

Is this page helpful?

Help us improve this page

Still need help?