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

MetodoEndpointDescrizione
GET/plansElenca tutti i piani
POST/plansCrea un nuovo piano
GET/plans/:idOttieni i dettagli del piano
PUT/plans/:idAggiorna un piano
DELETE/plans/:idArchivia 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

MetodoEndpointDescrizione
GET/claimsElenca i reclami (filtrabile)
POST/claimsPresenta un nuovo reclamo
GET/claims/:idOttieni i dettagli del reclamo
PATCH/claims/:idAggiorna lo stato del reclamo
POST/claims/:id/notesAggiungi una nota a un reclamo

Contratti

MetodoEndpointDescrizione
GET/contractsElenca i contratti attivi
GET/contracts/:idOttieni i dettagli del contratto
POST/contracts/:id/cancelAnnulla un contratto

Analisi

MetodoEndpointDescrizione
GET/analytics/revenueRiepilogo dei ricavi
GET/analytics/claimsMetriche dei reclami
GET/analytics/attach-rateTasso 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.

Book a Demo

See how myUmbrella can transform your warranty program

Choose a Time

Select a convenient time for your personalized demo

ESC

Start typing to search across all content

No results found

Try a different search term