PRODUCT TEST WORKSPACE

Friendly Captcha

Captcha verification product

FRIENDLY_CAPTCHA

02 / REQUEST

請求預覽

POST /api/validator/create.cgi

{
  "productCode" : "FRIENDLY_CAPTCHA",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "websiteKey" : "YOUR_WEBSITEKEY"
  }
}

03 / RESULT

響應示例

EXAMPLE

Task ID —

{
  "code" : 0,
  "msg" : "操作成功",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "FRIENDLY_CAPTCHA",
    "state" : "SUCCEEDED",
    "solution" : {
      "token" : "EXAMPLE_TOKEN"
    }
  }
}

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

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

04 / API REFERENCE

Friendly Captcha · API

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

Content-Type: application/json
apiKey: YOUR_API_KEY

結果及使用方法

TOKEN

按本產品的整合方式使用 solution.token，不要填入其他驗證碼產品欄位。遵循目標提交方式，並保持結果中要求的 User-Agent。取得 Token 不代表目標接受驗證。

有條件支援的流程

純 HTTP 提交 HTTP_SUBMIT
瀏覽器套用識別結果 BROWSER_RESULT

前提條件

優先使用與實際挑戰匹配的原生驗證碼產品，不預設使用通用 GRID。先確認產品及版本並讀取模型和指引；目標允許時選 HTTP_SUBMIT，否則在瀏覽器支援回填原生結果時選 BROWSER_RESULT。頁面出現圖片網格不代表產品就是 GRID。取得真實參數；缺少參數時回報阻塞，不能猜測。
按目標整合使用原生結果：回填規定的 Token 回應欄位或回呼；產品回傳挑戰標識與證明或答案欄位時，按契約成組替換或提交。保持目標會話及綁定條件，不混用新舊挑戰欄位，不僅替換圖片，也不假設識別服務能產生任意可移植的驗證碼與答案。
從同一目標及目前挑戰取得新鮮參數。遵守具體產品的網域、動作、挑戰或會話、IP、User-Agent 及有效期要求，不假設結果可以通用。回傳 Cookie 僅用於對應網域。
範例使用佔位值，不是可直接執行的挑戰。已說明結果欄位不代表目標驗證已通過，也不代表完成了即時可用性測試。不要提交未支援的欄位。
SUCCEEDED 僅表示已取得識別結果；還需分別確認目標網站接受驗證、目標業務操作成功。識別服務無法觀察這兩個結果。

參數來源

欄位	參數來源
`websiteURL`	從實際目標頁面、控件設定或接入協定讀取，確認具體產品與版本；不能替換為佔位值或其他網站的 key。
`websiteKey`	從實際目標頁面、控件設定或接入協定讀取，確認具體產品與版本；不能替換為佔位值或其他網站的 key。
`version`	從實際目標頁面、控件設定或接入協定讀取，確認具體產品與版本；不能替換為佔位值或其他網站的 key。
`moduleScript`	從目前目標挑戰、會話或其接入協定讀取新鮮值，不重用範例或其他挑戰的值。
`nomoduleScript`	從目前目標挑戰、會話或其接入協定讀取新鮮值，不重用範例或其他挑戰的值。

請求示例

POST /api/validator/create.cgi · JSONC

{
  "productCode": "FRIENDLY_CAPTCHA", // 產品編碼，必須與 adapter 參數匹配。
  "adapter": { // 產品專屬參數對象。
    "websiteURL": "https://example.com/register", // 目標網站完整 URL。
    "websiteKey": "YOUR_WEBSITEKEY", // 目標站點的 CAPTCHA site key。
    "version": "YOUR_VERSION", // Friendly Captcha 版本。
    "moduleScript": "YOUR_MODULESCRIPT", // Friendly Captcha module 腳本地址。
    "nomoduleScript": "YOUR_NOMODULESCRIPT" // Friendly Captcha nomodule 腳本地址。
  }
}

請求標頭: 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": "FRIENDLY_CAPTCHA", // 產品編碼，必須與 adapter 參數匹配。
    "state": "SUCCEEDED", // 任務狀態：CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
    "solution": { // SUCCEEDED 時的產品答案；處理中或失敗時為空物件。
      "token": "EXAMPLE_TOKEN" // 提交至目標網站的驗證權杖。
    }
  }
}

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

請求參數說明

字段	類型	必填	說明
`productCode`	string	是	產品編碼，必須與 adapter 參數匹配。
`adapter`	object	是	產品專屬參數對象。
`adapter.websiteURL`	string	是	目標網站完整 URL。
`adapter.websiteKey`	string	是	目標站點的 CAPTCHA site key。
`adapter.version`	string	否	Friendly Captcha 版本。
`adapter.moduleScript`	string	否	Friendly Captcha module 腳本地址。
`adapter.nomoduleScript`	string	否	Friendly Captcha nomodule 腳本地址。

回應參數說明

字段	類型	說明
`code`	integer	業務回傳碼，0 表示成功，其他值表示錯誤。
`msg`	string	結果說明，成功時可能為空。
`data`	object \| null	回應資料，介面報錯時可能為 null。
`data.taskId`	string	創建任務返回的任務 ID。
`data.productCode`	string	產品編碼，必須與 adapter 參數匹配。
`data.state`	string	任務狀態：CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
`data.solution`	object	SUCCEEDED 時的產品答案；處理中或失敗時為空物件。
`data.failure`	object \| omitted	僅 FAILED 或 EXPIRED 回傳的公開診斷，不含上游原始訊息；按失敗處理指引操作。
`data.failure.code`	string	失敗編碼
`data.failure.nextAction`	string	下一步
`data.solution.token`	string	提交至目標網站的驗證權杖。

響應

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

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

API文件