Platform API
Add accessibility checks to your platform
Your users check a site or a build from inside your product and see each failing element, where it is and how to fix it. They do not need a NormLedger account.
How it works
- Create a sandbox account and a test key.
- Create a workspace for each of your customers and add their sites.
- Start checks and read findings, or receive a signed webhook.
- Go live: add a payment method (a spending cap is optional).
Pricing
| Stage | Cost to you |
|---|---|
| Sandbox (testing, set-up, integration) | Free |
| First month live | First 1,000 live pages free in your first calendar month |
| Pages checked on live sites | EUR 0.02 per page; EUR 0.012 from page 100,001; EUR 0.008 from page 1,000,001 in the same month |
| Hosted accessibility statement | EUR 9 per site per month |
Invoiced monthly after use (totals under EUR 5 roll into the next month). You can set your own spending cap. Prices exclude VAT.
Quick start
curl -X POST https://api.normledger.com/v1/platform/workspaces \
-H "Authorization: Bearer nl_plat_test_..." \
-d '{"external_ref":"cust_42","name":"Acme shop","mode":"test"}'
curl -X POST https://api.normledger.com/v1/platform/sites/{id}/scans \
-H "Idempotency-Key: build-1287" -d '{"mode":"sample","release_ref":"v4.2"}'Endpoints
- POST /v1/platform/workspacesdevelopers.endpoint.workspaces.desc
- POST /v1/platform/sitesdevelopers.endpoint.sites.desc
- POST /v1/platform/sites/{id}/scansdevelopers.endpoint.scans.desc
- GET /v1/platform/findingsdevelopers.endpoint.findings.desc
- GET /v1/platform/changesdevelopers.endpoint.changes.desc
- GET /v1/platform/usagedevelopers.endpoint.usage.desc
Webhooks and signatures
Events: scan.completed, criteria.new_failures, statement.published. HMAC SHA-256 in X-NormLedger-Signature (sha256=...). Retries for 24 hours.
Limits
60 requests per minute per key. A monthly page quota per platform (raised on request). One full check per site per day; up to 20 sample checks.
Sandbox rules
Test keys scan fixture sites and domains you verify (DNS TXT normledger-verify=... or /.well-known/normledger.txt). Test results are never billed.