Resumen de Endpoints

Una referencia de todos los endpoints REST API disponibles para planes de garantía, reclamos y análisis.

Resumen de Endpoints de la API

La API REST de myumbrella.ai está organizada en torno a recursos. Todos los endpoints usan cuerpos de solicitud/respuesta en JSON y métodos HTTP estándar.

URL Base: https://api.myumbrella.ai/v1

Planes de Garantía

MétodoEndpointDescripción
GET/plansListar todos los planes
POST/plansCrear un nuevo plan
GET/plans/:idObtener detalles del plan
PUT/plans/:idActualizar un plan
DELETE/plans/:idArchivar un plan

Ejemplo: Crear un Plan

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
  }'

Reclamos

MétodoEndpointDescripción
GET/claimsListar reclamos (filtrable)
POST/claimsPresentar un nuevo reclamo
GET/claims/:idObtener detalles del reclamo
PATCH/claims/:idActualizar estado del reclamo
POST/claims/:id/notesAgregar una nota a un reclamo

Contratos

MétodoEndpointDescripción
GET/contractsListar contratos activos
GET/contracts/:idObtener detalles del contrato
POST/contracts/:id/cancelCancelar un contrato

Análisis

MétodoEndpointDescripción
GET/analytics/revenueResumen de ingresos
GET/analytics/claimsMétricas de reclamos
GET/analytics/attach-rateTasa de adhesión a lo largo del tiempo

Paginación

Todos los endpoints de listado admiten paginación basada en cursor:

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

La respuesta incluye un booleano has_more y metadatos de paginación.

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