API di 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 è organizzata 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

I riferimenti a {{result_userid}, {{result_package} o {{result_id} possono essere trovati all'interno di AxeDevToolsResultKey oggetti 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 all'intestazione:

Tasto Valore
X-Api-Key YOUR_API_KEY

Riepiloghi delle scansioni

Recupera un elenco riepilogativo dei risultati dal server.

Richiesta

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

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

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

Riepiloghi di scansione filtrati

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

Richiesta

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

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

Parametri di query:

Tasto Valore
userId String
os String
tags Strings (separata da virgole)
packageName String

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 dalla dashboard.

Richiesta

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

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

Risposta

200 - Success
Restituisce il risultato della scansione.

Esempio JSON

Nota: `axeView` conterrà proprietà specifiche della piattaforma diverse per una scansione iOS o 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
}

Sottometti una scansione

Carica il risultato della scansione sulla dashboard.

Richiesta

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

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

Corpo:
JSON risultante da una scansione iOS o Android.

Risposta

200 - Success
Restituisce la chiave del risultato inviato.

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

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

Corpo:

Name of the Scan

Risposta

200 - Success
Restituisce il riepilogo dei risultati 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"
}

Update a Scan's Tag(s)

Aggiorna i tag di una scansione come mostrato nella dashboard con i tag specificati.

Richiesta

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

Tasto Valore
X-Api-Key LA_TUA_CHIAVE_API
Content-Type application/json

Corpo:

["Example Tag"]

Risposta

200 - Success
Restituisce la chiave del risultato aggiornato.

Esempio JSON 


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

Elimina una scansione

Rimuove il risultato di una scansione dalla dashboard.

Richiesta

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

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

Risposta

200 - Success
Restituisce la chiave del risultato eliminato.

Esempio JSON 


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

Is this page helpful?

Help us improve this page

Still need help?