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étodo | Endpoint | Descripción |
|---|---|---|
GET | /plans | Listar todos los planes |
POST | /plans | Crear un nuevo plan |
GET | /plans/:id | Obtener detalles del plan |
PUT | /plans/:id | Actualizar un plan |
DELETE | /plans/:id | Archivar 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étodo | Endpoint | Descripción |
|---|---|---|
GET | /claims | Listar reclamos (filtrable) |
POST | /claims | Presentar un nuevo reclamo |
GET | /claims/:id | Obtener detalles del reclamo |
PATCH | /claims/:id | Actualizar estado del reclamo |
POST | /claims/:id/notes | Agregar una nota a un reclamo |
Contratos
| Método | Endpoint | Descripción |
|---|---|---|
GET | /contracts | Listar contratos activos |
GET | /contracts/:id | Obtener detalles del contrato |
POST | /contracts/:id/cancel | Cancelar un contrato |
Análisis
| Método | Endpoint | Descripción |
|---|---|---|
GET | /analytics/revenue | Resumen de ingresos |
GET | /analytics/claims | Métricas de reclamos |
GET | /analytics/attach-rate | Tasa 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.


