„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

Die axe DevTools Mobile API (Application Program Interface) ist um den Representational State Transfer herum organisiert, der oft als REST bezeichnet wird.

Nutzen Sie unsere API und kontrollieren Sie den Workflow Ihres Teams beim Testen der Barrierefreiheit vollständig.

Springe zu:

important

Verweise auf {{result_userid}, {{result_package} oder {{result_id} können nach Abschluss eines Scans innerhalb von AxeDevToolsResultKey Objekten von axe DevTools Mobile gefunden werden.

Authentifizierung

Um zu beginnen, kopieren oder erstellen Sie einen neuen API-Schlüssel unter axe.deque.com/settings.

Fügen Sie bei jeder Anfrage Ihren API-Schlüssel zum Header hinzu:

Taste Wert
X-Api-Key YOUR_API_KEY

Scan-Zusammenfassungen

Ruft eine zusammengefasste Ergebnisliste vom Server ab.

Anfrage

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

Taste Wert
X-Api-Key YOUR_API_KEY
Content-Type application/json

Antwort

200 - Success
Gibt ein Array mit Ergebniszusammenfassungen zurück.

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

Gefilterte Scan-Zusammenfassungen

Ruft vom Server eine zusammengefasste Liste mit Ergebnissen ab, die den angegebenen Kriterien entsprechen.

Anfrage

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

Taste Wert
X-Api-Key YOUR_API_KEY
Content-Type Anwendung/Json

Abfrageparameter:

Taste Wert
userId Zeichenfolge
os Zeichenfolge
tags String (durch Komma getrennt)
packageName String

Antwort

200 - Success
Gibt ein Array mit Ergebniszusammenfassungen zurück.

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

Einen Scan abrufen

Gibt ein bestimmtes Scan-Ergebnis vom Dashboard zurück.

Anfrage

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

Taste Wert
X-Api-Key YOUR_API_KEY
Content-Type application/json

Antwort

200 - Success
Gibt ein Scan-Ergebnis zurück.

Beispiel-JSON

Hinweis: `axeView` enthält unterschiedliche plattformspezifische Eigenschaften für einen iOS- oder 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
}

Einen Scan senden

Lädt ein Scan-Ergebnis zum Dashboard hoch.

Anfrage

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

Taste Wert
X-Api-Key YOUR_API_KEY
Content-Type application/json

Body:
JSON vom iOS- oder Android-Scan.

Antwort

200 - Success
Gibt den Ergebnisschlüssel des übermittelten Ergebnisses zurück.

Beispiel-JSON 


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

Aktualisieren des Namens eines Scans

Aktualisiert den Namen eines Scans, wie im Dashboard angezeigt.

Anfrage

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

Taste Wert
X-Api-Key YOUR_API_KEY
Content-Type application/json

Body:

Name of the Scan

Antwort

200 - Success
Gibt die Zusammenfassung der Scan-Ergebnisse zurück.

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

Aktualisiert die Tags eines Scans, wie im Dashboard angezeigt, auf die angegebenen Tags.

Anfrage

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

Taste Wert
X-Api-Key YOUR_API_KEY
Content-Type application/json

Body:

["Example Tag"]

Antwort

200 - Success
Gibt den Ergebnisschlüssel des aktualisierten Ergebnisses zurück.

Beispiel-JSON 


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

Löschen eines Scans

Entfernt ein Scan-Ergebnis aus dem Dashboard.

Anfrage

LÖSCHEN
URL: https://axe-mobile-backend.deque.com/attest/result/{{result_userid}}/{{result_package}}/{{result_id}}
Kopfdaten:

Taste Wert
X-Api-Key YOUR_API_KEY
Content-Type application/json

Antwort

200 - Success
Gibt den Ergebnisschlüssel des gelöschten Ergebnisses zurück.

Beispiel-JSON 


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

Is this page helpful?

Help us improve this page

Still need help?