RESTful API 开放接口文档

通过我们的开放 API，您可以将电商合规检测能力无缝集成到您的自有系统、ERP 或商家后台中。

1. 鉴权与认证

所有的 API 请求都需要通过您在开发者中心生成的 API 密钥进行认证。我们支持两种传递方式：

方式 A: Bearer Token

Authorization: Bearer sl_live_xxxxxxxxxxxxxxxx

方式 B: 自定义 Header

X-API-Key: sl_live_xxxxxxxxxxxxxxxx

2. 提交检测任务

该接口用于向服务端提交文本或图片的合规检测请求。系统会自动扣除您账户中的点数。

POST/api/public/v1/detect

请求参数 (JSON)

字段	类型	必填	说明
url	String	否	需要检测的商品页面链接。如果提供，系统将自动尝试抓取内容。
content	Object	否	直接传入需要检测的内容。必须包含 `title`(文本), `description`(文本), `images`(图片URL数组)。
modules	Array	否	指定要检测的模块，例如 `["AD_LAW", "TEXT_TRADEMARK"]`。默认全选。
webhookUrl	String	否	检测完成后的回调地址。系统将通过 POST 请求推送检测结果。

请求示例

curl -X POST https://safelisting.pro/api/public/v1/detect \
  -H "Authorization: Bearer sl_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {
      "title": "最好用的正品商品",
      "description": "全网销量第一",
      "images": ["https://safelisting.pro/demo.jpg"]
    },
    "webhookUrl": "https://your-server.com/webhook/callback"
  }'

响应示例

{
  "success": true,
  "taskId": "c1f7a...",
  "status": "PENDING",
  "cost": 15
}

3. 获取检测结果 (主动轮询)

如果您没有配置 webhookUrl，可以使用此接口轮询检测状态和最终报告。

GET/api/public/v1/tasks/{taskId}

响应示例

{
  "success": true,
  "data": {
    "id": "c1f7a...",
    "status": "COMPLETED",
    "score": 85,
    "riskLevel": "MEDIUM",
    "cost": 15,
    "report": {
      // 结构化诊断报告详情
    }
  }
}