PRODUCT TEST WORKSPACE

GeeTest

Captcha verification product

GEETEST

01 / CREATE

创建任务

编辑器默认填入必填字段及一组条件字段。可选字段在下方文档列出,也可一键填入。

02 / REQUEST

请求预览

POST /api/validator/create.cgi
{
  "productCode" : "GEETEST",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "gt" : "YOUR_GT",
    "challenge" : "YOUR_CHALLENGE"
  }
}

03 / RESULT

响应示例

EXAMPLE
Task ID —
{
  "code" : 0,
  "msg" : "操作成功",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "GEETEST",
    "state" : "SUCCEEDED",
    "solution" : {
      "challenge" : "EXAMPLE_CHALLENGE",
      "validate" : "EXAMPLE_VALIDATE",
      "seccode" : "EXAMPLE_SECCODE"
    }
  }
}

响应仅为示例,不是真实任务结果。提交前请替换请求中的所有示例值。

状态为 SUCCEEDED 后读取 data.solution。答案字段因产品而异,其他状态可能返回空对象。

04 / API REFERENCE

GeeTest · API

创建和查询任务时,将 API Key 统一放在 HTTP apiKey 请求头中;JSON 请求体只包含业务参数。

Content-Type: application/json
apiKey: YOUR_API_KEY

请求示例

POST /api/validator/create.cgi · JSONC
{
  "productCode": "GEETEST", // 产品编码,必须与 adapter 参数匹配。
  "adapter": { // 产品专属参数对象。
    "websiteURL": "https://example.com/register", // 目标网站完整 URL。
    "gt": "YOUR_GT", // 目标 initGeetest v3 集成签发的 gt,不是 v4 的 captcha_id。不要使用演示值或其他集成标识。
    "challenge": "YOUR_CHALLENGE" // 每次新任务从目标初始化接口取得尚未使用的 v3 challenge;页面已加载过的值对识别服务不再有效。保持对应目标会话,不复用,也不按长度推断新鲜性。
  }
}

请求头: apiKey: YOUR_API_KEY

注释用于说明字段,复制后得到不含注释的标准 JSON。

响应示例

POST /api/validator/query.cgi · JSONC
{
  "code": 0, // 业务返回码,0 表示成功,其他值表示错误。
  "msg": "操作成功", // 结果说明,成功时可能为空。
  "data": { // 响应数据,接口报错时可能为 null。
    "taskId": "11111111-1111-4111-8111-111111111111", // 创建任务返回的任务 ID。
    "productCode": "GEETEST", // 产品编码,必须与 adapter 参数匹配。
    "state": "SUCCEEDED", // 任务状态:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
    "solution": { // SUCCEEDED 时的产品答案;处理中或失败时为空对象。
      "challenge": "EXAMPLE_CHALLENGE", // 产品返回的答案字段,按目标网站的验证协议使用。
      "validate": "EXAMPLE_VALIDATE", // 产品返回的答案字段,按目标网站的验证协议使用。
      "seccode": "EXAMPLE_SECCODE" // 产品返回的答案字段,按目标网站的验证协议使用。
    }
  }
}

创建任务返回任务 ID 和初始状态。下方为查询接口的完成结果,也可通过 WebSocket 接收答案。

请求参数说明

字段类型必填说明
productCodestring是产品编码,必须与 adapter 参数匹配。
adapterobject是产品专属参数对象。
adapter.websiteURLstring是目标网站完整 URL。
adapter.gtstring是目标 initGeetest v3 集成签发的 gt,不是 v4 的 captcha_id。不要使用演示值或其他集成标识。
adapter.challengestring是每次新任务从目标初始化接口取得尚未使用的 v3 challenge;页面已加载过的值对识别服务不再有效。保持对应目标会话,不复用,也不按长度推断新鲜性。
adapter.apiServerSubdomainstring否可选的 v3 GeeTest API 主机名,取自目标配置,例如 api-na.geetest.com。未配置或不确定时省略,不要提交 YOUR_* 占位值;现有公开字段名保持不变。
adapter.userAgentstring否目标浏览器 User-Agent。

响应参数说明

字段类型说明
codeinteger业务返回码,0 表示成功,其他值表示错误。
msgstring结果说明,成功时可能为空。
dataobject | null响应数据,接口报错时可能为 null。
data.taskIdstring创建任务返回的任务 ID。
data.productCodestring产品编码,必须与 adapter 参数匹配。
data.statestring任务状态:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
data.solutionobjectSUCCEEDED 时的产品答案;处理中或失败时为空对象。
data.failureobject | omitted仅 FAILED 或 EXPIRED 返回的公开诊断,不含上游原始消息;按失败处理指引操作。
data.failure.codestring失败编码
data.failure.nextActionstring下一步
data.solution.challengestring产品返回的答案字段,按目标网站的验证协议使用。
data.solution.validatestring产品返回的答案字段,按目标网站的验证协议使用。
data.solution.seccodestring产品返回的答案字段,按目标网站的验证协议使用。

响应

HTTP 业务响应包含 code、msg 和 data;code 为 0 表示成功。WebSocket 使用独立的消息结构。

-1317
API Key 无效。
-1100 / -1101
请求参数错误或缺失。
-1401
余额不足,请充值后再创建任务
-1400 / -1001
系统或创建任务错误。
API文档