API-Dokumentation

Starte Website-Checks und hole Reports programmatisch. Ideal für CI-Pipelines und eigene Tools.

Authentifizierung

Erzeuge im Konto-Bereich einen API-Key und sende ihn als Bearer-Token: „Authorization: Bearer xck_…“. Jeder Key gehört zu deinem Konto; Scans laufen im Kontext deiner Organisation.

Schnellstart

Einen Scan starten (Antwort 202 mit einer Job-Id):

curl -X POST https://xcheck.dev/api/v1/scans \
  -H "Authorization: Bearer xck_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/","wcag":"2.2-AA"}'

Status abfragen (queued/running/done/failed); bei „done“ enthält die Antwort die reportId:

curl https://xcheck.dev/api/v1/scans/SCAN_ID \
  -H "Authorization: Bearer xck_YOUR_KEY"

Den fertigen Report als JSON holen:

curl https://xcheck.dev/api/v1/reports/REPORT_ID \
  -H "Authorization: Bearer xck_YOUR_KEY"

Fehlercodes

401 unauthorized API-Key fehlt oder ist ungültig.
403 org_limit Das monatliche Scan-Limit der Organisation ist erreicht.
404 not_found Scan/Report nicht gefunden oder kein Zugriff.
429 rate_limited Rate-Limit erreicht. Der „Retry-After“-Header nennt die Wartezeit in Sekunden.

Standard-Rate-Limit: 30 Scans pro Stunde je Key-Inhaber. Fehler kommen immer mit den Feldern error.code und error.message.

OpenAPI-Spec

Die vollständige, maschinenlesbare Spezifikation liegt unter https://xcheck.dev/api/v1/openapi.json