基于虹软人脸识别微服务

生物智能识别服务开放接口（基于OAuth2.0）

完整文档

生物智能识别服务开放接口202000722v1.03.01.pdf
生物智能识别服务系统是一个将人脸识别、指纹识别、虹膜识别融合的混合生物特征识别微服务系统，服务除了具备独立功能，并以Oauth2.0协议方式对外提供接口对接。

快速集成案例

人脸抓拍机抓拍服务

gitee

Gitee

1服务核心功能

人脸识别私有化部署（也称为人脸识别本地化部署）提供人脸检测、人脸比对、人脸检索、活体检测等人脸识别基础能力，基于OAuth2.0对外提供接口服务，可以让使用者快速集成人脸识别能力，扩展自己的业务系统，节省了大量的研发和时间成本。

一、OAuth2.0协议

OAuth2.0协议作为用户资源的授权，提供了一个当前较为安全的、开放又简易的标准。
OAuth2.0定义了授权码模式（Authorization Code）、简化模式（Implicit）、用户名密码模式（Resource Owner Password Credentials）、客户端凭证模式（Client Credentials）四种授权模式。
这里对OAuth2.0仅做简单描述，详细技术内容请查看OAuth2.0相关内容。“生物智能识别服务”提供服务主要基于客户端凭证模式。
客户端凭证模式（Client Credentials）

步骤：
(1)客户端向授权服务器申请授权；
(2)授权服务器返回一个Access Token；
(3)用Access Token去访问资源服务器；
(4)资源服务器返回资源。
注：“生物智能识别服务”同时充当授权服务器（Token授权）及资源服务器（生物识别接口）。

二、开放接口

（一）BaseUrl&Token获取

1.BaseUrl即为服务访问地址，如本机部署，端口为8080，则BaseUrl=http://localhost:8080，以下所提及接口都以BaseUrl为基础，用Post请求方式进行接口访问。
2.Access Token获取
地址：BaseUrl+/oauth/token
请求参数：

返回内容：
{
“access_token”: “3ec707a7-faa1-4dd2-9891-d8d6609a2b56”, //token值以备后续调用
“token_type”: “bearer”,
“expires_in”: 3576, //有效时间，单位（秒）
“scope”: “face_client”
}
注：
参数中client_id、client_secret，请在应用后台菜单“应用接口→应用管理”添加应用，填写相对应的参数值

（二）人脸对比

1．人脸对比
地址：BaseUrl+/auth/face/toFaceCompare
说明：即对两个人脸图片进行相识度匹配，判断是否为同一个人。
请求参数：
返回内容：
{
“code”: “0000”,
“msg”: “调用成功”,
“success”: true,
“data”: {
“reqParam”: “1”,
“similarValue”: 90 //相识度 最小为0 最大值为100，
}
}
2．人脸图片搜索
地址：BaseUrl+/auth/face/toFaceSearch
说明：通过人脸图片人脸库中。
请求参数：

返回内容：
{
“code”: “0000”,
“msg”: “调用成功”,
“success”: true,
“data”: {
“result”: [ {
“faceInfoId”: 15,
“faceId”: “oxa2t5jrug5p”,
“name”: “郑伊健”,
“similarValue”: 100,
“faceFeature”: null
}],
“reqParam”: “1”
}
}

（三）人脸管理

1．人脸列表
地址：BaseUrl+/auth/face/getFaceInfoPage
说明：加载人脸库中的列表
请求参数：

返回内容：
{
“code”: “0000”,
“msg”: null,
“success”: true,
“data”: null,
“total”: 2,
“items”: [
{
“faceInfoId”: 14,
“groupId”: 1,
“faceId”: “9yjxto4qwa1d”,
“name”: “韩风”,
“userType”: 0,
“faceFeature”: “”,
“disabled”: false,
“createTime”: “2020-03-06 16:46:44”,
“updateTime”: “2020-03-06 16:46:44”,
“base64Img”: “”,
“userInfo”: “”
},
{
“faceInfoId”: 15,
“groupId”: 1,
“faceId”: “oxa2t5jrug5p”,
“name”: “郑伊健”,
“userType”: 0,
“faceFeature”: “”,
“userInfo”: “”
}
]
}
注：faceId、faceInfoId都可以作为人脸唯一标识
2．人脸添加
地址：BaseUrl+/auth/face/saveFaceInfo
说明：添加人脸到服务人脸库中
请求参数：

返回内容：
{
“code”: “0000”,
“msg”: “调用成功”,
“success”: true,
“data”: {
“groupId”: 1,
“faceId”: “wjlbt2nwb1qo”,
“faceInfoId”: 53
}
}
3．人脸加载
地址：BaseUrl+/auth/face/loadFaceInfo
说明：通过faceId或faceInfoId加载人脸信息
请求参数：

返回内容：
{
“code”: “0000”,
“msg”: “调用成功”,
“success”: true,
“data”: {
“userInfo”: null,
“groupId”: 1,
“name”: “测试”,
“base64Img”: “data:image/jpg;base64,…”,
“faceId”: “eq0upqqjf9j4”,
“userType”: 1,
“faceInfoId”: 50
}
}

4．人脸修改
地址：BaseUrl+/auth/face/updateFaceInfo
说明：通过faceId或faceInfoId修改录入的人脸信息
请求参数：

返回内容：
{
“code”: “0000”,
“msg”: “调用成功”,
“success”: true,
“data”: null
}
5．人脸删除
地址：BaseUrl+/auth/face/deleteFaceInfo
说明：通过faceId或faceInfoId删除人脸信息
请求参数：

返回内容：
{
“code”: “0000”,
“msg”: “不存在的对象”,
“success”: false,
“data”: null
}

6．人脸检测
地址：BaseUrl+/auth/face/toFaceDetect
说明：对传入的图片进行人脸检测，并返回检测结果
请求参数：

返回内容：
{
“code”: “0000”,
“msg”: “调用成功”,
“success”: true,
“data”: {
“base64Img”: “data:image/jpg;base64,…”, //截取后的人脸头像
“reqParam”: null,
“faceRect”: {
“x”: 651,
“width”: 571,
“y”: 272,
“height”: 713
}
}
}