Integrate the Level Access Public API to interact with platform functionalities. This API, documented using Swagger, allows for seamless integration with automated scans, workspace management, user data, and manual evaluations.
On this page:
Access your organization
To access your organization’s API documentation via Swagger:
- Go to https://petstore.swagger.io/
- Enter your organization's API URL. For example, https://<your-organization>.hub.essentia11y.com/api/v1/swagger
- Select Explore.
API Capabilities
The API enables several key functionalities for accessibility testing and management:
Push raw results
Push raw results to the platform by sending accessibility test results programmatically, teams can streamline data submission and enhance workflow automation.
Run automated scans
Run automated scans using the API to facilitate continuous monitoring of digital assets for accessibility issues without manual intervention. This capability is key for integrating accessibility checks into CI/CD pipelines.
Get rules definition
Retrieve rules definitions via a comprehensive list of accessibility rules for various tools through the API. This ensures that developers are always working with up-to-date standards and can tailor their testing accordingly.
Get scan info
Pull detailed information and results from past scans. This helps track progress over time and allows easy reporting of accessibility compliance.
Endpoint:
/api/v1/public/digital-properties/{digitalPropertyId}/scans/{scanId}/scan-results
The scannedPages array includes enriched details for deeper page-level analysis.
The fields include:
| Field | Type | Description |
|---|---|---|
| url | string | The URL of the scanned page |
| pageTitle | string | The title of the scanned page |
| pageScore | number | A numerical score of the page |
| resolved | number | Number of flaws present in the previous scan but missing in the current one |
| findings | object | A breakdown of findings by severity |
Findings object details:
| Field | Type | Description |
|---|---|---|
| critical | number | Count of critical findings |
| high | number | Count of high findings |
| low | number | Count of low findings |
Get digital asset metrics
Retrieves digital asset metrics including the risk score and the following finding data:
- All findings
- Resolved findings
- Percentage resolved
- Unresolved findings by severity
- Default policy overdue findings by severity
- User policy overdue findings by severity
Get manual evaluations
Retrieve manual evaluation data using the API, centralizing both automated and manual testing information in one location.
Get workspace data
The API provides access to workspace data, including digital assets and associated tags. This supports better organization and classification of the assets being evaluated for accessibility.
Get user data
Developers can retrieve and manage user data through the API, making it easier to control permissions and roles within the platform.
Comments
0 comments
Article is closed for comments.