モバイル結果のためのAxe Developer Hub APIへの移行
自分自身のスクリプトからmobile-service REST APIを呼び出していた場合、mobile-serviceが廃止予定であることを知っておくべきです。結果は現在Axe Developer Hubにあります。以下のページで維持されたAPIドキュメントを参照してください。
このページはAPIユーザーがこの移行を理解するのを助けるために設計されています。もし私たちのSDK、Appiumドライバー、またはモバイルアナライザーを使用している場合は、このページを無視してかまいません。
Axe Developer Hub APIの使用
各Developer Hub APIと共に、認証のためにAxe DevTools Mobile APIキーをヘッダーに渡します。
| キー | 値 |
|---|---|
| X-API-Key | YOUR_API_KEY |
プロジェクトエンドポイントを使用して、モバイルプロジェクトのリストを返し、各プロジェクトのユニークなプロジェクトIDにアクセスします。セッションエンドポイントを呼び出すにはプロジェクトIDが必要です。 セッションエンドポイントをプロジェクトIDを使用して呼び出し、指定されたプロジェクトのすべてのセッションを取得します。この応答からの各セッションIDは結果エンドポイントに渡すことができます。
出力形式
結果は、すべてのAxe製品で使用される標準フォーマットであるAxeユニバーサルJSONとして返されます。それにはアクセシビリティテストの結果が含まれていますが、スクリーンショットやモバイルビュー階層は含まれていません。 モバイルJSONには、スキャン時にキャプチャされたすべての情報、アクセシビリティテストの結果、モバイルビューの全階層、およびスクリーンショットが含まれています。モバイルJSONはAPIを通しては利用できませんが、Axe Developer HubのUIからこのフォーマットでデータをエクスポートできます。
mobile-serviceREST APIからの移行
Axe Developer Hub APIからの結果は単一のスキャンではなくセッションから得られるため、mobile-serviceとの機能は異なります。
- セッションと結果APIを使用して、完全なスキャン概要とフィルタされたスキャン概要を取得します
mobile-serviceAPIを使用してスキャン結果をモバイルダッシュボードにPOSTすることができましたが、現在ではSDKまたはAppiumドライバーを使用し、startScanSessionを呼び出してAxe Developer Hubに結果を送信する必要があります- あなたに最適な自動テストソリューションを見つける - Axe DevTools Mobileでの自動テスト
- 個別のスキャン名をプログラムで更新することはできませんが、Axe Developer Hub UIでセッションの名前を可能変更することはできます
- Axe Developer Hub APIでは、スキャンのタグを更新したり、個別のスキャンを削除したりすることはできなくなります
古いスキャンはmobile-serviceにとどまり、2026年12月31日まで旧APIを通して読み取ることができます。
