PRODUCT TEST WORKSPACE

TSPD Captcha

Captcha verification product

TSPD

01 / CREATE

创建任务

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

02 / REQUEST

请求预览

POST /api/validator/create.cgi
{
  "productCode" : "TSPD",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "tspdCookie" : "YOUR_FRESH_TSPD_COOKIE",
    "htmlPageBase64" : "YOUR_FRESH_CHALLENGE_HTML_BASE64",
    "proxyType" : "http",
    "proxyAddress" : "YOUR_PROXY_HOST",
    "proxyPort" : 8080
  }
}

03 / RESULT

响应示例

EXAMPLE
Task ID —
{
  "code" : 0,
  "msg" : "操作成功",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "TSPD",
    "state" : "SUCCEEDED",
    "solution" : {
      "Domains" : {
        "example.com" : {
          "Cookies" : {
            "TS386a400d029" : "EXAMPLE_TS386A400D029",
            "TS386a400d078" : "EXAMPLE_TS386A400D078",
            "tspd_101_DID" : "EXAMPLE_TSPD_101_DID"
          }
        }
      }
    }
  }
}

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

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

04 / API REFERENCE

TSPD Captcha · API

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

Content-Type: application/json
apiKey: YOUR_API_KEY

请求示例

POST /api/validator/create.cgi · JSONC
{
  "productCode": "TSPD", // 产品编码,必须与 adapter 参数匹配。
  "adapter": { // 产品专属参数对象。
    "websiteURL": "https://example.com/register", // 目标网站完整 URL。
    "userAgent": "YOUR_BROWSER_USER_AGENT", // 目标浏览器 User-Agent。
    "tspdCookie": "YOUR_FRESH_TSPD_COOKIE", // 刚获取的 TSPD 挑战 Cookie。
    "htmlPageBase64": "YOUR_FRESH_CHALLENGE_HTML_BASE64", // 同一会话的挑战页面 HTML 的 Base64。
    "proxyType": "http", // 同一会话使用的代理类型。
    "proxyAddress": "YOUR_PROXY_HOST", // 代理地址。
    "proxyPort": 8080, // 代理端口。
    "proxyLogin": "YOUR_PROXY_LOGIN", // 代理用户名。
    "proxyPassword": "YOUR_PROXY_PASSWORD" // 代理密码。
  }
}

请求头: 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": "TSPD", // 产品编码,必须与 adapter 参数匹配。
    "state": "SUCCEEDED", // 任务状态:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
    "solution": { // SUCCEEDED 时的产品答案;处理中或失败时为空对象。
      "Domains": { // 按目标域名分组的验证结果。
        "example.com": { // 产品返回的答案字段,按目标网站的验证协议使用。
          "Cookies": { // 目标域名对应的验证 Cookie。
            "TS386a400d029": "EXAMPLE_TS386A400D029", // 产品返回的答案字段,按目标网站的验证协议使用。
            "TS386a400d078": "EXAMPLE_TS386A400D078", // 产品返回的答案字段,按目标网站的验证协议使用。
            "tspd_101_DID": "EXAMPLE_TSPD_101_DID" // 产品返回的答案字段,按目标网站的验证协议使用。
          }
        }
      }
    }
  }
}

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

请求参数说明

字段类型必填说明
productCodestring是产品编码,必须与 adapter 参数匹配。
adapterobject是产品专属参数对象。
adapter.websiteURLstring是目标网站完整 URL。
adapter.userAgentstring否目标浏览器 User-Agent。
adapter.tspdCookiestring是刚获取的 TSPD 挑战 Cookie。
adapter.htmlPageBase64string是同一会话的挑战页面 HTML 的 Base64。
adapter.proxyTypestring是同一会话使用的代理类型。
adapter.proxyAddressstring是代理地址。
adapter.proxyPortinteger是代理端口。
adapter.proxyLoginstring否代理用户名。
adapter.proxyPasswordstring否代理密码。

响应参数说明

字段类型说明
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.Domainsobject按目标域名分组的验证结果。
data.solution.Domains.example.comobject产品返回的答案字段,按目标网站的验证协议使用。
data.solution.Domains.example.com.Cookiesobject目标域名对应的验证 Cookie。
data.solution.Domains.example.com.Cookies.TS386a400d029string产品返回的答案字段,按目标网站的验证协议使用。
data.solution.Domains.example.com.Cookies.TS386a400d078string产品返回的答案字段,按目标网站的验证协议使用。
data.solution.Domains.example.com.Cookies.tspd_101_DIDstring产品返回的答案字段,按目标网站的验证协议使用。

响应

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

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