API de 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

La API de axe DevTools Mobile está organizada en torno a la transferencia de estado representacional, a menudo denominada REST.

Utilice nuestra API y controle completamente el flujo de trabajo de su equipo en las pruebas de accesibilidad.

Saltar a:

important

Se pueden encontrar referencias a [palabra] {{result_userid}}, [palabra] {{result_package}}, o [palabra] {{result_id}} dentro de los objetos AxeDevToolsResultKey de axe DevTools Mobile después de que se complete un escaneo.

Autenticación

Para comenzar, copie o cree una nueva clave API en axe.deque.com/settings.

Para cualquier solicitud, agregue su clave API al encabezado:

Tecla Valor
X-Api-Key YOUR_API_KEY

Resúmenes de escaneo

Recupera una lista resumida de resultados del servidor.

Petición

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

Tecla Valor
X-Api-Key YOUR_API_KEY
Content-Type application/json

Respuesta

200 - Éxito
Devuelve un array de resúmenes de resultados.

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

Resúmenes de escaneo filtrados

Recupera una lista resumida de resultados del servidor que coinciden con los criterios especificados.

Petición

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

Tecla Valor
X-Api-Key YOUR_API_KEY
Content-Type application/json

Parámetros de consulta:

Tecla Valor
ID de usuario Cadena
os Cadena
etiquetas Cadena (separada por comas)
packageName Cadena

Respuesta

200 - Éxito
Devuelve un array de resúmenes de resultados.

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

Recuperar un escaneo

Devuelve un resultado de escaneo específico del panel de control.

Petición

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

Tecla Valor
X-Api-Key YOUR_API_KEY
Content-Type application/json

Respuesta

200 - Éxito
Devuelve un resultado de escaneo.

Ejemplo JSON

Nota: `axeView` contendrá diferentes propiedades específicas de la plataforma para un escaneo de 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
}

Enviar una exploración

Sube un resultado de escaneo al panel de control.

Petición

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

Tecla Valor
X-Api-Key YOUR_API_KEY
Content-Type application/json

Cuerpo:
JSON de escaneo de iOS o Android.

Respuesta

200 - Éxito
Devuelve la clave de resultado del resultado enviado.

Ejemplo JSON 


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

Actualizar el nombre de un Análisis

Actualiza el nombre de un Análisis como se muestra en el panel de control.

Petición

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

Tecla Valor
X-Api-Key YOUR_API_KEY
Content-Type application/json

Cuerpo:

Name of the Scan

Respuesta

200 - Éxito
Devuelve el resumen del resultado del escaneo.

Ejemplo 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)

Actualiza las etiquetas de un escaneo como se muestran en el panel de control a las etiquetas especificadas.

Petición

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

Tecla Valor
X-Api-Key YOUR_API_KEY
Content-Type application/json

Cuerpo:

["Example Tag"]

Respuesta

200 - Éxito
Devuelve la clave del resultado actualizado.

Ejemplo JSON 


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

Eliminar un escaneo

Elimina un resultado de escaneo del panel de control.

Petición

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

Tecla Valor
X-Api-Key YOUR_API_KEY
Content-Type application/json

Respuesta

200 - Éxito
Devuelve la clave de resultado del resultado eliminado.

Ejemplo JSON 


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

Is this page helpful?

Help us improve this page

Still need help?