API axe DevTools Mobile

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 (Application Program Interface) di axe DevTools Mobile è organizzato attorno al Representational State Transfer, spesso indicato come REST.

Utilizza la nostra API e controlla completamente il flusso di lavoro del tuo team nei test di accessibilità.

Vai a:

important

Riferimenti a {{result_userid}}, {{result_package}} o {{result_id}} possono essere trovati all'interno degli oggetti AxeDevToolsResultKey di axe DevTools Mobile dopo il completamento di una scansione.

Autenticazione

Per iniziare, copia o crea una nuova chiave API su axe.deque.com/settings.

Per qualsiasi richiesta, aggiungi la tua chiave API nell'intestazione:

Chiave Valore
X-Api-Key YOUR_API_KEY

Riepiloghi delle scansioni

Recupera un elenco riassuntivo dei risultati dal server.

Richiesta

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
Intestazioni:

Chiave Valore
X-Api-Key YOUR_API_KEY
Content-Type application/json

Risposta

200 - Success
Restituisce un array di riepiloghi dei risultati.

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

Riepiloghi delle scansioni filtrate

Recupera un elenco riassuntivo dei risultati dal server che corrispondono ai criteri specificati.

Richiesta

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
Intestazioni:

Chiave Valore
X-Api-Key YOUR_API_KEY
Content-Type application/json

Parametri di Query:

Chiave Valore
userId Stringa
os Stringa
tags Stringa (Separata da virgole)
packageName Stringa

Risposta

200 - Success
Restituisce un array di riepiloghi dei risultati.

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

Recupera una Scansione

Restituisce un risultato di scansione specifico dal pannello di controllo.

Richiesta

GET
URL: https://axe-mobile-backend.deque.com/attest/result/axe/{{result_userid}}/{{result_package}}/{{result_id}}
Intestazioni:

Chiave Valore
X-Api-Key YOUR_API_KEY
Content-Type application/json

Risposta

200 - Success
Restituisce un risultato di scansione.

Esempio 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
}

Invia una Scansione

Carica un risultato di scansione sul pannello di controllo.

Richiesta

POST
URL: https://axe-mobile-backend.deque.com/attest/result/axe
Intestazioni:

Chiave Valore
X-Api-Key YOUR_API_KEY
Content-Type application/json

Corpo:
JSON da una scansione iOS o Android.

Risposta

200 - Success
Restituisce la chiave del risultato inviato.

Example JSON 


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

Aggiorna il Nome di una Scansione

Aggiorna il nome di una scansione come mostrato nella dashboard.

Richiesta

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

Chiave Valore
X-Api-Key YOUR_API_KEY
Content-Type application/json

Corpo:

Name of the Scan

Risposta

200 - Success
Ritorna il riepilogo del risultato della scansione.

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

Aggiorna una o più etichette di una scansione

Aggiorna le etichette di una scansione come mostrato nella dashboard con le etichette specificate.

Richiesta

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

Chiave Valore
X-Api-Key YOUR_API_KEY
Content-Type application/json

Corpo:

["Example Tag"]

Risposta

200 - Success
Ritorna la chiave del risultato aggiornato.

Example JSON 


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

Elimina una scansione

Rimuove un risultato di scansione dalla dashboard.

Richiesta

DELETE
URL: https://axe-mobile-backend.deque.com/attest/result/{{result_userid}}/{{result_package}}/{{result_id}}
Intestazioni:

Chiave Valore
X-Api-Key YOUR_API_KEY
Content-Type application/json

Risposta

200 - Success
Ritorna la chiave del risultato eliminato.

Esempio JSON 


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

Is this page helpful?

Help us improve this page

Still need help?