> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# hCaptcha 圖像識別 API 對接說明
> hCaptcha verification code recognition service 集成指南 - XHuoAPI
本文將介紹一種 hCaptcha 圖像識別 API 對接說明，它可以通過用戶輸入識別的內容和 hCaptcha 驗證碼圖像，最後返回需要點擊的小圖像的坐標，完成驗證。
## 申請流程
要使用 API，需要先到 [hCaptcha 圖像識別 API](https://api.xhuoapi.ai/documents/c9a5cc2f-e410-425f-857a-f8700205da6c) 對應頁面申請對應的服務，進入頁面之後，點擊「Acquire」按鈕，如圖所示：
如果你尚未登錄或註冊，會自動跳轉到登錄頁面邀請您來註冊和登錄，登錄註冊之後會自動返回當前頁面。
在首次申請時會有免費額度贈送，可以免費使用該 API。
## 基本使用
首先先了解下基本的使用方式，就是輸入需要處理 hCaptcha 驗證碼圖像，便可獲得處理後的結果，首先需要簡單地傳遞一個 `queries` 字段，這個就是具體 hCaptcha 驗證碼圖像，我們需要去一個有 hCaptcha 驗證碼網站中截取這個驗證碼圖片，示例網站鏈接為： `https://democaptcha.com/demo-form-eng/hcaptcha.html`，點擊複選框即可顯示具體的完整驗證碼圖片，如下圖所示：
其中 `queries` 字段是上文中驗證碼圖像的截圖，圖片大小建議不要超過 100kb，還需要對上面圖片紅色箭頭指向的區域進行截圖，並且還需要你自行壓縮圖片大小，並且還需要將它轉換為 Base64 編碼，如下圖所示：
同時還需要輸入跟驗證碼圖像相關的識別內容參數 `question`，這個支持中英文翻譯，可以直接傳相關的識別內容，由上文網頁圖像中黃色箭頭執行的內容可以看出 `question` 輸入的應為 `Please click on the UNIQUE object among the others.`。具體的內容如下：
可以看到這裡我們設置了 Request Headers，包括：
* `accept`：想要接收怎樣格式的響應結果，這裡填寫為 `application/json`，即 JSON 格式。
* `authorization`：調用 API 的密鑰，申請之後可以直接下拉選擇。
另外設置了 Request Body，包括：
* `queries`：Base64 編碼的驗證碼圖像列表。
* `question`：驗證碼圖像相關的識別內容參數，支持直接輸入中英文。
選擇之後，可以發現右側也生成了對應代碼，如圖所示：
點擊「Try」按鈕即可進行測試，如上圖所示，這裡我們就得到了如下結果：
```json theme={null}
{
"solution": {
"label": "Please click on the UNIQUE object among the others",
"box": [
"360",
"276"
],
"confidences": 0.6354503631591797
}
}
```
返回結果一共有多個字段，介紹如下：
* `solution`，此次 hCaptcha 驗證碼圖像任務處理後驗證結果。
* `label`，hCaptcha 驗證碼圖像所識別的內容。
* `box`，hCaptcha 驗證碼圖像識別結果的位置信息，它是由圖像的坐標信息構成。
* `confidences`，hCaptcha 驗證碼圖像識別後滿足識別內容的的置信度。
可以看到我們得到了處理 hCaptcha 驗證碼圖像的驗證結果，我們只需要根據結果中 `box` 的位置坐標信息對該驗證碼圖像進行模擬點擊該區域便可通過驗證。
下面將介紹如何通過結果的 `box` 的位置信息如何來點擊，首先是針對上傳的驗證碼圖片進行建立直角坐標系，其中中心原點在圖像的左下角，360 是對應的橫坐標，276 是對應的縱坐標，我們只需要通過模擬點擊驗證碼對應的坐標進行點擊即可，具體的圖像信息如下圖所示：
另外如果想生成對應的對接代碼，可以直接複製生成，例如 CURL 的代碼如下：
```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/captcha/recognition/hcaptcha' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"question": "Please click on the UNIQUE object among the others.",
"queries": ["iVBORw0KGgoAAAANSU.....eY+85KVlzKHav28uq/WLVhL2kHUlFMKUcZbL31S8bpd0pEPKxNllXAE2wgu3uEfj+BfAzOGelsQNFAAAAAElFTkSuQmCC"]
}'
}'
```
Python 的對接代碼如下：
```python theme={null}
import requests
url = "https://api.xhuoapi.ai/v1/captcha/recognition/hcaptcha"
headers = {
"accept": "application/json",
"authorization": "Bearer {token}",
"content-type": "application/json"
}
payload = {
"question": "Please click on the UNIQUE object among the others.",
"queries": ["iVBORw0KGgoAAAANSU.....eY+85KVlzKHav28uq/WLVhL2kHUlFMKUcZbL31S8bpd0pEPKxNllXAE2wgu3uEfj+BfAzOGelsQNFAAAAAElFTkSuQmCC"]
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
```
## 錯誤處理
在調用 API 時，如果遇到錯誤，API 會返回相應的錯誤代碼和信息。例如：
* `400 token_mismatched`：Bad request, possibly due to missing or invalid parameters.
* `400 api_not_implemented`：Bad request, possibly due to missing or invalid parameters.
* `401 invalid_token`：Unauthorized, invalid or missing authorization token.
* `429 too_many_requests`：Too many requests, you have exceeded the rate limit.
* `500 api_error`：Internal server error, something went wrong on the server.
### 錯誤響應示例
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## 結論
通過本文檔，您已經了解了如何使用 hCaptcha 圖像識別 API 讓用戶輸入識別的內容和 hCaptcha 驗證碼圖像，最後返回需要點擊的小圖像的坐標，完成驗證。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題，請隨時聯繫我們的技術支持團隊。