ConsentGuard Dokumentation

Alles, was Sie brauchen, um das automatisierte Compliance-Monitoring von ConsentGuard in Ihren Workflow zu integrieren.

Schnellstart

Willkommen bei der ConsentGuard API. Unsere RESTful API ermöglicht es Ihnen, Ihre überwachten Websites programmatisch zu verwalten, On-Demand-Scans auszulösen und Echtzeit-Warnungen über Webhooks zu erhalten.

curl -X GET https://api.consentguard.de/v1/ping \
-H "Authorization: Bearer IHR_API_SCHLÜSSEL"

Authentifizierung

Authentifizieren Sie Ihre API-Anfragen, indem Sie Ihren API-Schlüssel im Authorization Header einschließen. Sie können Ihre API-Schlüssel im Bereich Einstellungen > Erweitert Ihres Dashboards generieren und verwalten.

Sicherheitshinweis: Bewahren Sie Ihre API-Schlüssel sicher auf. Setzen Sie sie nicht im clientseitigen Code (wie Frontend-JavaScript) ein.

Websites API

Verwalten Sie die Websites, die Sie überwachen möchten.

Alle Websites auflisten

GET /v1/sites

Gibt eine paginierte Liste aller Websites zurück, die derzeit in Ihrem Konto für die Überwachung konfiguriert sind.

Eine neue Website hinzufügen

POST /v1/sites

Die Payload sollte die url und optionale tags zur Kategorisierung enthalten.

Scans API

Lösen Sie automatisierte Compliance-Scans aus und rufen Sie die Ergebnisse ab.

Manuellen Scan auslösen

POST /v1/sites/{site_id}/scans

Initiiert einen sofortigen Scan der angegebenen Website. Gibt eine scan_id zurück, die zur Überprüfung des Status verwendet werden kann.

Webhooks

Konfigurieren Sie Webhooks, um Echtzeit-HTTP-POST-Payloads zu erhalten, wenn bestimmte Ereignisse in ConsentGuard auftreten. Zu den Ereignissen gehören scan.completed, scan.failed und compliance.violation_detected.

Alle Webhook-Payloads sind mit einer kryptografischen Signatur im X-ConsentGuard-Signature Header versehen. Wir empfehlen dringend, diese Signaturen zu überprüfen, um sicherzustellen, dass die Anfragen von uns stammen.