Entwickler

API-Referenz

Alle API-Endpunkte erfordern eine gültige Sitzung. Senden Sie Ihr Sitzungs-Cookie mit jeder Anfrage oder verwenden Sie den API-Schlüssel Ihrer Organisation, sofern eine tokenbasierte Authentifizierung eingerichtet ist. Jede Antwort liefert { data } bei Erfolg und { error: string } bei einem Fehler.

Basis-URL: https://www.kodex-compliance.com

Scan-API

Scan-API

POST/api/scan

Einen Compliance-Scan starten.

Body

  • frameworkId | frameworkIds[]Ein Framework oder bis zu 10 für einen Sammel-Scan.
  • projectId(optional) Den Scan auf ein bestimmtes Projekt begrenzen.
  • questionnaire(optional) Schlüssel-Wert-Antworten zum Vorbefüllen des Fragebogens.
  • githubRepo(optional) GitHub-Repository im Format owner/repo.

Antwort

{ scanId, scanIds, message }

Ratenbegrenzung pro Organisation. Planabhängige Scan-Limits werden durchgesetzt.

GET/api/scan

Abgeschlossene Scans der authentifizierten Organisation auflisten.

Query

  • projectId(optional) Nach Projekt filtern.

Antwort

Array von Scan-Zusammenfassungen, bei Multi-Framework-Scans nach batchId gruppiert. Liefert die letzten 10 Einträge.
GET/api/scan/[scanId]

Vollständige Scan-Details: Status, Bericht, Kontrollergebnisse, Shadow Pass, Nachweisquellen.

GET/api/scan/status/[scanId]

Schlanke Statusabfrage für Polling.

Antwort

{ status, progressPct, pendingClarification }
GET/api/scan/[scanId]/events

Seitenweiser Ereignis-Feed aus dem Scan-Ereignisprotokoll.

Query

  • limitAnzahl der zurückzugebenden Ereignisse.
  • offsetVersatz für die Seitenaufteilung.
GET/api/scan/[scanId]/pdf

PDF-Bericht für ein einzelnes Framework herunterladen.

GET/api/scan/batch-pdf

Zusammengefassten PDF-Bericht für einen Multi-Framework-Sammel-Scan herunterladen.

Query

  • scanIdsKommagetrennte Liste von Scan-IDs (2–20).

Ratenbegrenzung pro Benutzer.

POST/api/scan/[scanId]/cancel

Einen laufenden oder eingereihten Scan abbrechen. Bricht auch zugehörige Scans desselben Sammel-Scans ab.

POST/api/scan/[scanId]/clarify

Eine Rückfrage beantworten, während der Scan darauf wartet.

Body

  • answerAntwort als Klartext, 1–10.000 Zeichen.

Schreibt in die Datenbank und nach Redis und reiht den Worker anschließend erneut ein.

Integrations-API

Integrations-API

GET/api/integrations/status

Alle Integrationen der authentifizierten Organisation mit Verbindungsstatus und Überwachungskonfiguration auflisten.

DELETE/api/integrations/status

Eine Integration trennen. Widerruft das Anbieter-Token, entfernt Überwachungszeitpläne und löscht die verschlüsselte Konfiguration.

GET/api/integrations/monitoring

Überwachungsstatus für alle Integrationen.

PATCH/api/integrations/monitoring

Kontinuierliche Überwachung für eine Integration ein- oder ausschalten. Nur im BUSINESS-Plan.

Body

  • typeKennung des Integrationstyps.
  • enabledtrue zum Aktivieren, false zum Deaktivieren.
  • schedule(optional) DAILY | WEEKLY | MONTHLY | ON_PUSH | CUSTOM.
  • customCron(optional) Cron-Ausdruck, wenn schedule CUSTOM ist.
  • githubRepo(optional) Repository für den ON_PUSH-Zeitplan.