端点概览
所有可用 REST API 端点的完整参考
端点概览
所有端点都使用以下基础 URL:https://your-app-domain.com/api/public
保修资格
| 方法 | 路径 | 说明 |
|---|---|---|
| GET / POST | /warranty-eligibility | 检查产品的保修资格 |
| POST | /warranty/eligibility | 检查订单行项目的保修资格 |
| GET / POST | /assess-eligibility | 批量重新评估某个组织的保修资格(管理员) |
| GET | /assess-eligibility/all | 批量评估所有组织(管理员) |
保修
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /warranty/{warrantyId} | 按 ID 获取保修详情 |
保单
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /policies/fetch | 获取某位顾客的所有保单 |
| GET | /policies/fetch/{policyId} | 按 ID 获取特定保单 |
| POST | /policies/fetch/order-line-item-policy | 查找订单行项目对应的保单 |
| POST | /policies/validate | 通过保单 ID 和订单名称验证保单 |
索赔
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /claims/submit | 针对保单提交保修索赔 |
| POST | /claims/submit-manual | 提交由商家发起的索赔(无需保单) |
| GET | /claims/fetch | 获取某份保单和顾客的索赔 |
| GET | /claims/{id}/evidence | 获取索赔的证据文件 |
| POST | /claims/upload-urls | 为证据生成预签名上传 URL |
| POST | /claims/upload | 直接上传索赔证据 |
| POST | /claims/evidence | 将证据元数据附加到索赔 |
产品
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /products/search | 按标题、SKU 或条形码搜索产品 |
| GET | /products/eligibility | 检查多个产品的保修资格 |
| POST | /products/register | 为产品注册保修保障 |
顾客
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /customers/orders | 获取某位顾客的订单 |
注册
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /registration/lookup | 按编号查找注册记录 |
序列号
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /serial-numbers/validate | 验证序列号 |
分析
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /analytics/events | 发送小组件分析事件 |
配置
| 方法 | 路径 | 说明 |
|---|---|---|
| GET / POST | /config | 获取小组件配置和翻译 |
订单状态
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /order-status | 获取订单状态 |
POS
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /pos/customer-search | 在 POS 环境中搜索顾客 |
Shopify 集成
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /shopify/auth/callback | 应用安装的 OAuth 回调 |
| POST | /shopify/webhooks | 接收 Shopify Webhook 事件 |
| POST | /shopify/post-purchase/sign-changeset | 为购买后扩展的变更集签名 |
产品同步
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /sync-products | 同步某个组织的产品 |
| POST | /sync-products/all | 同步所有组织的产品 |
健康状态
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /health | 检查 API 健康状态 |
返回 200(健康)、206(降级)或 503(不健康)。


