PRODUCT TEST WORKSPACE
Cloudflare Turnstile
Captcha verification product
CLOUDFLARE_TURNSTILE02 / REQUEST
请求预览
POST /api/validator/create.cgi
{
"productCode" : "CLOUDFLARE_TURNSTILE",
"adapter" : {
"websiteURL" : "https://example.com/register",
"websiteKey" : "YOUR_WEBSITEKEY"
}
}
03 / RESULT
响应示例
Task ID
—
{
"code" : 0,
"msg" : "操作成功",
"data" : {
"taskId" : "11111111-1111-4111-8111-111111111111",
"productCode" : "CLOUDFLARE_TURNSTILE",
"state" : "SUCCEEDED",
"solution" : {
"token" : "EXAMPLE_TOKEN",
"userAgent" : "EXAMPLE_USERAGENT"
}
}
}
响应仅为示例,不是真实任务结果。提交前请替换请求中的所有示例值。
状态为 SUCCEEDED 后读取 data.solution。答案字段因产品而异,其他状态可能返回空对象。
04 / API REFERENCE
Cloudflare Turnstile · API
创建和查询任务时,将 API Key 统一放在 HTTP apiKey 请求头中;JSON 请求体只包含业务参数。
Content-Type: application/json apiKey: YOUR_API_KEY
请求示例
{
"productCode": "CLOUDFLARE_TURNSTILE", // 产品编码,必须与 adapter 参数匹配。
"adapter": { // 产品专属参数对象。
"websiteURL": "https://example.com/register", // 实际承载该控件的完整页面 URL,取自同一目标会话。
"websiteKey": "YOUR_WEBSITEKEY", // 该 Turnstile 控件的实际 sitekey,不能使用其他站点的 Key。
"action": "YOUR_ACTION", // 实际 render action;整页挑战提供 pagedata 时必填。独立控件也可以仅设置 action,不需要因此补 pagedata。
"data": "CURRENT_CDATA", // 实际 render cData,向上游使用 data;兼容别名 cData,两者同时提供且不同会在计费前拒绝。
"pagedata": "CURRENT_CHL_PAGE_DATA", // Cloudflare 整页挑战当前 render 的 chlPageData,向上游使用 pagedata;提供时 action、data 也必须齐全。不是所有独立控件都必填。
"cData": "CURRENT_CDATA", // data 的兼容别名,建议使用 data;已提供 data 时省略此别名。
"chlPageData": "CURRENT_CHL_PAGE_DATA", // pagedata 的兼容别名,建议使用 pagedata;已提供 pagedata 时省略此别名。
"userAgent": "YOUR_BROWSER_USER_AGENT", // 可选,实际浏览器 User-Agent。返回的 solution.userAgent 必须保留;不能假设上游一定返回输入的 UA。
"proxyType": "http", // 可选代理协议:http、socks4、socks5。提供任一代理字段时,proxyType、proxyAddress、proxyPort 必须齐全;全部省略时沿用无代理模式。
"proxyAddress": "YOUR_PROXY_HOST", // 代理主机名或 IP,不含协议、端口及认证信息;按目标会话要求使用对应出口。
"proxyPort": 8080, // 代理 TCP 端口,1 至 65535 的整数,仅使用代理时必填。
"proxyLogin": "YOUR_PROXYLOGIN", // 仅该代理需要认证时提供的用户名。
"proxyPassword": "YOUR_PROXYPASSWORD" // 仅该代理需要认证时提供的密码。
}
}
请求头: apiKey: YOUR_API_KEY
注释用于说明字段,复制后得到不含注释的标准 JSON。
响应示例
{
"code": 0, // 业务返回码,0 表示成功,其他值表示错误。
"msg": "操作成功", // 结果说明,成功时可能为空。
"data": { // 响应数据,接口报错时可能为 null。
"taskId": "11111111-1111-4111-8111-111111111111", // 创建任务返回的任务 ID。
"productCode": "CLOUDFLARE_TURNSTILE", // 产品编码,必须与 adapter 参数匹配。
"state": "SUCCEEDED", // 任务状态:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
"solution": { // SUCCEEDED 时的产品答案;处理中或失败时为空对象。
"token": "EXAMPLE_TOKEN", // 提交到目标网站的验证令牌。
"userAgent": "EXAMPLE_USERAGENT" // 获取答案时使用的浏览器 User-Agent。
}
}
}
创建任务返回任务 ID 和初始状态。下方为查询接口的完成结果,也可通过 WebSocket 接收答案。
请求参数说明
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
productCode | string | 是 | 产品编码,必须与 adapter 参数匹配。 |
adapter | object | 是 | 产品专属参数对象。 |
adapter.websiteURL | string | 是 | 实际承载该控件的完整页面 URL,取自同一目标会话。 |
adapter.websiteKey | string | 是 | 该 Turnstile 控件的实际 sitekey,不能使用其他站点的 Key。 |
adapter.action | string | 否 | 实际 render action;整页挑战提供 pagedata 时必填。独立控件也可以仅设置 action,不需要因此补 pagedata。 |
adapter.data | string | 否 | 实际 render cData,向上游使用 data;兼容别名 cData,两者同时提供且不同会在计费前拒绝。 |
adapter.pagedata | string | 否 | Cloudflare 整页挑战当前 render 的 chlPageData,向上游使用 pagedata;提供时 action、data 也必须齐全。不是所有独立控件都必填。 |
adapter.cData | string | 否 | data 的兼容别名,建议使用 data;已提供 data 时省略此别名。 |
adapter.chlPageData | string | 否 | pagedata 的兼容别名,建议使用 pagedata;已提供 pagedata 时省略此别名。 |
adapter.userAgent | string | 否 | 可选,实际浏览器 User-Agent。返回的 solution.userAgent 必须保留;不能假设上游一定返回输入的 UA。 |
adapter.proxyType | string | 否 | 可选代理协议:http、socks4、socks5。提供任一代理字段时,proxyType、proxyAddress、proxyPort 必须齐全;全部省略时沿用无代理模式。 |
adapter.proxyAddress | string | 否 | 代理主机名或 IP,不含协议、端口及认证信息;按目标会话要求使用对应出口。 |
adapter.proxyPort | integer | 否 | 代理 TCP 端口,1 至 65535 的整数,仅使用代理时必填。 |
adapter.proxyLogin | string | 否 | 仅该代理需要认证时提供的用户名。 |
adapter.proxyPassword | string | 否 | 仅该代理需要认证时提供的密码。 |
响应参数说明
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 业务返回码,0 表示成功,其他值表示错误。 |
msg | string | 结果说明,成功时可能为空。 |
data | object | null | 响应数据,接口报错时可能为 null。 |
data.taskId | string | 创建任务返回的任务 ID。 |
data.productCode | string | 产品编码,必须与 adapter 参数匹配。 |
data.state | string | 任务状态:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。 |
data.solution | object | SUCCEEDED 时的产品答案;处理中或失败时为空对象。 |
data.failure | object | omitted | 仅 FAILED 或 EXPIRED 返回的公开诊断,不含上游原始消息;按失败处理指引操作。 |
data.failure.code | string | 失败编码 |
data.failure.nextAction | string | 下一步 |
data.solution.token | string | 提交到目标网站的验证令牌。 |
data.solution.userAgent | string | 获取答案时使用的浏览器 User-Agent。 |
响应
HTTP 业务响应包含 code、msg 和 data;code 为 0 表示成功。WebSocket 使用独立的消息结构。
- -1317
- API Key 无效。
- -1100 / -1101
- 请求参数错误或缺失。
- -1401
- 余额不足,请充值后再创建任务
- -1400 / -1001
- 系统或创建任务错误。