# 配合式活体检测 API文档

# 接口说明

基于讯飞自研的人脸算法，可以通过用户提供的图片，对图片内人物眼睛是否睁开进行判断，并且返回得分。
该能力是通过HTTP API的方式给开发者提供一个通用的接口。HTTP API适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点。另外，请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

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

# 接口要求

集成配合式活体检测API时，需按照以下要求。

# 接口调用流程

· 通过接口密钥基于hmac-sha256计算签名，将签名以及其他参数加在请求地址后面。详见下方 鉴权认证 。
· 将请求参数以及图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求参数 。
· 向服务器端发送Http请求后，接收服务器端的返回结果。

# 鉴权认证

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。

# 鉴权方法

通过在请求地址后面加上鉴权相关参数的方式，参数具体如下：

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

鉴权参数：

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/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"
}

# 请求参数

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

请求参数示例：

{
  "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": "success",
    "sid": "ase000e00a0@hu1763ac02b2a0XXXXXX"
  },
  "payload": {
    "star_similarity_result": {
      "compress": "raw",
      "encoding": "utf8",
      "format": "json",
      "text": "ewoJInJldCIgOiAwLAoJInN0Y.."
    }
  }
}

base64解码后的payload.face_status_result.text示例：

{
	"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
}

# 错误码

备注：如出现下述列表中没有的错误码，可到 这里 查询。

# 调用示例

配合式活体检测 demo python3语言

配合式活体检测 demo java jdk8语言

注： 其他开发语言请参照 接口调用流程 进行开发，也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 常见问题

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

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

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

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