> ## 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 驗證碼圖片，僅需通過提交 Website Key 即可實現後台自動解碼，完成驗證。
## 申請流程
要使用 API，需要先到 [hCaptcha 協議識別 API](https://api.xhuoapi.ai/documents/34806b3a-f0f6-45c5-b8b1-143ced7b9393) 對應頁面申請對應的服務，進入頁面之後，點擊「Acquire」按鈕，如圖所示：
如果你尚未登入或註冊，會自動跳轉到登入頁面邀請您來註冊和登入，登入註冊之後會自動返回當前頁面。
在首次申請時會有免費額度贈送，可以免費使用該 API。
## 基本使用
首先先了解下基本的使用方式，就是輸入需要處理 hCaptcha 驗證碼的網站 URL，便可獲得處理後的結果，首先需要簡單地傳遞一個 `website_url` 字段，我們的示例網站是：`https://accounts.hcaptcha.com/demo`，我們需要在 `website_url` 頁面中獲取 `website_key`，首先需要打開這個網頁，按 F12 進入控制台，最後在 Element 頁面進行全局搜索 `hcaptcha-demo`，我們可以得到下面的結果：
其中 `data-sitekey` 對應的一串字符串便是 `website_key` 的值，下面是具體的參數結果：
可以看到這裡我們設置了 Request Headers，包括：
* `accept`：想要接收怎樣格式的響應結果，這裡填寫為 `application/json`，即 JSON 格式。
* `authorization`：調用 API 的密鑰，申請之後可以直接下拉選擇。
另外設置了 Request Body，包括：
* `website_url`：需要處理驗證碼的網站 URL。
* `website_key`：在 hCaptcha 中的網站密鑰標識符。
選擇之後，可以發現右側也生成了對應代碼，如圖所示：
點擊「Try」按鈕即可進行測試，如上圖所示，這裡我們就得到了如下結果：
```json theme={null}
{
"token": "P1_eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.hadwYXNza2V5xQda4nQzFgUbYJqILiiwbvyhjocSilg8RjFHvIHmCzmqUNZa9hesIWEVRx5KIbMVeAQzSTWCwXmiQrPZuIEmZz-ZPL6DPNmB3ZXtJNsVYRLdRyvWPTB7EYskJG85yDVor2TcgQFNqAahhKT3WXjtk3S54ZBhv7QvaImUmos8MWgUOvUZHsvUtojN-izWIrBkD1if_71quOHvcvEVTLcSLx9dOgzpNAJ8_6BmJEsGlPbMGnSKrS1QfpPyzvgrnpjjIY_6TMYwJrR0EwJgCdp_lfc4mkxl0NJsZt8D_q7jcv3v6jt1CZ2qbqF5_-i4y0MYnQMCm1T62xBPdiEyst_FtGuWxJllkrrmWN0edyWcWeasLcCS6qpRry0H7RU7DYQnML6dmQoZg15NT0tFrAYeLK7EwvJxzcFbvUQ-Tc5QVk7tzvKpDtUVfQeZmRRgxWbCFf6bAT1z0uUwdma1O1lcTkSZCC5cVTaprkkKE04Ov4aCIKg2N7WGj4r0AOykisAISX5oidF3gejDTJy9vU1hgaCYFOimnwRKyqRsJdznptzhzDOQuICuAHYT3is1sY26ltJGOZTdDKkt2i2owCoAylgLbBP8VjTOGrsM12IH3Xsy076O40RCG6zThWN5TFKSpl7PNA6l2KoW-P3_K9WORjx2DSvKTAwqcouSU-0Rc_8Hlq9cIuS1iDhiNfJnJ_zNy_2gXSR2j7NP7m_lsfwELKypKm6pPzIhOuz5RwPotfPQfXOMdF3Xy98iQiihZmuHENvLAhjV_W7NL9TK3THPwDTFriS8ghIncl02v-fVARXDiuFTvjjlegL7xbHgIrOhLpunsxLiwdImUWatEI9jqaf84X4BtoS0TGYo4pHkpIG10dhoz3vooeSToAws6tz7ZWSHm6naksZ41X_WIxd7N8P9yzxrbLgVv-nHia5qHQLDmiZf3alITKhtisennw8NpespaQIVZzw_B16bdUNKqHCCTLdFbr16-3KpRoHzOOU2kBhV-gDN0NiA3ecqIMnyMdnpKlUpnjJ5sMA3e0pKEX_Vbu8DE8zfkcwLIwCIb2BLrKEHnCvv4JX8TfBktzMc5oTtZyEu-E_6ew0mSm_nhVsGtmLXSsB81FP9VGGRd50buIXRNW4GFp3XdTmYyuN32kc-AHJ5kKDj2HGraHxKco0McT7nV2bgx97k-C7hgxL2x5t3lC97edphh2kt2-gXuTxxfB7K-ZG6w5d1MnRte4ZG7TxvPFFi5693IFRFbvcr-U3WyGZJmGGdfV55PnoIU9Qn-WDtBU4EXyvd_KTt-asHtI6VQiVSNzacemTfsu9WBF33f2gafDY4qqhyXDPNsu6BZCGMSBhxDPURY74OBr4mYOdhjELY07nSkr9RQtQwiiSa8B8XFlezCPafjgdbmmNzG3PXa3n23sSwVnJHpHhq79eTP_KeeCiqlCvNsHLEfiH5HCNRGp7v5b342wBk__BWFimJMvohz0rucTVYgVFBdTOomUTuqCPeUgDP3X6BnNqyVDRA-HrdRl-RkU6mnw-3-IwyMZQ-fEnFMzbGp3zaoY7Do2jKvKKILoq6Q8zlDYkrLwuXjDP-nernI2hxP9wVOUVmtq5Rs19RLUI4MNWZAqwG-wGnaoB756d8nfmh5XhFzvArE5bpL50FY1yJqv7nbPW7JNnkfZG80yVRrIZO_F9NEb3n4eiIzg9Gu9fv8ncyChiCCp-swK5B7_w-XsAlco98bO-YK-fFMJOhyt0PU8Zc-hYoCa6cLVTvhdPzIUA0CQOemg4Pz6PX6SVwLYSlOXYkzbrgBlyH5YBS3oaRCeavVLrJsKt0_KwHwgBa1mdP5mlYUpBDbKR4PKwknU7y111JH0B4fO39dOVA-zecvDG0bnuy98Jym4KUchZr1tXabMcM20mg1UvcxMfnKOx0ojBcVwYA7kPQK3EzMnwX9NbAzYP6IlMgjFK9ZM7HCXxN6J1_6kw10RT4O58-Pbh3cMSrZDfM-GuG7p7XrVpJrX8TD195DCJqx-DmVv3Bs3CiuCPTvGrSZ58KE4hQagidGreUD2WXxLBFfTv1RgM3eXMtROs7hddyBajIu401lxucNbpRB7lYV7pJwxG7LQoSZ2G2LzG8eFPVPIkDNVOa8nGzh-sWaF7kc7bVv-P4FXbLX0WCjvQRES2MCbXPyJ-OpZZXZcJy7SOsGY3jZbTkGoez19cRQLiFO35gA5l9FBptDKW-_yGemt5XeKsR_FwGPN9C-0k1E-28oB4iKo-h1zb2kJpilhnmG36Z59F5T6W77M7OD_N6VHRWuPClLElO09OrPLHbJmxq9JvMWjTg5JjEaqyTLyLXWgw0N3kZMCqJJeqNj5w5I7dpuJ6ScfXKVaT96v2UESebdbMFT7vkZAkFF8LIowkN56pNwXLHkB2KyIWR2WQL-335BEpQ0AVB6RX4kdociIhtvAdsIE6pvFIwkzyO0OvIHxzOwPxZKdmDmBVMu7YxJStrhY-XWCu4kO5gDIJ0iedPWKNleHDOZuZqGKhzaGFyZF9pZM4xrUyBomtyqDE1ZmUwNDhkonBkAA.dVWyVc6N3lx2ZJQ7NJ9aEsWA-KAIuQ4PMSKVGQuWyCA"
}
```
可以看到我們得到了處理 hCaptcha驗證碼 的驗證結果，然後我們可以用於POST或模擬提交給目標網站，一次性使用，有效期120s，建議在60s內使用，接下來將提供一段CURL版本將處理後token提交到目標網站來通過Recaptcha2驗證碼。
首先我們需要獲取網站是如何發送POST請求，這樣我們才能將生成的token傳入進去，我們需要先打開F12控制台，然後人工先通過一下，最後我們可以看到網站發送了一個POST請求，我們只需要查看這次的POST請求構造，具體的過程如下：
* 先人工通過驗證，具體的如下圖：
* 再點擊submit，觀看控制台的network變化，具體的如下圖：
* 分析此次提交的POST請求構造，最後可以右鍵該請求複製CURL的代碼，具體的如下圖：
由上圖分析可知，此次POST請求的URL為：`https://accounts.hcaptcha.com/demo`，我們僅需要提交參數 `g-recaptcha-response`、`h-captcha-response` 和 `email`，然後我們只需要將處理後的token傳入下面的data中即可，調用token驗證所對應CURL代碼如下：
```shell theme={null}
curl 'https://accounts.hcaptcha.com/demo' \
--data-raw 'email=&g-recaptcha-response={token}&h-captcha-response={token}'
```
調用token驗證所對應的Python代碼如下：
```python theme={null}
import requests
token = '{token}'
data = {
'email': '',
'g-recaptcha-response': token,
'h-captcha-response': token
}
response = requests.post('https://accounts.hcaptcha.com/demo',
data=data)
if response.status_code == 200:
print(response.text)
```
然後我們觀察控制台變得了這樣的結果：
最後我們就通過了hCaptcha驗證碼的驗證。
另外如果想生成對應的對接代碼，可以直接複製生成，例如 CURL 的代碼如下：
```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/captcha/token/hcaptcha' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"website_key": "a5f74b19-9e45-40e0-b45d-47ff91b7a6c2",
"website_url": "https://accounts.hcaptcha.com/demo"
}'
```
Python 的對接代碼如下：
```python theme={null}
import requests
url = "https://api.xhuoapi.ai/v1/captcha/token/hcaptcha"
headers = {
"accept": "application/json",
"authorization": "Bearer {token}",
"content-type": "application/json"
}
payload = {
"website_key": "a5f74b19-9e45-40e0-b45d-47ff91b7a6c2",
"website_url": "https://accounts.hcaptcha.com/demo"
}
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 驗證碼圖片，僅需通過提交 Website Key 即可實現後台自動解碼，完成驗證。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題，請隨時聯繫我們的技術支持團隊。