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

A API do axe DevTools Mobile (Interface de Programação de Aplicações) é organizada em torno da Transferência de Estado Representacional, frequentemente referida como REST.

Utilize nossa API e tenha controle total sobre o fluxo de trabalho de sua equipe nos testes de acessibilidade.

Ir para:

important

Referências a {{result_userid}}, {{result_package}} ou {{result_id}} podem ser encontradas dentro dos AxeDevToolsResultKey objetos do axe DevTools Mobile após a conclusão de um scan.

Autenticação

Para começar, copie ou crie uma nova chave de API em axe.deque.com/settings.

Para qualquer requisição, adicione sua chave de API ao cabeçalho:

Chave Valor
X-Api-Key SUA_CHAVE_DE_API

Resumo de Scans

Recupera uma lista resumida de resultados do servidor.

Requisição

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
Cabeçalhos:

Chave Valor
X-Api-Key SUA_CHAVE_DE_API
Content-Type application/json

Resposta

200 - Success
Retorna um array de resumos de resultados.

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

Resumos de Escaneamento Filtrados

Recupera uma lista resumida de resultados do servidor que correspondem aos critérios especificados.

Requisição

GET
URL: https://axe-mobile-backend.deque.com/attest/results/summaries
Cabeçalhos:

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

Parâmetros de Consulta:

Chave Valor
userId String
os String
tags String (Separação por Vírgula)
packageName String

Resposta

200 - Success
Retorna um array de resumos de resultados.

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

Buscar um Escaneamento

Retorna um resultado de escaneamento específico do painel de controle.

Requisição

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

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

Resposta

200 - Success
Retorna um resultado de escaneamento.

Exemplo de 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
}

Enviar um Escaneamento

Faz o upload de um resultado de escaneamento para o painel de controle.

Requisição

POST
URL: https://axe-mobile-backend.deque.com/attest/result/axe
Cabeçalhos:

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

Corpo:
JSON de varredura do iOS ou Android.

Resposta

200 - Success
Retorna a chave de resultado do resultado submetido.

Example JSON 


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

Atualizar o Nome de uma Varredura

Atualiza o nome de uma varredura conforme mostrado no painel de controle.

Solicitação

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

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

Corpo:

Name of the Scan

Resposta

200 - Success
Retorna o resumo do resultado da varredura.

JSON de Exemplo 


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

Atualizar Tag(s) de uma Varredura

Atualiza as tags de uma varredura, conforme mostrado no painel de controle, para as tags especificadas.

Solicitação

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

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

Corpo:

["Example Tag"]

Resposta

200 - Success
Retorna a chave de resultado do resultado atualizado.

Example JSON 


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

Excluir uma Varredura

Remove um resultado de varredura do painel de controle.

Solicitação

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

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

Resposta

200 - Success
Retorna a chave de resultado do resultado excluído.

JSON de Exemplo 


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

Is this page helpful?

Help us improve this page

Still need help?