PRODUCT TEST WORKSPACE
Yidun Captcha
Captcha verification product
YIDUN_NE_CAPTCHA02 / REQUEST
請求預覽
POST /api/validator/create.cgi
{
"productCode" : "YIDUN_NE_CAPTCHA",
"adapter" : {
"websiteURL" : "https://example.com/register",
"websiteKey" : "YOUR_WEBSITEKEY"
}
}
03 / RESULT
響應示例
Task ID
—
{
"code" : 0,
"msg" : "操作成功",
"data" : {
"taskId" : "11111111-1111-4111-8111-111111111111",
"productCode" : "YIDUN_NE_CAPTCHA",
"state" : "SUCCEEDED",
"solution" : {
"token" : "EXAMPLE_TOKEN"
}
}
}
響應僅爲示例,不是真實任務結果。提交前請替換請求中的所有示例值。
狀態爲 SUCCEEDED 後讀取 data.solution。答案字段因產品而異,其他狀態可能返回空對象。
04 / API REFERENCE
Yidun Captcha · API
建立與查詢任務時,將 API Key 統一放在 HTTP apiKey 請求標頭中;JSON 請求本文只包含業務參數。
Content-Type: application/json apiKey: YOUR_API_KEY
請求示例
{
"productCode": "YIDUN_NE_CAPTCHA", // 產品編碼,必須與 adapter 參數匹配。
"adapter": { // 產品專屬參數對象。
"websiteURL": "https://example.com/register", // 目標網站完整 URL。
"websiteKey": "YOUR_WEBSITEKEY", // 目標站點的 CAPTCHA site key。
"userAgent": "YOUR_BROWSER_USER_AGENT", // 取自同一目標會話的實際瀏覽器 User-Agent。
"yidunGetLib": "YOUR_YIDUNGETLIB", // 取自同一目前易盾初始化或網路上下文的實際 yidunGetLib,目標未使用時省略。
"yidunApiServerSubdomain": "YOUR_YIDUNAPISERVERSUBDOMAIN", // 取自同一目前易盾初始化或網路上下文的實際 yidunApiServerSubdomain,目標未使用時省略。
"challenge": "YOUR_CHALLENGE", // 取自同一目前易盾初始化或網路上下文的實際 challenge,目標未使用時省略。
"hcg": "YOUR_HCG", // 取自同一目前易盾初始化或網路上下文的實際 hcg,目標未使用時省略。
"hct": 1779358333191, // 同一目標請求中的 Enterprise 數字時間標識,不是字串或本機時間。
"proxyType": "http", // 代理協定:http、socks4 或 socks5;目標有綁定要求時保持與目標會話相同的實際出口。
"proxyAddress": "YOUR_PROXY_HOST", // 可達代理的主機名稱或 IP,不含協定、憑證或連接埠。
"proxyLogin": "YOUR_PROXYLOGIN", // 可選代理認證使用者名稱,須與密碼成組提供。
"proxyPassword": "YOUR_PROXYPASSWORD", // 同一代理的可選密碼,與 proxyLogin 成組提供。
"proxyPort": 8080 // 代理 TCP 連接埠,1 至 65535 的整數。
}
}
請求標頭: apiKey: YOUR_API_KEY
註解用於說明欄位,複製後取得不含註解的標準 JSON。
響應示例
{
"code": 0, // 業務回傳碼,0 表示成功,其他值表示錯誤。
"msg": "操作成功", // 結果說明,成功時可能為空。
"data": { // 回應資料,介面報錯時可能為 null。
"taskId": "11111111-1111-4111-8111-111111111111", // 創建任務返回的任務 ID。
"productCode": "YIDUN_NE_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.userAgent | string | 否 | 取自同一目標會話的實際瀏覽器 User-Agent。 |
adapter.yidunGetLib | string | 否 | 取自同一目前易盾初始化或網路上下文的實際 yidunGetLib,目標未使用時省略。 |
adapter.yidunApiServerSubdomain | string | 否 | 取自同一目前易盾初始化或網路上下文的實際 yidunApiServerSubdomain,目標未使用時省略。 |
adapter.challenge | string | 否 | 取自同一目前易盾初始化或網路上下文的實際 challenge,目標未使用時省略。 |
adapter.hcg | string | 否 | 取自同一目前易盾初始化或網路上下文的實際 hcg,目標未使用時省略。 |
adapter.hct | integer | 否 | 同一目標請求中的 Enterprise 數字時間標識,不是字串或本機時間。 |
adapter.proxyType | string | 否 | 代理協定:http、socks4 或 socks5;目標有綁定要求時保持與目標會話相同的實際出口。 |
adapter.proxyAddress | string | 否 | 可達代理的主機名稱或 IP,不含協定、憑證或連接埠。 |
adapter.proxyLogin | string | 否 | 可選代理認證使用者名稱,須與密碼成組提供。 |
adapter.proxyPassword | string | 否 | 同一代理的可選密碼,與 proxyLogin 成組提供。 |
adapter.proxyPort | integer | 否 | 代理 TCP 連接埠,1 至 65535 的整數。 |
回應參數說明
| 字段 | 類型 | 說明 |
|---|---|---|
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
- 系統或創建任務錯誤。