PRODUCT TEST WORKSPACE

VK Captcha

Captcha verification product

VK_CAPTCHA

01 / CREATE

創建任務

編輯器默認填入必填字段及一組條件字段。可選字段在下方文檔列出,也可一鍵填入。

02 / REQUEST

請求預覽

POST /api/validator/create.cgi
{
  "productCode" : "VK_CAPTCHA",
  "adapter" : {
    "image" : "BASE64_IMAGE",
    "steps" : [ 5, 19, 14, 0 ]
  }
}

03 / RESULT

響應示例

EXAMPLE
Task ID —
{
  "code" : 0,
  "msg" : "操作成功",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "VK_CAPTCHA",
    "state" : "SUCCEEDED",
    "solution" : {
      "best_step" : 2,
      "solution" : [ 5, 19 ],
      "answer" : "EXAMPLE_VK_FORMATTED_ANSWER",
      "preview" : "BASE64_PREVIEW"
    }
  }
}

響應僅爲示例,不是真實任務結果。提交前請替換請求中的所有示例值。

答案字段文檔待補充,當前示例僅展示響應外層結構。

狀態爲 SUCCEEDED 後讀取 data.solution。答案字段因產品而異,其他狀態可能返回空對象。

04 / API REFERENCE

VK Captcha · API

建立與查詢任務時,將 API Key 統一放在 HTTP apiKey 請求標頭中;JSON 請求本文只包含業務參數。

Content-Type: application/json
apiKey: YOUR_API_KEY

請求示例

POST /api/validator/create.cgi · JSONC
{
  "productCode": "VK_CAPTCHA", // 產品編碼,必須與 adapter 參數匹配。
  "adapter": { // 產品專屬參數對象。
    "image": "BASE64_IMAGE", // VK 旋轉驗證碼圖片的 Base64 內容。
    "steps": [ // 來自同一次 VK captchaNotRobot.getContent 回應、與 image 配對的非負整數有序非空陣列,不是最大旋轉次數或角度。保持原序列。相容包含 JSON 整數陣列的舊字串並轉換為陣列;單個 "3" 無效。
      5,
      19,
      14,
      0
    ],
    "proxyLogin": "YOUR_PROXYLOGIN", // 需要代理認證時填寫用戶名。
    "proxyPassword": "YOUR_PROXYPASSWORD" // 需要代理認證時填寫密碼。
  }
}

請求標頭: 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": "VK_CAPTCHA", // 產品編碼,必須與 adapter 參數匹配。
    "state": "SUCCEEDED", // 任務狀態:CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
    "solution": { // SUCCEEDED 時的產品答案;處理中或失敗時為空物件。
      "best_step": 2, // 完成驗證所需的步驟或操作。
      "solution": [ // 完成驗證所需的步驟或操作。
        5, // 產品回傳的答案欄位,依目標網站的驗證協定使用。
        19 // 產品回傳的答案欄位,依目標網站的驗證協定使用。
      ],
      "answer": "EXAMPLE_VK_FORMATTED_ANSWER", // 識別出的文字或文字答案。
      "preview": "BASE64_PREVIEW" // 產品回傳的答案欄位,依目標網站的驗證協定使用。
    }
  }
}

建立任務會回傳任務 ID 和初始狀態。下方為查詢介面的完成結果,也可透過 WebSocket 接收答案。

答案字段文檔待補充,當前示例僅展示響應外層結構。

請求參數說明

字段類型必填說明
productCodestring是產品編碼,必須與 adapter 參數匹配。
adapterobject是產品專屬參數對象。
adapter.imagestring條件必填VK 旋轉驗證碼圖片的 Base64 內容。
adapter.stepsstring條件必填來自同一次 VK captchaNotRobot.getContent 回應、與 image 配對的非負整數有序非空陣列,不是最大旋轉次數或角度。保持原序列。相容包含 JSON 整數陣列的舊字串並轉換為陣列;單個 "3" 無效。
adapter.redirectUristring條件必填剛獲取的 VK 令牌挑戰跳轉 URL;與 image + steps 圖片模式二選一。
adapter.userAgentstring條件必填獲取挑戰時瀏覽器使用的 User-Agent。
adapter.proxyTypestring條件必填獲取挑戰時使用的代理協議,例如 http。
adapter.proxyAddressstring條件必填獲取挑戰時使用的代理主機或 IP 地址。
adapter.proxyPortinteger條件必填獲取挑戰時使用的代理端口。
adapter.proxyLoginstring否需要代理認證時填寫用戶名。
adapter.proxyPasswordstring否需要代理認證時填寫密碼。

任選以下一組欄位,並填完整組內欄位: image + steps / redirectUri + userAgent + proxyType + proxyAddress + proxyPort

回應參數說明

字段類型說明
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.best_stepinteger完成驗證所需的步驟或操作。
data.solution.solutionarray完成驗證所需的步驟或操作。
data.solution.solution[]integer產品回傳的答案欄位,依目標網站的驗證協定使用。
data.solution.answerstring識別出的文字或文字答案。
data.solution.previewstring產品回傳的答案欄位,依目標網站的驗證協定使用。

響應

HTTP 業務響應包含 code、msg 和 data;code 爲 0 表示成功。WebSocket 使用獨立的消息結構。

-1317
API Key 無效。
-1100 / -1101
請求參數錯誤或缺失。
-1401
餘額不足,請儲值後再建立任務
-1400 / -1001
系統或創建任務錯誤。
API文件