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

L'API mobile (Application Program Interface) d'axe DevTools est organisée autour du transfert d'état représentatif, souvent appelé REST.

Utilisez notre API et contrôlez entièrement le flux de travail de votre équipe dans les tests d'accessibilité.

Aller à :

important

Les références à {{result_userid}}, {{result_package}}, ou {{result_id}} peuvent être trouvées dans AxeDevToolsResultKey les objets d'axe DevTools Mobile une fois l'analyse terminée.

Authentification

Pour commencer, copiez ou créez une nouvelle clé API sur axe.deque.com/settings.

Pour toute requête, ajoutez votre clé API dans l'entête :

Touche Valeur
X-Api-Key YOUR_API_KEY

Résumés des analyses

Récupère une liste résumée des résultats du serveur.

Demande

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
En-têtes :

Touche Valeur
X-Api-Key YOUR_API_KEY
Content-Type application/json

Réponse

200 - Succès
Renvoie un tableau de résumés de résultats.

Exemple 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": "",
    }
]

Résumés d'analyse filtrés

Récupère une liste résumée des résultats du serveur correspondant aux critères spécifiés.

Demande

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
En-têtes :

Touche Valeur
X-Api-Key YOUR_API_KEY
Content-Type application/json

Paramètres de la requête :

Touche Valeur
userId Chaîne
os (système d'exploitation) Chaîne
tags (balises) Chaîne (séparée par des virgules)
packageName Chaîne

Réponse

200 - Succès
Renvoie un tableau de résumés de résultats.

Exemple 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":"",
    }
]
	

Extraire un scan

Renvoie un résultat de scan spécifique à partir du tableau de bord.

Demande

GET
URL: https://axe-mobile-backend.deque.com/attest/result/axe/{{result_userid}}/{{result_package}}/{{result_id}}
En-têtes :

Touche Valeur
X-Api-Key YOUR_API_KEY
Content-Type application/json

Réponse

200 - Succès
Renvoie un résultat d'analyse.

Exemple JSON

Remarque : `axeView` contiendra différentes propriétés spécifiques à la plate-forme pour une analyse iOS ou Android.


{
    "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
}
	

Soumettre une analyse

Télécharge un résultat d'analyse sur le tableau de bord.

Demande

POST
URL: https://axe-mobile-backend.deque.com/attest/result/axe
En-têtes :

Touche Valeur
X-Api-Key YOUR_API_KEY
Content-Type application/json

Corps :
JSON à partir d'une analyse iOS ou Android.

Réponse

200 - Succès
Renvoie la clé du résultat du résultat soumis.

Exemple JSON


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

Mettre à jour le nom d'un scan

Met à jour le nom d'un scan tel qu'il apparaît dans le tableau de bord.

Demande

PUT
URL: https://axe-mobile-backend.deque.com/attest/results/summaries/{{result_userid}}/{{result_package}}/{{result_id}}/name
En-têtes :

Touche Valeur
X-Api-Key YOUR_API_KEY
Content-Type application/json

Corps :

Name of the Scan

Réponse

200 - Succès
Renvoie le résumé des résultats de l'analyse.

Exemple 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"
}
	

Comment mettre à jour les balises d'une analyse

Met à jour les balises d'une analyse telles qu'elles apparaissent dans le tableau de bord avec les balises spécifiées.

Demande

POST
URL: https://axe-mobile-backend.deque.com/attest/result/tag/{{result_userid}}/{{result_package}}/{{result_id}}
En-têtes :

Touche Valeur
X-Api-Key VOTRE_CLÉ_API
Content-Type application/json

Corps :

["Example Tag"]

Réponse

200 - Succès
Renvoie la clé du résultat mis à jour.

Exemple JSON


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

Supprimer une analyse

Supprime un résultat d'analyse du tableau de bord.

Demande

SUPPRIMER
URL: https://axe-mobile-backend.deque.com/attest/result/{{result_userid}}/{{result_package}}/{{result_id}}
En-têtes :

Touche Valeur
X-Api-Key YOUR_API_KEY
Content-Type application/json

Réponse

200 - Succès
Renvoie la clé de résultat du résultat supprimé.

Exemple JSON


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