Skip to content

反欺诈数据 API

数据 API 是 Web SDK 的服务端搭档。用它来拉取裁决、汇总统计、导出数据, 用于报表与对账——拉取你自己系统据以一致的那些数字。

基础 URL

https://apiv1.captcha.la

鉴权

所有数据 API 请求都用你的反欺诈应用凭据鉴权,以请求头形式发送:

X-App-Key:    YOUR_APP_KEY
X-App-Secret: YOUR_APP_SECRET

WARNING

X-App-Secret 仅限服务端。绝不要把它暴露给浏览器、移动端或公开仓库。 页面 SDK 始终只使用公开的 appKey

端点

获取单条裁决

获取某一次访问的裁决(例如用于对账某次具体访问)。

bash
GET /v1/bot/verdict?cid=CID_OF_THE_VISIT
X-App-Key: YOUR_APP_KEY
X-App-Secret: YOUR_APP_SECRET

响应的 data 是一个 BotVerdict 对象:

json
{
  "code": 0,
  "data": {
    "is_bot": true,
    "score": 87,
    "level": "high",
    "action": "flag",
    "consistency": { "ok": false },
    "degraded": false
  }
}

汇总统计

按时间范围拉取分桶计数——总量、机器人占比,以及按 action/level 的拆分—— 用于看板与质量报表。

bash
GET /v1/bot/stats?from=2026-06-01&to=2026-06-30
X-App-Key: YOUR_APP_KEY
X-App-Secret: YOUR_APP_SECRET
json
{
  "code": 0,
  "data": {
    "from": "2026-06-01",
    "to": "2026-06-30",
    "total": 124500,
    "bots": 18230,
    "bot_rate": 0.146,
    "by_action": { "record_only": 102100, "flag": 19800, "challenge": 2600 },
    "by_level":  { "low": 100300, "medium": 16900, "high": 6200, "critical": 1100 }
  }
}

导出

按时间范围导出逐次访问的裁决行,用于离线对账。

bash
GET /v1/bot/export?from=2026-06-01&to=2026-06-30&format=csv
X-App-Key: YOUR_APP_KEY
X-App-Secret: YOUR_APP_SECRET

每一行携带该次访问的标识、时间戳,以及裁决字段 (is_botscorelevelaction),你可据此与自己的日志关联。

逐点击对账

对于付费流量场景,一次访问可以回溯到某次具体投递的点击,供双方就此结算。这用到 点击 token,见广告反作弊指南。

下一步

MIT-licensed examples · CaptchaLa is operated independently