> ## 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.

# AI證件照製作 API 對接說明

> AI ID Photo Production 集成指南 - XHuoAPI

本文將介紹一種 AI證件照製作 API 對接說明，它是可以透過輸入人像照片URL以及自己喜歡的模板來製作各種風格的證件照。

## 申請流程

要使用 API，需要先到 [AI證件照製作 API](https://api.xhuoapi.ai/documents/bf7214a3-8447-4157-8a75-f5bb39d5ed1b) 對應頁面申請對應的服務，進入頁面之後，點擊「Acquire」按鈕，如圖所示：

![](https://cdn.xhuoapi.ai/q6ytrc.png)

如果你尚未登入或註冊，會自動跳轉到登入頁面邀請您來註冊和登入，登入註冊之後會自動返回當前頁面。

在首次申請時會有免費額度贈送，可以免費使用該 API。

## 基本使用

首先先了解下基本的使用方式，就是輸入需要處理人像圖像以及喜歡的AI證件照模板，便可獲得處理後的結果，首先需要簡單地傳遞一個 `image_urls` 欄位，這個就是需要處理人像圖像鏈接數組，如圖所示：

<p>
  <img src="https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg" width="500" className="m-auto" />
</p>

然後我們還需要輸入自己喜歡的模板，本文提供了八種受歡迎的模板，具體的模板可參考下文：

```json theme={null}
{
   "male_portrait":  男形象照,
   "male_portrait2":  男形象照（另一個版本）,
   "kindergarten":  幼兒園入園照,
   "logo_tshirt": 企業LogoT恤照,
   "wedding":  結婚登記照,
   "business_photo":  商務風寫真,
   "bob_suit": 黑西裝波波頭,
   "female_portrait":  女性形象照
}
```

之後我們還可以指定生成的速度參數 `mode`，一般分為兩種慢速 `relax` 和快速 `fast`，具體的內容如下：

<p>
  <img src="https://cdn.xhuoapi.ai/73xbla.png" width="500" className="m-auto" />
</p>

可以看到這裡我們設置了 Request Headers，包括：

* `accept`：想要接收怎樣格式的響應結果，這裡填寫為 `application/json`，即 JSON 格式。
* `authorization`：調用 API 的密鑰，申請之後可以直接下拉選擇。

另外設置了 Request Body，包括：

* `mode`：生成證件照的通道，主要有fast快速和relax慢速兩種，當使用relax強烈推薦使用下面的參數 `callback_url`。
* `template`：證件照模板的風格。
* `image_urls`：需要上傳的證件照人像鏈接。
* `callback_url`：需要回調結果的URL。

選擇之後，可以發現右側也生成了對應代碼，如圖所示：

<p>
  <img src="https://cdn.xhuoapi.ai/yp49hc.png" width="500" className="m-auto" />
</p>

點擊「Try」按鈕即可進行測試，如上圖所示，這裡我們就得到了如下結果：

```json theme={null}
{
  "success": true,
  "task_id": "ae1e4948-dba1-4a6f-87af-67961b647428",
  "data": [
    {
      "id": "202411031951124776",
      "image_url": "https://platform.cdn.xhuoapi.ai/headshots/ae1e4948-dba1-4a6f-87af-67961b647428.png",
      "template": "男形象照"
    },
    {
      "id": "202411031951128490",
      "image_url": "https://platform.cdn.xhuoapi.ai/headshots/ae1e4948-dba1-4a6f-87af-67961b647428.png",
      "template": "男形象照"
    }
  ]
}
```

返回結果一共有多個欄位，介紹如下：

* `success`，此時證件照生成任務的狀態情況。
* `task_id`，此時證件照生成任務ID。
* `data`，此時證件照生成任務的結果列表。
  * `id`，此時證件照生成任務的照片ID。
  * `image_url`，此時證件照生成任務的圖片鏈接。
  * `template`，此時證件照生成任務的證件照模板名稱。

可以看到我們得到了根據模板與人像圖片得到滿意的證件照信息，我們只需要根據結果中 `data` 的圖片鏈接地址獲取證件照即可。

另外如果想生成對應的對接代碼，可以直接複製生成，例如 CURL 的代碼如下：

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/headshots/generate' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mode": "fast",
  "template": "male_portrait",
  "image_urls": ["https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg"]
}'
```

## 異步回調

由於 AI證件照生成的時間相對較長，大約需要 1-2 分鐘，如果 API 長時間無響應，HTTP 請求會一直保持連接，導致額外的系統資源消耗，所以本 API 也提供了異步回調的支持。

整體流程是：客戶端發起請求的時候，額外指定一個 `callback_url` 欄位，客戶端發起 API 請求之後，API 會立馬返回一個結果，包含一個 `task_id` 的欄位信息，代表當前的任務 ID。當任務完成之後，生成證件照的結果會通過 POST JSON 的形式發送到客戶端指定的 `callback_url`，其中也包括了 `task_id` 欄位，這樣任務結果就可以通過 ID 關聯起來了。

下面我們通過示例來了解下具體怎樣操作。

首先，Webhook 回調是一個可以接收 HTTP 請求的服務，開發者應該替換為自己搭建的 HTTP 伺服器的 URL。此處為了方便演示，使用一個公開的 Webhook 樣例網站 [https://webhook.site/，打開該網站即可得到一個](https://webhook.site/，打開該網站即可得到一個) Webhook URL，如圖所示：

![](https://cdn.xhuoapi.ai/sb4p3v.png)

將此 URL 複製下來，就可以作為 Webhook 來使用，此處的樣例為 `https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a`。

接下來，我們可以設置欄位 `callback_url` 為上述 Webhook URL，同時填入人像圖片鏈接以及模板，本文推薦在參數 `mode` 為 `relax` 時使用異步回調，具體的內容如圖所示：

<p>
  <img src="https://cdn.xhuoapi.ai/opt326.png" width="500" className="m-auto" />
</p>

點擊運行，可以發現會立即得到一個結果，如下：

```
{
  "task_id": "763b1450-8804-434f-acc7-d713be73a28f"
}
```

稍等片刻，我們可以在 `https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a` 上觀察到生成歌曲的結果，如圖所示：
![](https://cdn.xhuoapi.ai/ym6fw1.png)

內容如下：

```json theme={null}
{
    "success": true,
    "task_id": "763b1450-8804-434f-acc7-d713be73a28f",
    "data": [
        {
            "id": "202411032010131366",
            "image_url": "https://platform.cdn.xhuoapi.ai/headshots/763b1450-8804-434f-acc7-d713be73a28f.png",
            "template": "男形象照"
        },
        {
            "id": "202411032010132420",
            "image_url": "https://platform.cdn.xhuoapi.ai/headshots/763b1450-8804-434f-acc7-d713be73a28f.png",
            "template": "男形象照"
        }
    ]
}
```

可以看到結果中有一個 `task_id` 欄位，其他的欄位都和上文類似，通過該欄位即可實現任務的關聯。

## 錯誤處理

在調用 API 時，如果遇到錯誤，API 會返回相應的錯誤代碼和信息。例如：

* `400 token_mismatched`：錯誤的請求，可能是由於缺少或無效的參數。
* `400 api_not_implemented`：錯誤的請求，可能是由於缺少或無效的參數。
* `401 invalid_token`：未授權，無效或缺少授權令牌。
* `429 too_many_requests`：請求過多，您已超過速率限制。
* `500 api_error`：內部伺服器錯誤，伺服器出現問題。

### 錯誤響應示例

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 結論

通過本文檔，您已經了解了如何使用 AI證件照製作 API 可通過輸入人像照片URL以及自己喜歡的模板來製作各種風格的證件照。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題，請隨時聯繫我們的技術支持團隊。