Endpunkte-Übersicht

API-Endpunkte-Übersicht

Die myumbrella.ai REST-API ist ressourcenorientiert aufgebaut. Alle Endpunkte verwenden JSON-Anfrage-/Antwortkörper und standardmäßige HTTP-Methoden.

Basis-URL: https://api.myumbrella.ai/v1

Garantiepläne

Methode	Endpunkt	Beschreibung
GET	/plans	Alle Pläne auflisten
POST	/plans	Einen neuen Plan erstellen
GET	/plans/:id	Plandetails abrufen
PUT	/plans/:id	Einen Plan aktualisieren
DELETE	/plans/:id	Einen Plan archivieren

Beispiel: Plan erstellen

curl -X POST https://api.myumbrella.ai/v1/plans \
  -H "Authorization: Bearer mu_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "2-Year Protection",
    "coverage": ["mechanical", "accidental"],
    "duration_months": 24,
    "price_model": "percentage",
    "rate": 0.12
  }'

Schadensfälle

Methode	Endpunkt	Beschreibung
GET	/claims	Schadensfälle auflisten (filterbar)
POST	/claims	Einen neuen Schadensfall einreichen
GET	/claims/:id	Schadensfall-Details abrufen
PATCH	/claims/:id	Schadensfall-Status aktualisieren
POST	/claims/:id/notes	Eine Notiz zu einem Schadensfall hinzufügen

Verträge

Methode	Endpunkt	Beschreibung
GET	/contracts	Aktive Verträge auflisten
GET	/contracts/:id	Vertragsdetails abrufen
POST	/contracts/:id/cancel	Einen Vertrag stornieren

Analysen

Methode	Endpunkt	Beschreibung
GET	/analytics/revenue	Umsatzübersicht
GET	/analytics/claims	Schadensfälle-Kennzahlen
GET	/analytics/attach-rate	Abschlussrate im Zeitverlauf

Paginierung

Alle Listenendpunkte unterstützen cursorbasierte Paginierung:

GET /v1/plans?limit=25&starting_after=plan_xyz

Die Antwort enthält einen has_more-Boolean-Wert und Paginierungs-Metadaten.