API für Entwickler

Ab dem Business-Tarif können Sie ComplianceScan programmatisch über die REST-API nutzen — z. B. für CI/CD-Pipelines, Dashboards oder automatisierte Compliance-Prüfungen.

Zuletzt aktualisiert: 2026-06-15

---

Inhaltsverzeichnis

1. API-Key erstellen
2. Erste Anfrage
3. Scan starten
4. Ergebnis abrufen
5. Rate-Limits
6. Fehler
7. Weiterführende Dokumentation

---

API-Key erstellen

1. Navigieren Sie zu Einstellungen → API-Keys
2. Klicken Sie auf Neuer Key
3. Geben Sie dem Key einen Namen (z. B. „CI/CD Pipeline")
4. Der Key wird einmalig angezeigt — kopieren und sicher speichern!

⚠️ Achtung: Der Key wird nur einmal angezeigt (Format: csk_live_…). Er kann nicht nachträglich abgerufen werden.

Key-Format

csk_live_a1b2c3d4e5f6…

• Der Prefix csk_live_ kennzeichnet den Key als ComplianceScan-API-Key.
• Auf dem Server wird der Key nur als Hash gespeichert.
• Verfügbare Berechtigungen (Scopes): scan:read und scan:write. Wählen Sie keine aus, erhält der Key beide. Details zur Authentifizierung finden Sie in der Authentifizierungs-Dokumentation.

---

Erste Anfrage

Testen Sie Ihren API-Key mit einer einfachen Anfrage. Beide Header-Varianten funktionieren:

# Variante A — Bearer
curl -H "Authorization: Bearer csk_live_IHR_KEY" \
     https://compliancescan.eu/api/v1/account

# Variante B — X-API-Key
curl -H "X-API-Key: csk_live_IHR_KEY" \
     https://compliancescan.eu/api/v1/account

Erwartete Antwort (Beispiel):

{
  "plan": "business",
  "email": "ihr-konto@example.com",
  "organization": { "id": 7, "name": "Beispiel GmbH" },
  "credits": { "remaining": 42 },
  "scans": {
    "running": 0,
    "pending": 1,
    "concurrency_limit": 2,
    "queue_limit": 50
  },
  "api_usage": { "requests_this_month": 128, "scans_this_month": 23 }
}

---

Scan starten

Hinweis: Die API führt ausschließlich Full-Scans aus. Setzen Sie type explizit auf "full" — andere Werte (auch ein fehlendes type) werden mit 400 INVALID_SCAN_TYPE abgelehnt. Quick-Scans sind nur über die Web-Oberfläche verfügbar.

curl -X POST \
     -H "Authorization: Bearer csk_live_IHR_KEY" \
     -H "Content-Type: application/json" \
     -d '{"url": "https://example.com", "type": "full", "maxPages": 10}' \
     https://compliancescan.eu/api/v1/scans

Der Aufruf wartet auf das Scan-Ergebnis und liefert es direkt zurück. maxPages ist optional und wird auf das Seitenlimit Ihres Tarifs begrenzt (siehe Abrechnung & Credits).

---

Ergebnis abrufen

Die Antwort von POST /api/v1/scans enthält bereits das vollständige Ergebnis. Frühere Scans rufen Sie über die ID ab:

# Einzelnen Scan abrufen
curl -H "Authorization: Bearer csk_live_IHR_KEY" \
     https://compliancescan.eu/api/v1/scans/42

# Alle Scans auflisten (paginiert)
curl -H "Authorization: Bearer csk_live_IHR_KEY" \
     "https://compliancescan.eu/api/v1/scans?limit=10&offset=0"

Scan-Ergebnis (Auszug)

{
  "id": 42,
  "url": "https://example.com/",
  "type": "full",
  "score": 72,
  "results": {
    "gdpr": { "score": 72, "privacy_policy": true, "cookie_banner": true },
    "trackers": { "count": 2, "list": [{ "name": "Google Analytics" }] },
    "cookies": {
      "count": 4,
      "list": [{ "name": "_ga", "category": "analytics" }]
    }
  }
}

---

Rate-Limits

Bei Überschreitung antwortet die API mit HTTP 429 und dem Header Retry-After (Sekunden bis zum nächsten erlaubten Versuch).

---

Fehler

Die vollständige Liste der Fehlercodes finden Sie in der Fehler-Referenz.

---

Weiterführende Dokumentation

• Schnelleinstieg (Quickstart) — erster Call in wenigen Minuten
• Vollständige API-Referenz — alle Endpunkte
• Fehler-Referenz — alle Fehlercodes
• Abrechnung & Credits — Tarife und Scan-Credits
• Scanning — Scanner-Features im Detail