axe DevTools Mobile API

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

axe DevTools Mobile API（アプリケーションプログラムインターフェース）は、代表的な状態転送、通称RESTに基づいて編成されています。

当APIを利用して、アクセシビリティテストにおけるチームのワークフローを完全にコントロールしましょう。

次の項目へジャンプ:

important

{{result_userid}}、{{result_package}}、または{{result_id}}への参照は、スキャン完了後のaxe DevTools MobileのAxeDevToolsResultKeyオブジェクト内に見つかります。

認証

開始するには、axe.deque.com/settingsで新しいAPIキーをコピーまたは作成します。

いずれのリクエストでも、APIキーをヘッダーに追加してください:

キー 値
X-Api-Key YOUR_API_KEY

スキャンサマリー

サーバーから結果の要約リストを取得します。

リクエスト

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
ヘッダー:

キー 値
X-Api-Key YOUR_API_KEY
Content-Type application/json

レスポンス

200 - Success
結果の要約の配列を返します。

JSONの例 


[
    {
        "key": {
            "userId": "",
            "packageName": "",
            "resultId": "",
            "uuid": ""
        },
        "userName": "",
        "summary": {
            "MeaningfulAccessibleName": {
                "PASS": 10,
                "FAIL": 1
            },
            "A11yElementFocusBox": {
                "PASS": 10
            },
            "ConflictingTraits": {
                "PASS": 10
            }
        },
        "tags": [
            ""
        ],
        "axeDevice": {
            "dpi": 2.0,
            "name": "iPhone 8",
            "os": "iOS",
            "osVersion": "13.7",
            "screenHeight": 1334,
            "screenWidth": 750
        },
        "axeMetaData": {
            "axeVersion": "XCUI: 2.0.1-647-f49682f0",
            "appIdentifier": "",
            "analysisTimestamp": "",
            "screenTitle": ""
        },
        "scanName": "",
        "uuid": "",
    }
]

フィルタされたスキャンサマリー

指定された条件に一致する結果のサマリー一覧をサーバーから取得します。

リクエスト

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
ヘッダー:

キー 値
X-Api-Key YOUR_API_KEY
Content-Type application/json

クエリパラメータ:

キー 値
userId 文字列
os 文字列
tags 文字列 (カンマ区切り)
packageName 文字列

レスポンス

200 - Success
結果の要約の配列を返します。

JSONの例 


[
    {
        "key": {
            "userId": "",
            "packageName": "",
            "resultId": "",
            "uuid": ""
        },
        "userName": "",
        "summary": {
            "MeaningfulAccessibleName": {
                "PASS": 10,
                "FAIL": 1
            },
            "A11yElementFocusBox": {
                "PASS": 10
            },
            "ConflictingTraits": {
                "PASS": 10
            }
        },
        "tags": [
            ""
        ],
        "axeDevice": {
            "dpi": 2.0,
            "name": "iPhone 8",
            "os": "iOS",
            "osVersion": "13.7",
            "screenHeight": 1334,
            "screenWidth": 750
        },
        "axeMetaData": {
            "axeVersion": "XCUI: 2.0.1-647-f49682f0",
            "appIdentifier": "",
            "analysisTimestamp": "",
            "screenTitle": ""
        },
        "scanName": "",
        "uuid":"",
    }
]

スキャンの取得

ダッシュボードから特定のスキャン結果を返します。

リクエスト

GET
URL: https://axe-mobile-backend.deque.com/attest/result/axe/{{result_userid}}/{{result_package}}/{{result_id}}
ヘッダー:

キー 値
X-Api-Key YOUR_API_KEY
Content-Type application/json

レスポンス

200 - Success
スキャン結果を返します。

JSONの例

Note: `axeView` will contain different platform-specific properties for an iOS or Android scan.


