PRODUCT TEST WORKSPACE

Grid Captcha

Captcha verification product

GRID

01 / CREATE

创建任务

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

02 / REQUEST

请求预览

POST /api/validator/create.cgi
{
  "productCode" : "GRID",
  "adapter" : {
    "body" : "BASE64_CONTENT",
    "comment" : "Select all images containing stairs."
  }
}

03 / RESULT

响应示例

EXAMPLE
Task ID —
{
  "code" : 0,
  "msg" : "操作成功",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "GRID",
    "state" : "SUCCEEDED",
    "solution" : {
      "click" : [ 1, 5, 9 ]
    }
  }
}

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

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

04 / API REFERENCE

Grid Captcha · API

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

Content-Type: application/json
apiKey: YOUR_API_KEY

请求示例

POST /api/validator/create.cgi · JSONC
{
  "productCode": "GRID", // 产品编码,必须与 adapter 参数匹配。
  "adapter": { // 产品专属参数对象。
    "body": "BASE64_CONTENT", // 图片内容或任务主体;按产品要求传入 Base64 或文本。
    "comment": "Select all images containing stairs.", // 提交给人工识别者的说明。
    "rows": 3, // 提交的当前网格实际行数。
    "columns": 3, // 提交的当前网格实际列数。
    "imgType": "recaptcha", // 可选上游计算机视觉模式:recaptcha 或 funcaptcha;不能把通用或自定义图片冒称为这些产品,必须提供英文原始题目和原始图像文件。
    "previousId": "123456789", // 可选的同一持续挑战上游任务 ID,仅已知时提供;不是 Nex Captcha 平台 UUID,未取得上游 ID 时省略。不能关联其他或过期挑战。
    "minClicks": 1, // 可选 minClicks 边界,指定行列时不能超过 rows*columns,minClicks 不能大于 maxClicks。
    "maxClicks": 9, // 可选 maxClicks 边界,指定行列时不能超过 rows*columns,minClicks 不能大于 maxClicks。
    "canNoAnswer": 0 // 0 或 1,仅实际题目允许没有匹配图片时设为 1,不用于掩盖识别失败。
  }
}

请求头: 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": "GRID", // 产品编码,必须与 adapter 参数匹配。
    "state": "SUCCEEDED", // 任务状态:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
    "solution": { // SUCCEEDED 时的产品答案;处理中或失败时为空对象。
      "click": [ // 需要点击的网格序号列表。
        1, // 产品返回的答案字段,按目标网站的验证协议使用。
        5, // 产品返回的答案字段,按目标网站的验证协议使用。
        9 // 产品返回的答案字段,按目标网站的验证协议使用。
      ]
    }
  }
}

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

请求参数说明

字段类型必填说明
productCodestring是产品编码,必须与 adapter 参数匹配。
adapterobject是产品专属参数对象。
adapter.bodystring是图片内容或任务主体;按产品要求传入 Base64 或文本。
adapter.commentstring条件必填提交给人工识别者的说明。
adapter.rowsinteger否提交的当前网格实际行数。
adapter.columnsinteger否提交的当前网格实际列数。
adapter.imgInstructionsstring条件必填可选的 Base64 题目图片,最多 100 kB;comment 与 imgInstructions 至少一个,使用 imgType 时必须提供英文原始题目和原始图像文件。
adapter.imgTypestring否可选上游计算机视觉模式:recaptcha 或 funcaptcha;不能把通用或自定义图片冒称为这些产品,必须提供英文原始题目和原始图像文件。
adapter.previousIdstring否可选的同一持续挑战上游任务 ID,仅已知时提供;不是 Nex Captcha 平台 UUID,未取得上游 ID 时省略。不能关联其他或过期挑战。
adapter.minClicksinteger否可选 minClicks 边界,指定行列时不能超过 rows*columns,minClicks 不能大于 maxClicks。
adapter.maxClicksinteger否可选 maxClicks 边界,指定行列时不能超过 rows*columns,minClicks 不能大于 maxClicks。
adapter.canNoAnswerinteger否0 或 1,仅实际题目允许没有匹配图片时设为 1,不用于掩盖识别失败。

响应参数说明

字段类型说明
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.clickarray需要点击的网格序号列表。
data.solution.click[]integer产品返回的答案字段,按目标网站的验证协议使用。

响应

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

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