Zum Hauptinhalt springen

API

RGate API Dokumentation

Die öffentliche API ist bewusst klein: Scan starten, Status abrufen, strukturierte Ergebnisse auswerten und JSON-Fehler maschinenlesbar behandeln.

Was RGate für Agenten abkürzt

Die API ist nicht nur ein Wrapper um Lighthouse. RGate betreibt eine Browser-basierte Prüf-Pipeline über Security, SEO, Accessibility, Legal und Sustainability. Das vollständige Testprogramm erklärt Methodik, Fail-Conditions, Risiken, Fixes und Referenzen, damit Agents nachvollziehen können, was geprüft wurde.

Ein Agent könnte einzelne Checks selbst bauen, müsste dafür aber Browser-Automation, Worker, Storage, Scoring, APIs, Exports und laufenden Betrieb konfigurieren. RGate macht diese Infrastruktur sofort nutzbar.

1. Start a scan

POST /api/scan
Content-Type: application/json

{ "url": "https://www.rgate.io" }

2. Poll results

GET /api/scan/{scanId}

Result arrays are null until the scan status is done.

3. Handle errors

{
  "error": "URL is required.",
  "code": "URL_REQUIRED",
  "message": "URL is required.",
  "hint": "See https://www.rgate.io/openapi.json for request schemas and examples."
}

4. MCP and CLI

POST /api/mcp
GET /.well-known/mcp.json
npx @rgate_io/rgate scan https://www.rgate.io --wait --json

Use the MCP server or RGate CLI when agents need automated testing for web applications and APIs without building a custom REST client.

    RGate API Documentation | RGate