Panoramica degli Endpoint
Un riferimento di tutti gli endpoint REST API disponibili per piani di garanzia, reclami e analisi.
Panoramica degli Endpoint API
LโAPI REST di myumbrella.ai รจ organizzata attorno alle risorse. Tutti gli endpoint utilizzano corpi di richiesta/risposta in JSON e metodi HTTP standard.
URL Base: https://api.myumbrella.ai/v1
Piani di Garanzia
| Metodo | Endpoint | Descrizione |
|---|---|---|
GET | /plans | Elenca tutti i piani |
POST | /plans | Crea un nuovo piano |
GET | /plans/:id | Ottieni i dettagli del piano |
PUT | /plans/:id | Aggiorna un piano |
DELETE | /plans/:id | Archivia un piano |
Esempio: Creare un Piano
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
}'
Reclami
| Metodo | Endpoint | Descrizione |
|---|---|---|
GET | /claims | Elenca i reclami (filtrabile) |
POST | /claims | Presenta un nuovo reclamo |
GET | /claims/:id | Ottieni i dettagli del reclamo |
PATCH | /claims/:id | Aggiorna lo stato del reclamo |
POST | /claims/:id/notes | Aggiungi una nota a un reclamo |
Contratti
| Metodo | Endpoint | Descrizione |
|---|---|---|
GET | /contracts | Elenca i contratti attivi |
GET | /contracts/:id | Ottieni i dettagli del contratto |
POST | /contracts/:id/cancel | Annulla un contratto |
Analisi
| Metodo | Endpoint | Descrizione |
|---|---|---|
GET | /analytics/revenue | Riepilogo dei ricavi |
GET | /analytics/claims | Metriche dei reclami |
GET | /analytics/attach-rate | Tasso di adesione nel tempo |
Paginazione
Tutti gli endpoint di lista supportano la paginazione basata su cursore:
GET /v1/plans?limit=25&starting_after=plan_xyz
La risposta include un booleano has_more e metadati di paginazione.


