API-Referenz

Vollständige REST-API-Dokumentation. Alle Endpunkte geben JSON zurück. Dashboard-APIs nutzen Session-Cookies; CI/CD-APIs nutzen API-Schlüssel.

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.

ParameterTypErforderlichBeschreibung
urlstringJaWebsite-URL (muss der registrierten Website entsprechen)
thresholdnumberNeinMindest-Score zum Bestehen (0–100)
waitbooleanNeinBlockiert bis zum Abschluss (max. 5 Min.)
max_pagesnumberNeinÜberschreibt das Seitenlimit

GET /api/v1/scan?id={scanId}

Scan-Status und -Ergebnisse abfragen.

API-Schlüssel

MethodeEndpunktBeschreibung
GET/api/api-keysSchlüssel auflisten (Hashes verborgen)
POST/api/api-keysSchlüssel erstellen (vollständiger Schlüssel einmal angezeigt)
DELETE/api/api-keys?id={id}Schlüssel widerrufen

Websites

MethodeEndpunktBeschreibung
GET/api/sitesAlle Websites auflisten
POST/api/sitesWebsite hinzufügen
GET/api/sites/{id}Website-Details abrufen
PATCH/api/sites/{id}Website aktualisieren
DELETE/api/sites/{id}Website entfernen
POST/api/sites/{id}/verifyEigentum verifizieren

Scans

MethodeEndpunktBeschreibung
GET/api/scansScan-Jobs auflisten
POST/api/scansManuellen Scan auslösen
GET/api/scans/{id}Scan-Details
GET/api/scans/{id}/pagesErgebnisse pro Seite

Verstöße

MethodeEndpunktBeschreibung
GET/api/violationsVerstöße auflisten (filterbar)
GET/api/violations/{id}Verstoß-Details (inkl. Screenshots, Workflow-Status)
PATCH/api/violations/{id}Status aktualisieren (open, in progress, resolved, suppressed, accepted exception), Zuständigen festlegen oder einen Unterdrückungs-/Ausnahmegrund anhängen
POST/api/violations/{id}/fixKI-Fix-Vorschlag generieren
GET/api/violations/{id}/commentsKommentare zu einem Verstoß auflisten
POST/api/violations/{id}/commentsKommentar hinzufügen
GET/api/violations/{id}/eventsWorkflow-Ereignisverlauf abrufen
GET/api/export/ai-instructionsKI-Fix-Anweisungen herunterladen (Markdown)

Berichte

MethodeEndpunktBeschreibung
GET/api/vpatsVPATs auflisten
POST/api/vpatsVPAT generieren
GET/api/vpats/{id}VPAT-Details
GET/api/vpats/{id}/pdfVPAT als PDF herunterladen
POST/api/statementsBarrierefreiheitserklärung veröffentlichen
POST/api/certificatesKonformitätszertifikat generieren

Teilen

MethodeEndpunktBeschreibung
POST/api/shared-reportsEinen teilbaren Berichtslink erstellen (30-tägiger Ablauf)
GET/api/shared-reportsAktive geteilte Links für eine Website auflisten
DELETE/api/shared-reports?id={id}Einen geteilten Link widerrufen

Organisationen

MethodeEndpunktBeschreibung
GET/api/organizationsIhre Organisationen auflisten
POST/api/organizationsEine Organisation erstellen
POST/api/organizations/switchAktive Organisation wechseln
POST/api/organizations/leaveEine Organisation verlassen
POST/api/organizations/transferEigentümerschaft übertragen
POST/api/organizations/deleteOrganisation löschen (Owner, E-Mail-verifiziert)

Team & Einstellungen

MethodeEndpunktBeschreibung
GET/api/teamMitglieder auflisten
POST/api/teamMitglied einladen
DELETE/api/team?id={id}Mitglied entfernen
GET/api/audit-logAudit-Log einsehen (Admin/Owner)
GET/api/settingsOrganisationseinstellungen abrufen
PATCH/api/settingsOrganisationseinstellungen 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.

Nutzer

MethodeEndpunktBeschreibung
POST/api/user/avatarProfil-Avatar hochladen
DELETE/api/user/avatarProfil-Avatar entfernen
GET/api/user/notification-prefsBenachrichtigungseinstellungen abrufen
PATCH/api/user/notification-prefsBenachrichtigungseinstellungen aktualisieren