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

De axe DevTools Mobile API (Application Program Interface) is georganiseerd rond Representational State Transfer, vaak aangeduid als REST.

Maak gebruik van onze API en krijg volledige controle over de workflow van je team bij toegankelijkheidstesten.

Ga naar:

important

Referenties naar {{result_userid}}, {{result_package}}, of {{result_id}} kunnen gevonden worden binnen AxeDevToolsResultKey objecten van axe DevTools Mobile nadat een scan is voltooid.

Authenticatie

Om te beginnen, kopieer of maak een nieuwe API-sleutel aan op axe.deque.com/settings.

Voor elk verzoek voeg je je API-sleutel toe aan de header:

Sleutel Waarde
X-Api-Key YOUR_API_KEY

Scanoverzichten

Haalt een samengevatte lijst van resultaten van de server op.

Verzoek

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

Sleutel Waarde
X-Api-Key YOUR_API_KEY
Content-Type application/json

Antwoord

200 - Success
Retourneert een array met samenvattingen van de resultaten.

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

Gefilterde Scan Samenvattingen

Haalt een samengevatte lijst van resultaten van de server op die overeenkomen met de gespecificeerde criteria.

Verzoek

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

Sleutel Waarde
X-Api-Key YOUR_API_KEY
Content-Type application/json

Query Parameters:

Sleutel Waarde
userId String
os String
tags String (Komma Gescheiden)
pakketNaam String

Antwoord

200 - Success
Geeft een array van resultaten-samenvattingen terug.

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

Een Scan Ophalen

Geeft een specifiek scanresultaat van het dashboard terug.

Verzoek

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

Sleutel Waarde
X-Api-Key YOUR_API_KEY
Content-Type application/json

Antwoord

200 - Success
Geeft een scanresultaat terug.

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

Een Scan Indienen

Uploadt een scanresultaat naar het dashboard.

Verzoek

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

Sleutel Waarde
X-Api-Key YOUR_API_KEY
Content-Type application/json

Body:
JSON van iOS- of Android-scan.

Antwoord

200 - Success
Geeft de resultaatsleutel van het ingediende resultaat terug.

Example JSON 


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

Naam van een Scan Bijwerken

Werkt de naam van een scan bij zoals weergegeven in het dashboard.

Aanvraag

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

Sleutel Waarde
X-Api-Key YOUR_API_KEY
Content-Type application/json

Body:

Name of the Scan

Antwoord

200 - Success
Geeft de samenvatting van het scanresultaat terug.

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

Tags van een Scan Bijwerken

Werkt de tags van een scan bij in het dashboard naar de opgegeven tags.

Aanvraag

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

Sleutel Waarde
X-Api-Key YOUR_API_KEY
Content-Type application/json

Body:

["Example Tag"]

Antwoord

200 - Success
Geeft de resultaatsleutel van het bijgewerkte resultaat terug.

Example JSON 


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

Een Scan Verwijderen

Verwijdert een scanresultaat uit het dashboard.

Aanvraag

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

Sleutel Waarde
X-Api-Key YOUR_API_KEY
Content-Type application/json

Antwoord

200 - Success
Geeft de resultaatsleutel van het verwijderde resultaat terug.

Voorbeeld JSON 


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

Is this page helpful?

Help us improve this page

Still need help?