API Referenz

Integrieren Sie sich mit der Conzent Consent Management Plattform. Diese Endpunkte steuern das Einwilligungsbanner, die geolokalisierte Zielgruppenansprache, die Protokollierung der Einwilligungsprüfung und das Scannen von Cookies.

Alle Endpunkte sind relativ zu Ihrer selbst gehosteten Conzent-Instanz. Ersetzen Sie die Basis-URL durch Ihre tatsächliche Domain.

Authentifizierung

Die meisten Endpunkte sind öffentlich — sie werden vom Skript des Einwilligungsbanners auf den Browsern Ihrer Besucher aufgerufen.

Endpunkte, die Daten akzeptieren, verwenden einen Website-Schlüssel, um zu identifizieren, zu welcher Website die Anfrage gehört. Finden Sie Ihren Website-Schlüssel im Conzent-Dashboard unter Websites.

Antwortformat

API-Antworten verwenden zwei Formate, abhängig vom Endpunkt:

Standardantwort

Verwendet von Gesundheitscheck und Scan Webhook.

{
  "success": true,
  "data": {
    "status": "ok"
  }
}

Leichtgewichtige Antwort

Verwendet von Beacon-Endpunkten (Seitenaufruf, Einwilligung, Scandaten) für minimalen Overhead.

{
  "status": "ok"
}

Gesundheitscheck

Gibt den Gesundheitsstatus der Anwendung und der unterstützenden Dienste zurück. Verwenden Sie ihn zur Überwachung, für Lastenausgleichsprüfungen und Docker-Gesundheitsprüfungen.

Antwort

{
  "success": true,
  "data": {
    "status": "ok",
    "services": {
      "database": true,
      "redis": true
    },
    "environment": "production",
    "timestamp": "2026-03-16T12:00:00+00:00"
  }
}

{
  "success": true,
  "data": {
    "status": "degraded",
    "services": {
      "database": true,
      "redis": false
    }
  }
}

Beispiel

curl https://your-instance.example.com/health

Geolokalisierung

Gibt den Ländercode des Besuchers und den EU-Mitgliedsstatus zurück. Wird vom Einwilligungsskript verwendet, um geozielte Vorschriften anzuwenden (GDPR, CCPA).

Antwortfelder

Antwort

{
  "country": "dk",
  "in_eu": true
}

Beispiel

curl https://your-instance.example.com/api/v1/geo_ip

Seitenaufruf Beacon

Protokolliert Seitenaufrufe und Bannerladeereignisse. Wird über navigator.sendBeacon() als multipart/form-data gesendet. Erhöht den täglichen Seitenaufrufzähler und puffert Cookie-Beobachtungen für die asynchrone Verarbeitung.

Anfragekörper multipart/form-data

Antwort

{
  "status": "ok"
}

Beispiel

curl -X POST https://your-instance.example.com/api/v1/log \
  -F "key=YOUR_WEBSITE_KEY" \
  -F "request_type=banner_load" \
  -F "log_time=$(date +%s)"

Einwilligungsprotokoll

Protokolliert die GDPR-Einwilligungsprüfung, wenn ein Besucher die Einwilligung akzeptiert, ablehnt oder anpasst. Dies ist der primäre Compliance-Endpunkt.

Anfragekörper multipart/form-data

Antwort

{
  "status": "ok"
}

Beispiel

curl -X POST https://your-instance.example.com/api/v1/consent \
  -F "key=YOUR_WEBSITE_KEY" \
  -F "conzent_id=a1b2c3d4e5f6..." \
  -F 'log=[{"category":"analytics","consented":true}]' \
  -F "consented_domain=example.com" \
  -F "language=en" \
  -F "country=dk"

Scan-Daten Beacon

Empfängt client-seitige Cookie-Scandaten. Das Einwilligungsskript erkennt Cookies im Browser des Besuchers und meldet sie zur automatischen Kategorisierung. Daten werden in Redis gepuffert und asynchron verarbeitet.

Anfragekörper multipart/form-data

Payload-Struktur

{
  "scan_id": 123,
  "action": "runscan",
  "scan_url": "https://example.com/",
  "consent_phase": "pre_consent",
  "data": {
    "cookies": [
      { "name": "_ga", "domain": ".example.com" }
    ]
  }
}

Antwort

{
  "status": "ok"
}

Beispiel

curl -X POST https://your-instance.example.com/api/v1/scan_data \
  -F "key=YOUR_WEBSITE_KEY" \
  -F 'payload={"scan_id":123,"action":"runscan","scan_url":"https://example.com/"}'

Scanner Webhook

Empfängt Scanergebnisse von externen Scanner-Servern, wenn ein Cookie-Scan abgeschlossen ist. Authentifiziert über den X-Api-Key Header, der mit der SCANNER_WEBHOOK_SECRET Umgebungsvariable übereinstimmen muss.

Header

Anfragekörper application/json

Antwort

{
  "success": true,
  "data": {
    "status": "processed"
  }
}

Fehler

{
  "success": false,
  "error": "Unauthorized"
}

Beispiel

curl -X POST https://your-instance.example.com/api/v1/scan-webhook \
  -H "X-Api-Key: YOUR_SCANNER_WEBHOOK_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "webhook",
    "scan_id": 456,
    "scan_url": "https://example.com/",
    "data": {
      "cookies": [
        {"name": "_ga", "domain": ".example.com", "category": "analytics"}
      ]
    }
  }'