API文档中心

全面的API文档和开发者资源,帮助您快速集成和使用我们的API服务

快速开始

几分钟内开始使用我们的API服务

1

1. 创建账户

注册并创建您的开发者账户,获取API密钥

注册账户
2

2. 获取API密钥

在控制台创建并管理您的API密钥

前往控制台
3

3. 集成API

按照示例代码集成API到您的应用中

查看示例

代码示例

JavaScript

JavaScript
// 使用JavaScript/TypeScript调用API
const apiKey = 'YOUR_API_KEY';
  
async function detectFaces(imageUrl) {
  const response = await fetch(
    'https://api.example.com/v1/face/detect',
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'X-API-Key': apiKey
      },
      body: JSON.stringify({
        image_url: imageUrl
      })
    }
  );
  
  return await response.json();
}

Python

Python
# 使用Python调用API
import requests

api_key = "YOUR_API_KEY"

def detect_faces(image_url):
    url = "https://api.example.com/v1/face/detect"
    headers = {
        "Content-Type": "application/json",
        "X-API-Key": api_key
    }
    payload = {
        "image_url": image_url
    }
    
    response = requests.post(url, json=payload, headers=headers)
    return response.json()

认证与授权

API密钥认证

所有API请求都需要通过API密钥进行认证。您可以在控制台创建和管理您的API密钥。

在请求头中传递API密钥:

X-API-Key: your_api_key_here

请确保您的API密钥安全,不要在客户端代码中暴露它,最好通过服务器端进行API调用。

API参考

详细了解所有可用的API端点及其参数

人脸识别API

POST

人脸检测

检测图像中的人脸,并返回人脸位置和关键点信息

/v1/face/detect

参数

名称类型必填描述
image_urlstring图像的URL地址
return_attributesstring[]需要返回的人脸属性,如age, gender, emotion等

响应

状态码描述
200成功返回检测结果
400请求参数错误
401未授权或API密钥无效
POST

人脸比对

比对两张图片中的人脸,计算相似度

/v1/face/compare

参数

名称类型必填描述
image_url1string第一张图像的URL地址
image_url2string第二张图像的URL地址

响应

状态码描述
200成功返回比对结果
400请求参数错误
401未授权或API密钥无效

3D重建API

POST

图像到3D模型

从多张图像重建3D模型

/v1/3d/reconstruct

参数

名称类型必填描述
image_urlsstring[]多张图像的URL地址数组
qualitystring重建质量,可选值:low, medium, high

响应

状态码描述
200成功返回3D模型信息
400请求参数错误
401未授权或API密钥无效

常见问题

如何获取API密钥?

注册并登录账户后,在控制台的"API密钥"页面创建和管理您的API密钥。

API调用有次数限制吗?

是的,根据您的套餐不同,每月有不同的API调用次数限制。您可以在控制台查看您的使用情况。

API支持哪些图像格式?

我们的API支持JPEG、PNG、BMP和WEBP格式的图像。图像大小限制为10MB。

如何报告问题或获取支持?

您可以通过联系我们页面提交问题或发送邮件至support@chhtech.com获取支持。

准备好开始使用我们的API了吗?

立即注册账户,获取API密钥,开始构建令人惊叹的应用程序。