BreakPilot Developer Portal

Base URL

Alle API-Endpunkte sind unter folgender Basis-URL erreichbar:

https://api.breakpilot.io/sdk/v1

Für Self-Hosted-Installationen verwenden Sie Ihre eigene Domain.

API Exposure

Jeder Endpoint ist mit einer Exposure-Kategorie gekennzeichnet:OeffentlichInternet-exponiert,IntegrationAPI-Key-authentifiziert,Internnur Admin-Dashboard,Wartungnur Setup.

Authentifizierung

Alle API-Anfragen erfordern einen gültigen API Key im Header:

Authorization: Bearer YOUR_API_KEY

Tenant-ID

Die Tenant-ID wird aus dem API Key abgeleitet oder kann explizit als Query-Parameter oder im Request-Body mitgegeben werden.

API Endpoints

State Management Intern

Verwalten Sie den SDK-State für Ihren Tenant.

GET/state/{tenantId}

Lädt den aktuellen SDK-State für einen Tenant

POST/state

Speichert den SDK-State (mit Versionierung)

DELETE/state/{tenantId}

Löscht den State für einen Tenant

→ Vollständige State API Dokumentation

RAG Search Integration

Durchsuchen Sie den Compliance-Korpus (DSGVO, AI Act, NIS2).

GET/rag/search

Semantische Suche im Legal Corpus

GET/rag/status

Status des RAG-Systems und Corpus-Informationen

→ Vollständige RAG API Dokumentation

Document Generation Intern

Generieren Sie Compliance-Dokumente automatisch.

POST/generate/dsfa

Generiert eine Datenschutz-Folgenabschätzung

POST/generate/tom

Generiert technische und organisatorische Maßnahmen

POST/generate/vvt

Generiert ein Verarbeitungsverzeichnis

→ Vollständige Generation API Dokumentation

Export Intern

Exportieren Sie den Compliance-Stand in verschiedenen Formaten.

GET/export

Exportiert den State (JSON, PDF, ZIP)

→ Vollständige Export API Dokumentation

Consent Management Oeffentlich

Verwalten Sie Einwilligungen, rechtliche Dokumente und Cookie-Banner-Konfigurationen.

GET/einwilligungen/consents

Consent-Liste mit Pagination und Filtern

POST/einwilligungen/consents

Neue Einwilligung erfassen

PUT/einwilligungen/consents/{id}/revoke

Einwilligung widerrufen

GET/einwilligungen/consents/{id}/history

Änderungshistorie einer Einwilligung

→ Vollständige Consent Management API Dokumentation

DSFA — Datenschutz-Folgenabschätzung Intern

Verwalten Sie Datenschutz-Folgenabschätzungen gemäß Art. 35 DSGVO mit vollständigem Audit-Trail, Status-Workflow und Risikobewertung.

GET/dsfa

Liste aller DSFAs (Filter: status, risk_level)

POST/dsfa

Neue DSFA anlegen → 201

GET/dsfa/stats

Statistiken nach Status und Risiko

GET/dsfa/audit-log

Audit-Trail aller Aktionen

GET/dsfa/{id}

Einzelne DSFA abrufen

PUT/dsfa/{id}

DSFA aktualisieren

DELETE/dsfa/{id}

DSFA löschen (Art. 17 DSGVO)

PATCH/dsfa/{id}/status

Schnell-Statuswechsel

→ Vollständige DSFA API Dokumentation

Response Format

Alle Responses folgen einem einheitlichen Format:

Erfolgreiche Response

{ "success": true, "data": { ... }, "meta": { "version": 1, "timestamp": "2026-02-04T12:00:00Z" } }

Fehler Response

{ "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Tenant ID is required", "details": { ... } } }

Error Codes

HTTP Status	Code	Beschreibung
400	VALIDATION_ERROR	Ungültige Request-Daten
401	UNAUTHORIZED	Fehlender oder ungültiger API Key
403	FORBIDDEN	Keine Berechtigung für diese Ressource
404	NOT_FOUND	Ressource nicht gefunden
409	CONFLICT	Versions-Konflikt (Optimistic Locking)
429	RATE_LIMITED	Zu viele Anfragen
500	INTERNAL_ERROR	Interner Server-Fehler

Rate Limits

Plan	Requests/Minute	Requests/Tag
Starter	60	10.000
Professional	300	100.000
Enterprise	Unbegrenzt	Unbegrenzt

API Reference