Vollständige REST-API-Dokumentation. Alle Endpunkte geben JSON zurück. Dashboard-APIs nutzen Session-Cookies; CI/CD-APIs nutzen API-Schlüssel.
Business umfasst API-Schlüssel, CLI, authentifizierte MCP-Tools und CI/CD-Integration. Organisationsinhaber und Admins können Schlüssel erstellen. Free enthält keine API-Schlüssel; das öffentliche MCP-Tool scan_url bleibt ohne Schlüssel verfügbar.
Authentifizierung
Dashboard-APIs (/api/*)
Automatisch authentifiziert über das Supabase-Session-Cookie im Browser.
CI/CD-API (/api/v1/*)
Übergeben Sie Ihren API-Schlüssel per Header:
x-api-key: ap_live_abc123...
Oder äquivalent mit einem Bearer-Token:
Authorization: Bearer ap_live_abc123...
CI/CD-Scan
POST /api/v1/scan
Löst einen Barrierefreiheits-Scan aus CI/CD aus.
Parameter
Typ
Erforderlich
Beschreibung
url
string
Ja
Website-URL (muss der registrierten Website entsprechen)
threshold
number
Nein
Mindest-Score zum Bestehen (0–100)
wait
boolean
Nein
Blockiert bis zum Abschluss (max. 5 Min.)
max_pages
number
Nein
Überschreibt das Seitenlimit
GET /api/v1/scan?id={scanId}
Scan-Status und -Ergebnisse abfragen.
API-Schlüssel
Methode
Endpunkt
Beschreibung
GET
/api/api-keys
Schlüssel auflisten (Hashes verborgen)
POST
/api/api-keys
Schlüssel erstellen (vollständiger Schlüssel einmal angezeigt)
Status aktualisieren (open, in progress, resolved, suppressed, accepted exception), Zuständigen festlegen oder einen Unterdrückungs-/Ausnahmegrund anhängen
Einen teilbaren Berichtslink erstellen (30-tägiger Ablauf)
GET
/api/shared-reports
Aktive geteilte Links für eine Website auflisten
DELETE
/api/shared-reports?id={id}
Einen geteilten Link widerrufen
Organisationen
Methode
Endpunkt
Beschreibung
GET
/api/organizations
Ihre Organisationen auflisten
POST
/api/organizations
Eine Organisation erstellen
POST
/api/organizations/switch
Aktive Organisation wechseln
POST
/api/organizations/leave
Eine Organisation verlassen
POST
/api/organizations/transfer
Eigentümerschaft übertragen
POST
/api/organizations/delete
Organisation löschen (Owner, E-Mail-verifiziert)
Team & Einstellungen
Methode
Endpunkt
Beschreibung
GET
/api/team
Mitglieder auflisten
POST
/api/team
Mitglied einladen
DELETE
/api/team?id={id}
Mitglied entfernen
GET
/api/audit-log
Audit-Log einsehen (Admin/Owner)
GET
/api/settings
Organisationseinstellungen abrufen
PATCH
/api/settings
Organisationseinstellungen aktualisieren
Webhooks
Jede Organisation hat eine einzige ausgehende Webhook-URL und ein Signaturgeheimnis. Konfigurieren Sie beides mit PATCH /api/settings (Felder webhook_url und webhook_secret); die aktuelle Konfiguration mit GET /api/settings abrufen. Setzen Sie die URL auf eine leere Zeichenkette oder das Geheimnis auf leer, um die Zustellung zu deaktivieren. Siehe Webhooks für Payload-Struktur, unterstützte Ereignisse und Signaturverifikation.