科大讯飞人脸比对方案 demo python3语言API文档

接口说明

基于科大讯飞自研的人脸算法，可实现对比两张照片中的人脸信息，判断是否是同一个人并返回相似度得分。

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

内容	说明
传输方式	http[s] (为提高安全性，强烈推荐https)
请求地址	http[s]: //api.xf-yun.com/v1/private/s67c9c78c 注：服务器IP不固定，为保证您的接口稳定，请勿通过指定IP的方式调用接口，使用域名方式调用
请求行	POST /v1/private/s67c9c78c HTTP/1.1
接口鉴权	签名机制，详情请参照下方鉴权认证
字符编码	UTF-8
响应格式	统一采用JSON格式
开发语言	任意，只要可以向讯飞云服务发起HTTP请求的均可
适用范围	任意操作系统，但因不支持跨域不适用于浏览器
图片格式	jpg/png/bmp
图片大小	base64编码后大小不超过4M
图片要求	清晰的人脸照片，人脸大小不小于30*30像素，其中人脸俯仰角、左右偏航角、人脸翻转角60°以内识别效果更好

#鉴权说明

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。 通过在请求地址后面加上鉴权相关参数的方式，参数具体如下： http示例url：

https://api.xf-yun.com/v1/private/s67c9c78c?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iSk5od3prMWtLYjUwdUVGbEUxS2xCbk83K09NTjNZUk5LZVFsYzVMYVltTT0i&host=api.xf-yun.com&date=Fri%2C+17+Jul+2020+06%3A26%3A58+GMT

鉴权参数：

参数	类型	必须	说明	示例
host	string	是	请求主机	api.xf-yun.com
date	string	是	当前时间戳，RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z")	Fri, 17 Jul 2020 06:26:58 GMT
authorization	string	是	使用base64编码的签名相关信息(签名基于hamc-sha256计算)	参考下方详细生成规则

• date参数生成规则：

date必须是UTC+0或GMT时区，RFC1123格式(Fri, 17 Jul 2020 06:26:58 GMT)。
服务端会对date进行时钟偏移检查，最大允许300秒的偏差，超出偏差的请求都将被拒绝。

• authorization参数生成格式：

1）获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台，创建一个应用后打开人脸比对页面可以获取，均为32位字符串。

2）参数authorization base64编码前（authorization_origin）的格式如下。

api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"

其中 api_key 是在控制台获取的APIKey，algorithm 是加密算法（仅支持hmac-sha256），headers 是参与签名的参数（见下方注释）。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串，详见下方。

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

3）signature的原始字段(signature_origin)规则如下。

signature原始字段由 host，date，request-line三个参数按照格式拼接成，
拼接的格式为(\n为换行符,’:’后面有一个空格)：

host: $host\ndate: $date\n$request-line

假设

请求url = api.xf-yun.com
date = Fri, 17 Jul 2020 06:26:58 GMT

那么 signature原始字段(signature_origin)则为：

host: api.xf-yun.com
date: Fri, 17 Jul 2020 06:26:58 GMT
POST /v1/private/s67c9c78c HTTP/1.1

4）使用hmac-sha256算法结合apiSecret对signature_origin签名，获得签名后的摘要signature_sha。

signature_sha=hmac-sha256(signature_origin,$apiSecret)

其中 apiSecret 是在控制台获取的APISecret

5）使用base64编码对signature_sha进行编码获得最终的signature。

signature=base64(signature_sha)

假设

APISecret = apisecretXXXXXXXXXXXXXXXXXXXXXXX	
date = Fri, 17 Jul 2020 06:26:58 GMT

则signature为

signature=JNhwzk1kKb50uEFlE1KlBnO7+OMN3YRNKeQlc5LaYmM=

6）根据以上信息拼接authorization base64编码前（authorization_origin）的字符串，示例如下。

api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="JNhwzk1kKb50uEFlE1KlBnO7+OMN3YRNKeQlc5LaYmM="

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

7）最后再对authorization_origin进行base64编码获得最终的authorization参数。

authorization = base64(authorization_origin)
示例：
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iSk5od3prMWtLYjUwdUVGbEUxS2xCbk83K09NTjNZUk5LZVFsYzVMYVltTT0i

#鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

HTTP Code	说明	错误描述信息	解决方法
401	缺少authorization参数	{"message":"Unauthorized"}	检查是否有authorization参数，详情见authorization参数详细生成规则
401	签名参数解析失败	{“message”:”HMAC signature cannot be verified”}	检查签名的各个参数是否有缺失是否正确，特别确认下复制的api_key是否正确
401	签名校验失败	{“message”:”HMAC signature does not match”}	签名验证失败，可能原因有很多。 1. 检查api_key,api_secret 是否正确。 2.检查计算签名的参数host，date，request-line是否按照协议要求拼接。 3. 检查signature签名的base64长度是否正常(正常44个字节)。
403	时钟偏移校验失败	{“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”}	检查服务器时间是否标准，相差5分钟以上会报此错误

