Die STOREDO REST-API
Automatisieren Sie Ihre Sicherheitsprüfungen — passend für CI/CD-Strecken, Monitoring-Systeme und eigene Integrationen.
Wie die API arbeitet
Scans laufen im Hintergrund; Sie erhalten eine Scan-Kennung und fragen damit den Status ab. Alternativ hinterlegen Sie eine Callback-Adresse und werden sofort benachrichtigt, sobald ein Scan abgeschlossen ist. Ergebnisse liefern wir als strukturiertes JSON oder als fertigen PDF-Bericht.
Die wichtigsten Endpunkte
Ein Endpunkt startet einen neuen Sicherheits-Scan, ein zweiter ruft Status und Ergebnisse einer Scan-Kennung ab. Dazu kommen das Auflisten aller überwachten Projekte und das Anlegen eines neuen Projekts zur Überwachung. Jede Funktion der Oberfläche ist damit auch programmatisch erreichbar; eine OpenAPI-Spezifikation steht bereit.
Authentifizierung und Grenzen
Zugriff wahlweise per JWT oder API-Schlüssel im Header, mit Rechteumfang je Schlüssel — lesend, schreibend oder administrativ. Das Anfragelimit ist bewusst großzügig: 100 Anfragen je Minute im kostenlosen Konto, 1.000 je Minute in den Profi-Tarifen.
Hinweise zum sicheren Einsatz
Legen Sie API-Schlüssel niemals im Frontend-Code ab und verwenden Sie Umgebungsvariablen für vertrauliche Daten. Nutzen Sie nach Möglichkeit Webhooks statt regelmäßiger Statusabfragen — das spart Anfragen und liefert das Ergebnis früher.
Typische Einsatzfälle
In einer CI/CD-Strecke lässt sich vor jedem Produktiv-Deploy ein Scan auslösen und die Auslieferung stoppen, wenn ein kritischer Befund auftaucht. Agenturen legen Projekte je Mandant automatisiert an und ziehen die PDF-Berichte in ihr eigenes Reporting. Monitoring-Systeme fragen den Score regelmäßig ab und schlagen bei Verschlechterung an — oder lassen sich über Webhooks aktiv benachrichtigen, was Anfragen spart.
Was die API zurückgibt
Jeder Befund enthält Kategorie, Schweregrad, Fundstelle und die zugehörige Lösungsanleitung samt Apache- oder Nginx-Snippet — dieselbe Substanz wie in der Oberfläche, nur maschinenlesbar. Damit lassen sich eigene Auswertungen bauen, ohne Berichte von Hand auszuwerten.