> ## 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" 버튼을 클릭합니다. 아래 그림과 같습니다:
로그인이나 등록이 되어 있지 않으면 자동으로 로그인 페이지로 이동하여 등록 및 로그인을 요청합니다. 로그인 및 등록 후에는 자동으로 현재 페이지로 돌아옵니다.
첫 신청 시 무료 사용량이 제공되며, 해당 API를 무료로 사용할 수 있습니다.
## 기본 사용
먼저 기본 사용 방법을 이해해야 합니다. 처리할 인물 이미지와 선호하는 AI 증명사진 템플릿을 입력하면 처리된 결과를 얻을 수 있습니다. 먼저 간단히 `image_urls` 필드를 전달해야 합니다. 이는 처리할 인물 이미지 링크 배열입니다. 아래 그림과 같습니다:
그 다음, 선호하는 템플릿을 입력해야 합니다. 본문에서는 여덟 가지 인기 있는 템플릿을 제공합니다. 구체적인 템플릿은 아래를 참조하십시오:
```json theme={null}
{
"male_portrait": 남성 이미지 사진,
"male_portrait2": 남성 이미지 사진(다른 버전),
"kindergarten": 유치원 입학 사진,
"logo_tshirt": 기업 로고 티셔츠 사진,
"wedding": 결혼 등록 사진,
"business_photo": 비즈니스 스타일 사진,
"bob_suit": 검은색 정장 보브 헤어,
"female_portrait": 여성 이미지 사진
}
```
그 후, 생성 속도 매개변수 `mode`를 지정할 수 있습니다. 일반적으로 두 가지로 나뉘며, 느린 속도 `relax`와 빠른 속도 `fast`가 있습니다. 구체적인 내용은 아래와 같습니다:
여기서 요청 헤더를 설정할 수 있습니다. 포함된 내용은 다음과 같습니다:
* `accept`: 어떤 형식의 응답 결과를 받고 싶은지, 여기서는 `application/json`으로 JSON 형식으로 입력합니다.
* `authorization`: API 호출을 위한 키로, 신청 후 바로 선택할 수 있습니다.
또한 요청 본체를 설정합니다. 포함된 내용은 다음과 같습니다:
* `mode`: 증명사진 생성의 경로로, 주로 fast(빠른)와 relax(느린) 두 가지가 있습니다. relax를 사용할 경우 아래의 매개변수 `callback_url`을 강력히 추천합니다.
* `template`: 증명사진 템플릿의 스타일.
* `image_urls`: 업로드할 증명사진 인물 링크.
* `callback_url`: 결과를 회신받을 URL.
선택 후, 오른쪽에 해당 코드가 생성된 것을 확인할 수 있습니다. 아래 그림과 같습니다:
"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는 즉시 결과를 반환하며, 여기에는 현재 작업 ID를 나타내는 `task_id` 필드 정보가 포함됩니다. 작업이 완료되면 증명사진 생성 결과가 POST JSON 형식으로 클라이언트가 지정한 `callback_url`로 전송되며, 여기에도 `task_id` 필드가 포함되어 있어 작업 결과를 ID로 연관시킬 수 있습니다.
아래 예제를 통해 구체적인 작업 방법을 알아보겠습니다.
먼저, Webhook 콜백은 HTTP 요청을 수신할 수 있는 서비스로, 개발자는 자신이 구축한 HTTP 서버의 URL로 교체해야 합니다. 편리한 시연을 위해 공개 Webhook 샘플 사이트인 [https://webhook.site/를](https://webhook.site/를) 사용합니다. 해당 사이트를 열면 Webhook URL을 얻을 수 있습니다. 아래 그림과 같습니다:
이 URL을 복사하여 Webhook으로 사용할 수 있습니다. 여기 샘플은 `https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a`입니다.
그 다음, `callback_url` 필드를 위의 Webhook URL로 설정하고, 인물 사진 링크와 템플릿을 입력합니다. 본문에서는 매개변수 `mode`가 `relax`일 때 비동기 콜백을 사용하는 것을 추천합니다. 구체적인 내용은 아래 그림과 같습니다:
실행 버튼을 클릭하면 즉시 결과를 얻을 수 있습니다. 결과는 다음과 같습니다:
```
{
"task_id": "763b1450-8804-434f-acc7-d713be73a28f"
}
```
잠시 후, `https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a`에서 생성된 결과를 확인할 수 있습니다. 아래 그림과 같습니다:
내용如下：
```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": "가져오기 실패"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## 결론
이 문서를 통해 AI 증명사진 제작 API를 사용하는 방법을 이해하셨습니다. 인물 사진 URL과 원하는 템플릿을 입력하여 다양한 스타일의 증명사진을 제작할 수 있습니다. 이 문서가 API를 더 잘 연동하고 사용하는 데 도움이 되기를 바랍니다. 질문이 있으시면 언제든지 기술 지원 팀에 문의해 주십시오.