认证失败返回示例：

HTTP/1.1 403 Forbidden
Date: Thu, 06 Dec 2018 07:55:16 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match"
}

#请求参数

在调用业务接口时，都需要在 Http Request Body 中配置以下参数，请求数据均为json字符串。
请求参数示例：

{
  "header": {
    "app_id": "XXXXXXXX",
    "status": 3
  },
  "parameter": {
    "s67c9c78c": {
      "service_kind": "face_compare",
      "face_compare_result": {
        "encoding": "utf8",
        "compress": "raw",
        "format": "json"
      }
    }
  },
  "payload": {
    "input1": {
      "encoding": "jpg",
      "status": 3,
      "image": "/4AAQSkZJRgA..."
    },
    "input2": {
      "encoding": "jpg",
      "status": 3,
      "image": "/9j/4AAQSkZJ..."
    }
  }
}

请求参数说明：

参数名	类型	必传	描述
header	object	是	用于上传平台参数
header.app_id	string	是	在平台申请的appid信息
header.status	string	是	请求状态，取值范围为：3（一次传完）
parameter	object	是	用于上传服务特性参数
parameter.s67c9c78c	object	是	用于上传功能参数
parameter.s67c9c78c.service_kind	string	是	请求功能类型，取值范围为：face_compare
parameter.s67c9c78c.face_compare_result	object	是	用于上传响应数据参数
parameter.s67c9c78c.face_compare_result.encoding	string	否	文本编码，可选值：utf8（默认值）
parameter.s67c9c78c.face_compare_result.compress	string	否	文本压缩格式，可选值：raw（默认值）
parameter.s67c9c78c.face_compare_result.format	string	否	文本格式，可选值：json（默认值）
payload	object	是	用于上传请求数据
payload.input1	object	是	用于上传第一张图像数据
payload.input1.encoding	string	否	第一张图像编码 可选值： jpg:jpg格式(默认值) jpeg:jpeg格式 png:png格式 bmp:bmp格式
payload.input1.image	string	是	第一张图像数据，base64编码，需保证图像文件大小base64编码后不超过4MB
payload.input1.status	int	否	第一张数据状态，取值范围为：3（一次传完）
payload.input2	object	是	用于上传第二张图像数据
payload.input2.encoding	string	否	第二张图像编码 可选值： jpg:jpg格式(默认值) jpeg:jpeg格式 png:png格式 bmp:bmp格式
payload.input2.image	string	是	第二张图像数据，base64编码，需保证图像文件大小base64编码后不超过4MB
payload.input2.status	int	否	第二张数据状态，取值范围为：3（一次传完）

#返回结果

如出现错误码，可到 这里 查询。
返回参数示例：

{
  "header": {
    "code": 0,
    "message": "success",
    "sid": "asexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "payload": {
    "face_compare_result": {
      "compress": "raw",
      "encoding": "utf8",
      "format": "json",
      "text": "ewoJInJldCIgOiAwLAoJInNjb3JlIiA6IDAuOTk2MTg2MDc3NTk0NzU3MDgKfQo="
    }
  }
}

返回参数说明：

参数名	类型	描述
header	object	协议头部，用于描述平台特性的参数
header.sid	string	本次会话id
header.code	int	返回码 0表示会话调用成功（并不一定表示服务调用成功，服务是否调用成功以text字段中的ret为准） 其它表示会话调用异常，详情请参考错误码。
header.message	string	描述信息
payload	object	数据段，用于携带响应的数据
payload.face_compare_result	object	人脸比对响应数据块
payload.face_compare_result.compress	string	文本压缩格式，仅在设置了parameter.s67c9c78c.face_compare_result.compress参数时返回
payload.face_compare_result.encoding	string	文本编码，仅在设置了parameter.s67c9c78c.face_compare_result.encoding参数时返回
payload.face_compare_result.format	string	文本格式，仅在设置了parameter.s67c9c78c.face_compare_result.format参数时返回
payload.face_compare_result.text	string	人脸比对返回结果，需要对其进行base64解码，解码后的返回字段如下

text字段base64解码示例

{
	"ret" : 0,
	"score" : 0.99618607759475708
}

text字段参数说明：

参数名	类型	描述	备注
ret	int	内部服务返回值	ret=0表示请求成功，否则请参考错误码表
score	float	人脸相似度	最小值:0 最大值:1。 建议高于0.67认为是同一个人。 建议使用仅包含一张人脸的照片进行比对，若照片中含有多张人脸，引擎会选择其中人脸置信度最高的人脸进行比较，可能会影响比对结果。

#常见问题

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

答：人脸比对可以对比两张照片中的人脸信息，判断是否是同一个人。

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

答：目前支持Web API应用平台。

#人脸比对对人脸有什么要求吗？

答：需要清晰的人脸照片，人脸大小不小于30*30像素，其中人脸俯仰角、左右偏航角、人脸翻转角60°以内识别效果更好。