AI ID Photo Task API 集成与使用指南

在数字化时代，个人身份证明照片的处理变得越来越重要。Ace Data Cloud 提供了 AI ID Photo Task API，这是一款强大的工具，旨在帮助用户查询 AI ID Photo Production API 生成的任务执行状态。本文将为您提供详细的集成说明，助您轻松实现 API 的功能。

环境准备

在使用 AI ID Photo Task API 之前，您需要在 AI ID Photo Production API 页面上申请相应的服务。申请后，您将获得一个任务 ID，该任务 ID 可用于查询相关任务状态。

详细步骤

申请服务

1. 访问 AI ID Photo Production API 页面。
2. 登录或注册您的账户（如果尚未登录）。
3. 复制生成的任务 ID，如下图所示：

1. 接着，前往 AI ID Photo Task API 页面，点击"获取"按钮，如下图所示：

请求示例

使用 AI ID Photo Task API 查询任务结果。假设您有一个任务 ID：16f96e95-d95c-46ef-b183-139b9bd1aebd，以下是如何传入该任务 ID 的示例。

设置请求头和请求体

请求头包括：

• accept: 指定响应格式为 JSON，设置为 application/json。
• authorization: API 调用的密钥，在申请后可直接选择。

请求体包括：

• id: 上传的任务 ID。
• action: 任务的操作方法。

设置示例如下：

代码示例

在页面右侧，您可以看到不同语言的代码示例，以下是几种示例代码：

CURL

curl -X POST 'https://api.acedata.cloud/headshots/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
  "action": "retrieve"
}'

Python

import requests

url = "https://api.acedata.cloud/headshots/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
    "action": "retrieve"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

响应示例

成功请求后，API 将返回 ID 照片任务的详细信息，例如：

{
  "_id": "67276ab6550a4144a53b6036",
  "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
  "response": {
    "success": true,
    "data": [
      {
        "image_url": "https://platform.cdn.acedata.cloud/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png"
      }
    ]
  }
}

批量查询操作

如果需要查询多个任务 ID 的详细信息，可以使用批量查询操作，选择 retrieve_batch 作为操作方法。

请求体设置

请求体包括：

• ids: 上传的任务 ID 数组。
• action: 任务的操作方法。

代码示例

以下是使用 CURL 和 Python 的示例代码：

CURL

curl -X POST 'https://api.acedata.cloud/headshots/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["16f96e95-d95c-46ef-b183-139b9bd1aebd","5213468b-6b96-4ad4-9c6a-657bd438d299"],
  "action": "retrieve_batch"
}'

Python

import requests

url = "https://api.acedata.cloud/headshots/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "ids": ["16f96e95-d95c-46ef-b183-139b9bd1aebd","5213468b-6b96-4ad4-9c6a-657bd438d299"],
    "action": "retrieve_batch"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

错误处理

在调用 API 时，如果发生错误，API 会返回相应的错误代码和消息。例如：

• 400 token_mismatched: 请求错误，可能由于缺少或无效的参数。
• 401 invalid_token: 未授权，令牌无效或缺失。
• 429 too_many_requests: 请求过多，超出速率限制。

错误响应示例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  }
}

总结

通过以上步骤，您可以成功使用 AI ID Photo Task API 查询单个或批量 ID 照片任务的详细信息。如果您有任何问题，请随时联系技术支持团队。

• Ace Data Cloud 主页
• API 文档
• 技术支持

标签：#API集成 #AceDataCloud #Python教程 #CURL #技术文档