PRODUCT TEST WORKSPACE

GeeTest v4

Captcha verification product

GEETEST_V4

01 / CREATE

创建任务

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

02 / REQUEST

请求预览

POST /api/validator/create.cgi
{
  "productCode" : "GEETEST_V4",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "captchaId" : "YOUR_CAPTCHAID"
  }
}

03 / RESULT

响应示例

EXAMPLE
Task ID —
{
  "code" : 0,
  "msg" : "操作成功",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "GEETEST_V4",
    "state" : "SUCCEEDED",
    "solution" : {
      "captcha_id" : "EXAMPLE_CAPTCHA_ID",
      "lot_number" : "EXAMPLE_LOT_NUMBER",
      "pass_token" : "EXAMPLE_PASS_TOKEN",
      "gen_time" : "EXAMPLE_GEN_TIME",
      "captcha_output" : "EXAMPLE_CAPTCHA_OUTPUT"
    }
  }
}

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

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

04 / API REFERENCE

GeeTest v4 · API

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

Content-Type: application/json
apiKey: YOUR_API_KEY

请求示例

POST /api/validator/create.cgi · JSONC
{
  "productCode": "GEETEST_V4", // 产品编码,必须与 adapter 参数匹配。
  "adapter": { // 产品专属参数对象。
    "websiteURL": "https://example.com/register", // 目标网站完整 URL。
    "captchaId": "YOUR_CAPTCHAID" // 使用目标 initGeetest4 配置中的 captcha_id,不是 v3 集成的 gt 或 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_V4", // 产品编码,必须与 adapter 参数匹配。
    "state": "SUCCEEDED", // 任务状态:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
    "solution": { // SUCCEEDED 时的产品答案;处理中或失败时为空对象。
      "captcha_id": "EXAMPLE_CAPTCHA_ID", // 产品返回的答案字段,按目标网站的验证协议使用。
      "lot_number": "EXAMPLE_LOT_NUMBER", // 产品返回的答案字段,按目标网站的验证协议使用。
      "pass_token": "EXAMPLE_PASS_TOKEN", // 提交到目标网站的验证令牌。
      "gen_time": "EXAMPLE_GEN_TIME", // 产品返回的答案字段,按目标网站的验证协议使用。
      "captcha_output": "EXAMPLE_CAPTCHA_OUTPUT" // 产品返回的答案字段,按目标网站的验证协议使用。
    }
  }
}

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

请求参数说明

字段类型必填说明
productCodestring是产品编码,必须与 adapter 参数匹配。
adapterobject是产品专属参数对象。
adapter.websiteURLstring是目标网站完整 URL。
adapter.captchaIdstring是使用目标 initGeetest4 配置中的 captcha_id,不是 v3 集成的 gt 或 challenge。
adapter.userAgentstring否目标浏览器 User-Agent。
adapter.riskTypestring否可选的目标实际 GeeTest v4 risk_type,与 captcha_id 一起发送到上游 initParameters;不改变产品版本。

响应参数说明

字段类型说明
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.captcha_idstring产品返回的答案字段,按目标网站的验证协议使用。
data.solution.lot_numberstring产品返回的答案字段,按目标网站的验证协议使用。
data.solution.pass_tokenstring提交到目标网站的验证令牌。
data.solution.gen_timestring产品返回的答案字段,按目标网站的验证协议使用。
data.solution.captcha_outputstring产品返回的答案字段,按目标网站的验证协议使用。

响应

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

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