端点概览
所有可用的保修计划、理赔和分析 REST API 端点参考。
API 端点概览
myumbrella.ai REST API 以资源为中心进行组织。所有端点使用 JSON 请求/响应体和标准 HTTP 方法。
基础 URL: https://api.myumbrella.ai/v1
保修计划
| 方法 | 端点 | 描述 |
|---|---|---|
GET | /plans | 列出所有计划 |
POST | /plans | 创建新计划 |
GET | /plans/:id | 获取计划详情 |
PUT | /plans/:id | 更新计划 |
DELETE | /plans/:id | 归档计划 |
示例:创建计划
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
}'
理赔
| 方法 | 端点 | 描述 |
|---|---|---|
GET | /claims | 列出理赔(可筛选) |
POST | /claims | 提交新理赔 |
GET | /claims/:id | 获取理赔详情 |
PATCH | /claims/:id | 更新理赔状态 |
POST | /claims/:id/notes | 为理赔添加备注 |
合同
| 方法 | 端点 | 描述 |
|---|---|---|
GET | /contracts | 列出活跃合同 |
GET | /contracts/:id | 获取合同详情 |
POST | /contracts/:id/cancel | 取消合同 |
分析
| 方法 | 端点 | 描述 |
|---|---|---|
GET | /analytics/revenue | 收入摘要 |
GET | /analytics/claims | 理赔指标 |
GET | /analytics/attach-rate | 附加率趋势 |
分页
所有列表端点支持基于游标的分页:
GET /v1/plans?limit=25&starting_after=plan_xyz
响应包含 has_more 布尔值和分页元数据。


