# 人脸比对sensetime API 文档

# 接口说明

基于商汤的人脸算法，对两张通过接口上传的人脸照片进行比对，来判断是否为同一个人。若上传的照片中包含 exif 方向信息，我们会按此信息旋转、翻转后再做后续处理。同时，我们还提供自动旋转功能，当照片方向混乱且 exif 方向信息不存在或不正确的情况下，服务会根据照片中人脸方向来检查可能正确的方向，并按照正确的方向提供人脸检测结果。

该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 接口要求

集成人脸比对API时，需按照以下要求。

# 接口调用流程

注： 若需配置IP白名单，请前往控制台。IP白名单规则请参照 IP白名单。

1. 通过接口密钥基于MD5计算签名，将签名以及其他参数放在Http Request Header中，详见下方 请求头 。
2. 将图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求体 。
3. 向服务器端发送Http请求后，接收服务器端的返回结果，返回结果详见各接口的详细说明。

接口地址示例：

	POST http[s]://api.xfyun.cn/v1/service/v1/image_identify/face_verification HTTP/1.1
	Content-Type:application/x-www-form-urlencoded; charset=utf-8

# 白名单

在调用该业务接口时

• 若关闭IP白名单，接口认为IP不限，不会校验IP。
• 若打开IP白名单，则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中，对于没有配置到白名单中的IP发来的请求，服务端会拒绝服务。

IP白名单规则

• IP白名单，在 控制台-我的应用-相应服务的应用管理卡片上 编辑，保存后五分钟左右生效；
• 不同Appid的不同服务都需要分别设置IP白名单；
• IP白名单需设置为外网IP，请勿设置局域网IP；；
• 如果服务器返回结果如下所示(illegal client_ip)，则表示由于未配置IP白名单或配置有误，服务端拒绝服务。

{
    "code":"10105",
    "desc":"illegal access|illegal client_ip",
    "data":"",
    "sid":"xxxxxx"
}

# 接口请求参数

# 请求头

在 Http Request Header 中配置以下参数。

# 授权认证

以下参数用于授权认证：

注：

• APIKey：接口密钥，在讯飞开放平台控制台添加相应服务后即可获取，调用方注意保管，如泄露，可到控制台提交工单联系技术人员重置；
  
• X-CheckSum 有效期：出于安全性考虑，每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算)，同时 X-CurTime 要与标准时间同步，否则时间相差太大，服务端会直接认为 X-CurTime 无效；
  
• BASE64 编码采用 MIME 格式，字符包括大小写字母各26个，加上10个数字，和加号 + ，斜杠 / ，一共64个字符。
  

*X-CheckSum *生成示例：

String APIKey="abcd1234"; 
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);

# 业务参数

X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串，原始 JSON 串各字段说明如下：

X-Param生成示例：

	原始JSON串：
	{
	    "auto_rotate": True,
	}
	BASE64编码（即X-Param）：
	ewoJICAgICJhdXRvX3JvdGF0ZSI6ICJ0cnVlIiwKCX0=

# 请求体

以POST表单的形式提交以下参数：

注：
图片格式必须为JPG（JPEG）、BMP、PNG、GIF、TIFF之一。
图片宽和高必须大于 8px，小于等于 4000px。
要求两张图片编码后大小不超过5M。 一般基础类库会默认进行urlencode处理，请注意不要重复处理。

java示例(可参考示例demo)：

	first_image = urlencode(base64(图片1)) & second_image = urlencode(base64(图片2))

# 接口返回参数

返回值为 json 串，各字段如下：

data中得分阈值与错误率对应关系：

建议阈值：0.7~0.8

示例如下：

失败：

{
  "code": "10105",
  "data": 0,
  "desc": "illegal access|illegal X-CheckSum",
  "sid": "wsr00127c......"
}

成功：

{
  "code": "0",
  "data": 0.903714,
  "desc": "success",
  "sid": "wsr000f06......"
}

# 调用示例

人脸比对demo go语言

人脸比对demo php语言

人脸比对demo python3语言

人脸比对demo java语言

人脸比对demo c#语言

# 常见问题

# 人脸比对主要有什么功能？

答：对两张上传的人脸照片进行比对，来判断是否为同一个人。

# 人脸比对对上传的图片有什么要求？

答：（1）格式必须为 JPG（JPEG），BMP，PNG，GIF，TIFF 之一； （2）宽和高必须大于 8px，小于等于 4000px； （3）文件尺寸小于等于 5 MB。

# 人脸比对支持活体检测吗？

答：人脸比对是支持静态照片的对比，不支持活体检测功能。

# 人脸比对支持什么应用平台？

答：支持Web api应用平台。

# 人脸比对怎么免费使用？

答：登录讯飞开放平台，进入人脸比对产品页面，点击“服务管理”，创建应用，可免费使用500次，授权期限为1个月。

# 人脸比对服务量怎么购买？

答：控制台对应人脸比对服务--->实时用量--->点击购买服务量，填好相关信息，商务工作人员会及时与您联系。