配合式活体检测 API

接口说明

• 基于讯飞自研的人脸算法，可以通过用户提供的图片，对图片内人物眼睛是否睁开进行判断，并且返回得分。

• 部分开发语言demo如下，其他开发语言请参照文档进行开发，也欢迎热心的开发者到讯飞开放平台社区分享你们的demo。

• 集成配合式活体检测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/jpeg
图片大小	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编码的签名相关信息(签名基于hmac-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 401 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"
}

text字段base64解码示例

{
	"face_num" : 1,
	"face_1" : 
	{
		"ret" : 0,
		"x" : 32,
		"y" : 15,
		"w" : 246,
		"h" : 331,
		"eye_status" : "close",
		"eye_status_score" : 0.62309795618057251
		"eye_threshold" : 0.90000000000000002
	},
	"ret" : 0
}

text字段参数说明：

参数名	类型	描述	备注
face_num	int	图片内人脸数
ret	int	内部服务返回码	ret=0表示请求成功，否则请参考错误码表
face_n.ret	int	内部服务返回码	ret=0表示该人脸框人脸检测成功，否则请参考错误码表
face_n	object	表示第n个检测到的人脸
face_n.x	int	人脸框左上角x坐标
face_n.y	int	人脸框左上角y坐标
face_n.w	int	人脸框宽度
face_n.h	int	人脸框高度
face_n.eye_status	string	眼部状态	open: 睁眼 close: 闭眼
face_n.eye_status_score	float	眼部状态得分，分越高则睁眼可能性越高，反之亦然	返回范围：[0-1]
face_n.eye_threshold	float	眼部状态检测阈值	默认值：0.9

#常见问题

#配合式活体检测支持什么应用平台？

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

#配合式活体检测对人脸有什么要求吗？

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

curl --location -g --request POST 'http://dev-cn.your-api-server.comhttp[s]: //api.xf-yun.com/v1/private/s67c9c78c' \ --header 'Content-Type: application/json' \ --data-raw '{ "header": { "app_id": "xxxxxxxx", "status": 3 }, "parameter": { "s67c9c78c": { "service_kind": "face_status", "star_similarity_result": { "encoding": "utf8", "compress": "raw", "format": "json" } } }, "payload": { "input1": { "encoding": "jpg", "status": 3, "image": "/9j/4AAQSkZJR..." } } }'

{ "header": { "code": 0, "message": "string", "sid": "string" }, "payload": { "star_similarity_result": { "compress": "string", "encoding": "string", "format": "string", "text": "string" } } }

请求参数

Body 参数application/json

header

object

用于上传平台参数

必需

app_id

string

必需

在平台申请的appid信息

status

integer

必需

请求状态，请设置为3（代表一次传完）

parameter

object

必需

用于上传服务特性参数

s67c9c78c

object

用于上传功能参数

必需

payload

object

用于上传请求数据

必需

input1

object

必需

用于上传第一张图像数据

示例

返回响应

🟢200成功

application/json

Body

header

object

必需

协议头部，用于描述平台特性的参数

code

integer

必需

返回码 0表示会话调用成功（并不一定表示服务调用成功，服务是否调用成功以text字段中的ret为准）其它表示会话调用异常，详情请参考错误码。

message

string

描述信息

必需

sid

string

本次会话id

必需

payload

object

必需

数据段，用于携带响应的数据

star_similarity_result

object

必需

配合式活体检测响应数据块

配合式活体检测 API

接口说明#

#鉴权说明#

#鉴权结果#

#常见问题#

#配合式活体检测支持什么应用平台？#

#配合式活体检测对人脸有什么要求吗？#

请求参数

返回响应

接口说明

#鉴权说明

#鉴权结果

#常见问题

#配合式活体检测支持什么应用平台？

#配合式活体检测对人脸有什么要求吗？