{
    "axeConf": {
        "standards": [
            "Best Practice",
            "Platform",
            "WCAG 2.0",
            "WCAG 2.1"
        ],
        "ruleIds": [
            "SwitchName",
            "ActiveViewName"
        ],
        "rules": {
            "SwitchName": {
                "impact": 1,
                "standard": "Best Practice",
                "summary": "Views that have modifiable Values
                 should get their name from a nearby Label.",
                "ignored": false
            },
            "ActiveViewName": {
                "impact": 3,
                "standard": "WCAG 2.0",
                "summary": "Views that users can interact with must
                have a Name.",
                "ignored": false
            }
        },
        "issueFilterConf": {
            "onlyShowResultsVisibleToUser": false
        }
    },
    "axeContext": {
        "axeView": {
            "isComposeView": false,
            "isImportantForAccessibility": true,
            "visibility": 0.0,
            "axeViewId": "",
            "measuredWidth": 1080.0,
            "className": "",
            "textColor": "0",
            "boundsInScreen": {
                "bottom": 2340.0,
                "left": 0.0,
                "right": 1080.0,
                "top": 0.0
            },
            "isVisibleToUser": true,
            "isAccessibilityFocusable": false,
            "overridesAccessibilityDelegate": false,
            "measuredHeight": 2340.0,
            "children": [
                {
                    "axeViewId": "",
                    "boundsInScreen": {
                        "bottom": 0.0,
                        "left": 0.0,
                        "right": 0.0,
                        "top": 0.0
                    },
                    "calculatedProps": {
                        ...
                    },
                    "children": [
                        ...
                    ],
                    "className": "android.widget.LinearLayout",
                    "ignoreRules": [
                        "HiddenInformativeViewFocus",
                        "HiddenActiveViewFocus"
                    ],
                    "isAccessibilityFocusable": false,
                    "isClickable": false,
                    "isComposeView": false,
                    "isEnabled": true,
                    "isImportantForAccessibility": false,
                    "isVisibleToUser": true,
                    "measuredHeight": 0.0,
                    "measuredWidth": 0.0,
                    "overridesAccessibilityDelegate": false,
                    "packageName": "",
                    "textColor": "0",
                    "viewIdResourceName": "",
                    "visibility": 0.0
                },
                ...
            ],
            "isEnabled": true,
            "viewIdResourceName": "",
            "calculatedProps": {
                ...
            },
            "isClickable": false,
            "ignoreRules": [
                ""
            ],
            "packageName": ""
        },
        "axeDevice": {
            "dpi": 3.0,
            "name": "",
            "os": "Android",
            "osVersion": "",
            "screenHeight": 0,
            "screenWidth": 0
        },
        "screenshot": "",
        "axeEventStream": [],
        "axeMetaData": {
            "axeVersion": "",
            "appIdentifier": "",
            "analysisTimestamp": "",
            "screenTitle": ""
        }
    },
    "axeRuleResults": [
        {
            "axeViewId": "",
            "isVisibleToUser": true,
            "props": {
                ...
            },
            "ruleId": "",
            "ruleSummary": "",
            "impact": 4,
            "status": "PASS"
        },
        ...
    ],
    "userName": "",
    "scanName": "",
    "tags": [
        ""
    ],
    "uuid": "",
    "score": 80
}

スキャンの送信

スキャン結果をダッシュボードにアップロードします。

リクエスト

POST
URL: https://axe-mobile-backend.deque.com/attest/result/axe
ヘッダー:

キー 値
X-Api-Key YOUR_API_KEY
Content-Type application/json

ボディ:
iOSまたはAndroidスキャンからのJSON。

レスポンス

200 - Success
提出された結果の結果キーを返します。

Example JSON 


{
    "userId": "",
    "packageName": "",
    "resultId": "",
    "uuid": ""
}

スキャンの名前を更新

ダッシュボード内に表示されるスキャンの名前を更新します。

リクエスト

PUT
URL: https://axe-mobile-backend.deque.com/attest/results/summaries/{{result_userid}}/{{result_package}}/{{result_id}}/name
ヘッダー:

キー 値
X-Api-Key YOUR_API_KEY
Content-Type application/json

ボディ：

Name of the Scan

レスポンス

200 - Success
スキャン結果の要約を返します。

JSONの例 


{
    "key": {
        "userId": "",
        "packageName": "",
        "resultId": "",
        "uuid": ""
    },
    "userName": "",
    "summary": {
        "ActiveControlName": {
            "PASS": 10
        },
        "A11yElementFocusBox": {
            "PASS": 10,
            "FAIL": 1
        }
    },
    "tags": [
        ""
    ],
    "axeDevice": {
        "dpi": 3.0,
        "name": "",
        "os": "",
        "osVersion": "",
        "screenHeight": 0,
        "screenWidth": 0
    },
    "axeMetaData": {
        "axeVersion": "",
        "appIdentifier": "",
        "analysisTimestamp": "",
        "screenTitle": ""
    },
    "scanName": "Name of the Scan"
}

スキャンのタグを更新

ダッシュボードに表示されるスキャンのタグを指定されたタグに更新します。

リクエスト

POST
URL: https://axe-mobile-backend.deque.com/attest/result/tag/{{result_userid}}/{{result_package}}/{{result_id}}
ヘッダー:

キー 値
X-Api-Key YOUR_API_KEY
Content-Type application/json

ボディ：

["Example Tag"]

レスポンス

200 - Success
更新された結果の結果キーを返します。

Example JSON 


{
    "userId": "",
    "packageName": "",
    "resultId": "",
    "uuid": ""
}

スキャンを削除

ダッシュボードからスキャン結果を削除します。

リクエスト

DELETE
URL: https://axe-mobile-backend.deque.com/attest/result/{{result_userid}}/{{result_package}}/{{result_id}}
ヘッダー:

キー 値
X-Api-Key YOUR_API_KEY
Content-Type application/json

レスポンス

200 - Success
削除された結果の結果キーを返します。

JSONの例 


{
    "userId": "",
    "packageName": "",
    "resultId": "",
    "uuid": ""
}

Is this page helpful?

Help us improve this page

Still need help?