Einstieg / Übersicht

Übersicht

Die Redcheck-API startet Scans, verfolgt ihren Fortschritt und liefert Berichte. Sie ist dieselbe Schnittstelle, die auch die Web-App benutzt — es gibt keine zweite, privilegierte Variante.

Alle Feldtabellen und Beispiele in dieser Referenz werden aus contracts/openapi.yaml erzeugt. Was hier steht, steht so auch im Vertrag.

Basis-URL und Version

GEThttps://api.red-check.de/v1/health

Die Version steht im Pfad. Innerhalb von v1 kommen nur Felder hinzu, nie welche weg; auf neue Felder darf sich ein Client also einstellen, ohne dass ein Update ihn bricht.

Der kürzeste Weg

1. In der Web-App unter Einstellungen → API-Keys einen Schlüssel anlegen. Er wird genau einmal angezeigt.
2. Domain anlegen und verifizieren — siehe Domain verifizieren. Für rein passive Läufe genügt das Anlegen.
3. Scan starten und die zurückgegebene id merken.
4. Scan-Status abfragen, bis status auf done steht.
5. Artefakte abrufen — PDF, findings.json, Audit-Log.

Fehler

Jede Fehlerantwort hat denselben Körper. Schalten Sie an code, nie am Text: der Text ist für Menschen und darf sich ändern.

{
"code": "domain_not_verified",
"message": "Für aktive Prüfungen muss die Domain verifiziert sein.",
"details": {}
}

Die vollständige Liste der Codes steht bei den jeweiligen Aufrufen.

Grenzen

Jede Anfrage wirkt in genau einer Organisation — bei einem API-Schlüssel in der Organisation des Schlüssels. Es gibt keinen Parameter, mit dem sich das übersteuern ließe.