Integrations & API
REST API overview, authentication, rate limits, and links to endpoint references.
Overview
The Ablelytics REST API lets you integrate accessibility scanning into CI/CD pipelines, internal tooling, and third-party platforms.
All endpoints are served from api.ablelytics.com and follow predictable REST conventions with JSON request and response bodies.
Base URL
All v1 endpoints are prefixed with:
https://api.ablelytics.com/v1Authentication
Every protected endpoint requires an API key sent as the x-api-key request header. Generate your key from Workspace → API Settings.
- Invalid or missing key → 401 Unauthorized
- Valid key but plan without API access → 403 Forbidden
- API access is available on the Starter plan and above.
x-api-key: YOUR_API_KEYRate Limits
Each subscription has a daily API call limit. When exceeded the API returns 429 with these headers:
- X-RateLimit-Limit — your plan's daily call limit
- X-RateLimit-Remaining — calls remaining today
- Retry-After — seconds until the counter resets at midnight UTC
Async Operations
Scans and page collection are long-running. These endpoints return 202 Accepted with a runId immediately.
Poll GET /v1/runs/:runId every 5–10 seconds until status is done or failed.
CI/CD tip
See the CI/CD Integration guide for a complete GitHub Actions workflow example.
Endpoint Reference
- Auth and Health → /docs/api-auth-and-health
- Projects → /docs/api-projects
- Pages and Collection → /docs/api-pages-and-collection
- Page Sets → /docs/api-page-sets
- Scans and Issues → /docs/api-scans-and-issues
- Reports → /docs/api-reports
- Runs (polling) → /docs/api-runs
- Pagination Guide → /docs/api-pagination
- Error Reference → /docs/api-errors
- CI/CD Integration → /docs/api-ci-cd