Die Scan-API

Eine überwiegend lesende HTTP-API für Ihre eigenen Websites: einen Durchlauf auslösen, den letzten lesen, jeden vergangenen lesen. Verfügbar ab MONITOR.

Schlüssel

Einen Schlüssel erzeugen Sie in der App unter API keys. Er wird einmal angezeigt und nur als Hash gespeichert — eine Kopie unserer Datenbank lässt sich also nicht in funktionierende Zugangsdaten zurückverwandeln. Verloren heißt widerrufen und neu erzeugen.

curl -H "Authorization: Bearer sichta_..." \
  https://web.sichta.gigliotti.software/api/v1/sites/<siteId>/runs/latest

Ein Schlüssel gehört zu einem Konto und darf nur Websites dieses Kontos ansprechen. Jede Antwort trägt X-RateLimit-Limit und X-RateLimit-Remaining für das Monatskontingent.

Endpunkte

• POST /api/v1/sites/{siteId}/runs — jetzt prüfen. Der einzige Nicht-GET, und er schreibt nichts in Ihre Daten: Er bittet uns, Ihre Website anzusehen. Begrenzt auf fünf Durchläufe pro Website und Tag, zusätzlich zum Monatskontingent — der größte Teil der Last eines Durchlaufs entsteht auf Ihrem Server, nicht auf unserem.
• GET /api/v1/sites/{siteId}/runs/latest — der zuletzt abgeschlossene Durchlauf.
• GET /api/v1/sites/{siteId}/runs/{number} — ein Durchlauf nach Nummer. Abgeschlossene Durchläufe sind unveränderlich: Sie erhalten, was die Engine an jenem Tag gesagt hat, nicht was sie heute sagen würde.

latest liefert 404 statt eines leeren Durchlaufs, wenn noch nichts geprüft wurde. „Kein Durchlauf" und „ein Durchlauf ohne Befunde" sind verschiedene Zustände; sie gleichzusetzen ließe Sie glauben, eine Website sei geprüft worden.

Die vollständige Beschreibung

/api/v1/openapi.json ist ein OpenAPI-3.1-Dokument. Es wird aus derselben Prüf-Registry erzeugt, die die Engine ausführt — die Aufzählung der Prüf-IDs und Fehlertypen darin ist also genau das, was Ihre Ergebnisse enthalten werden.

Zum Lesen ist kein Schlüssel nötig. Eine Spezifikation, für die man Zugangsdaten braucht, hilft nicht bei der Entscheidung, ob sich die Zugangsdaten lohnen.

Einen Befund lesen

Jeder Befund trägt checkId, pillar, result, errorType, detail sowie title, explanation und fix aus der Registry. Dazu scored, pro Befund gespeichert statt nachgeschlagen — damit eine Prüfung, die zwischen gewertet und zukunftsgerichtet wechselt, nie umschreibt, was ein vergangener Durchlauf bedeutet hat.

Bewerten Sie wie wir: bestandene gewertete Prüfungen geteilt durch anwendbare gewertete Prüfungen. Ein score von null bedeutet, dass nichts Bewertbares ermittelt werden konnte.