全部产品
云市场

FaceID服务

更新时间:2019-11-22 10:28:18

1、服务介绍

FaceID服务提供游客基本信息、人脸图片、票务类型的信息管理。支持在应用服务平台进行查看、添加、修改、删除游客,也支持通过开放API查看、添加、修改、删除游客信息。

2 使用指南

  1. 人脸识别门禁机设备接入到IoT平台并与景点建立关联关系。
  2. 通过SI后台或开放API添加会员数据,包括人脸图片。
  3. 人脸权限通过开放API下发到人脸识别设备。
  4. 游客会员刷脸通行。
  5. 通过SI后台查看并管理游客刷脸记录。

人脸图片

1.设备接入

通过文旅SI后台创建的景点会相应地在空间管理中生成空间位置,在该空间位置下添加空间单元,并把人脸识别设备绑定到空间单元,以此建立设备与景点的关联关系。

2.添加会员

添加会员数据有两种方式:文旅SI后台和开放API,两种方式可以任选其一。

  • 在文旅SI后台的会员管理中,可以根据人脸图片对已添加的会员进行搜索,实现以脸搜脸。
  • 如果使用开放API添加会员,申请appKey时使用的阿里云账号需要确保与SI后台登录账号相同,因为不同账号之间的会员数据是隔离的。

开放API人脸图片上传步骤:
图片上传

2.1 获取人脸图片地址

路径:/tourism/file/getuploadurl
版本:1.0.0

入参
参数 类型 是否必填 备注
projectId String 项目ID
fileExtension String 上传文件的扩展名,如jpg

出参

使用IoT通用返回结果类型,其中data域是JSON对象,包含以下字段:

参数 类型 备注
url String OSS临时授权文件上传地址
fileName String OSS文件名称,该值可作为文件类型参数的入参

示例

入参示例

  1. {
  2. "fileExtension": "png",
  3. "projectId": "a1246AMGAEnfwai3"
  4. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": {
  5. "fileName": "data/image/629361797ba742bc9057bd04b2676411.png",
  6. "url": "http://iotx-tourism.oss-cn-shanghai.aliyuncs.com/data/image/629361797ba742bc9057bd04b2676411.png?Expires=3136538891&OSSAccessKeyId=LTAIOFKpgzJVcqeZ&Signature=ID1gpkwLpjHTfjvBghBZ0dh%2F%2FBs%3D"
  7. }
  8. }

2.2 保存会员信息

路径:/tourism/tourist/save
版本:1.0.0

入参
参数 类型 是否必填 备注
projectId String 项目ID
touristId String 游客ID
name String 姓名
gender Integer 性别,1-男、0-女
faceUrl String 游客人脸图片OSS文件名称,OSS文件名称通过上传接口将人脸图片上传到平台获得
mobile String 手机号
identityType Integer 证件类型,1-身份证、2-军官证、3-学生证、4-护照、5-港澳通行证、6-台湾通行证、7-香港身份证、8-回乡证
identityNo String 证件号
ticketType Integer 游客门票类型,1-次票、2-月票、3-区间票
verified Integer 是否实名认证,1-已实名认证、0-未实名认证
isBlackList Integer 是否属于黑名单。1-属于黑名单、0-不属于黑名单
lastVisit Long 最近一次访问时间,单位毫秒

出参

使用IoT通用返回结果类型,其中data域是游客ID。

示例

入参示例

  1. {
  2. "faceUrl": "data/image/629361797ba742bc9057bd04b2676411.png",
  3. "isBlackList": 0,
  4. "gender": 1,
  5. "name": "name e",
  6. "verified": 0,
  7. "projectId": "a1246AMGAEnfwai3",
  8. "touristId": "30f8b905b46648adb2c9510c55a678dc"
  9. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": "30f8b905b46648adb2c9510c55a678dc"
  5. }


2.3 查询会员信息

路径:/tourism/tourist/query
版本:1.0.0

入参
参数 类型 是否必填 备注
projectId String 项目ID
touristId String 游客ID,精确匹配查询
mobile String 手机号,精确匹配查询
pageNo Integer 页码
pageSize Integer 分页大小,最大支持100

出参

使用IoT通用返回结果类型,其中data域是JSON对象,包含以下字段:

参数 类型 备注
total Long 总条数
pageNo Integer 页码
pageSize Integer 分页大小
data JSONArray 游客列表,包含的字段同保存会员信息API入参

示例

入参示例

  1. {
  2. "pageNo": 1,
  3. "pageSize": 20,
  4. "projectId": "a1246AMGAEnfwai3"
  5. }

出参示例

  1. {
  2. "total": 1,
  3. "pageNo": 1,
  4. "pageSize": 20,
  5. "data": [
  6. {
  7. "gender": 1,
  8. "verified": 0,
  9. "touristId": "30f8b905b46648adb2c9510c55a678dc",
  10. "isBlackList": 0,
  11. "name": "name e",
  12. "projectId": "a1246AMGAEnfwai3"
  13. }
  14. ]
  15. }

2.4 删除会员信息

路径:/tourism/tourist/delete
版本:1.0.0

入参
参数 类型 是否必填 备注
projectId String 项目ID
touristId String 游客ID

出参

使用IoT通用返回结果类型。

示例

入参示例

  1. {
  2. "projectId": "a1246AMGAEnfwai3",
  3. "touristId": "30f8b905b46648adb2c9510c55a678dc"
  4. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

3.人脸权限下发

通过开放API实现人脸权限下发,即把会员的人脸图片下发到人脸识别设备上,使会员可以被该设备识别。
注:以下人脸权限相关的API是平台通用接口,包含一些可扩展的类型字段,文旅领域在使用时请按参数备注中的说明传值。

3.1 增加人脸权限

路径:/face/paas/permission/add
版本:1.0.0

入参
参数 类型 是否必填 备注
userType String 用户类型,请传固定值TOURIST
userIdList JSONArray 游客ID列表
scopeType String 人脸信息下发的目标范围类型,请传固定值IOT_ID(表示把人脸图片下发到设备)
scopeIdList JSONArray 设备iotId列表

出参

使用IoT通用返回结果类型。

示例

入参示例

  1. {
  2. "userType":"TOURIST",
  3. "userIdList":
  4. [
  5. "30f8b905b46648adb2c9510c55a678dc"
  6. ],
  7. "scopeType":"IOT_ID",
  8. "scopeIdList":
  9. [
  10. "wmRD4EXa0mQWqrrA3v1h000101"
  11. ]
  12. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

3.2 删除人脸权限

路径:/face/paas/permission/delete
版本:1.0.0

入参
参数 类型 是否必填 备注
userType String 用户类型,请传固定值TOURIST
userIdList JSONArray 游客ID列表
scopeType String 人脸信息下发的目标范围类型,请传固定值IOT_ID(表示把人脸图片下发到设备)
scopeIdList JSONArray 设备iotId列表

出参

使用IoT通用返回结果类型。

示例

入参示例

  1. {
  2. "userType":"TOURIST",
  3. "userIdList":
  4. [
  5. "30f8b905b46648adb2c9510c55a678dc"
  6. ],
  7. "scopeType":"IOT_ID",
  8. "scopeIdList":
  9. [
  10. "wmRD4EXa0mQWqrrA3v1h000101"
  11. ]
  12. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success"
  4. }

3.3 查询游客的权限状态

路径:/face/paas/permission/querybyuser
版本:1.0.0

入参
参数 类型 是否必填 备注
userType String 用户类型,请传固定值TOURIST
userId String 游客ID
deviceListPageNo Integer 分页查询的请求页码
deviceListPageSize Integer 分页查询的请求页大小

出参

使用IoT通用返回结果类型,data域是JSON对象,包含以下字段:

参数 类型 备注
userType String 用户类型
userId String 游客ID
userName String 游客姓名
deviceListTotal Integer 该用户人脸图片执行过下发操作的设备总数
deviceListPageNo Integer 请求页码
deviceListPageSize Integer 请求页大小
deviceList JSONArray 设备列表,包含设备iotId、下发时间、下发状态

示例

入参示例

  1. {
  2. "userType":"TOURIST",
  3. "userId":"30f8b905b46648adb2c9510c55a678dc"
  4. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": {
  5. "userType": "TOURIST",
  6. "userId": "30f8b905b46648adb2c9510c55a678dc",
  7. "userName": "name e",
  8. "deviceListTotal": 1,
  9. "deviceListPageNo": 1,
  10. "deviceListPageSize": 20,
  11. "deviceList": [
  12. {
  13. "iotId": "wmRD4EXa0mQWqrrA3v1h000101",
  14. "syncTime": "2019-02-28 19:00:00",
  15. "syncStatus": "transferred"
  16. }
  17. ]
  18. }
  19. }

3.4 查询设备的权限状态

路径:/face/paas/permission/querybydevice
版本:1.0.0

入参
参数 类型 是否必填 备注
iotId String 设备ID
pageNo Integer 分页查询的请求页码
pageSize Integer 分页查询的请求页大小

出参

使用IoT通用返回结果类型,data域是JSON对象,包含以下字段:

参数 类型 备注
total Integer 下发到该设备的用户人脸图片总数
pageNo Integer 请求页码
pageSize Integer 请求页大小
userList JSONArray 游客列表,包含userId、userType、userName、下发时间、下发状态

示例

入参示例

  1. {
  2. "iotId":"wmRD4EXa0mQWqrrA3v1h000101",
  3. "pageNo":1,
  4. "pageSize":10
  5. }

出参示例

  1. {
  2. "code": 200,
  3. "message": "success",
  4. "data": {
  5. "total": 1,
  6. "pageNo": 1,
  7. "pageSize": 10,
  8. "userList": [
  9. {
  10. "userType": "TOURIST",
  11. "userId": "30f8b905b46648adb2c9510c55a678dc",
  12. "syncTime": "2019-02-28 19:00:00",
  13. "syncStatus": "transferred"
  14. }
  15. ]
  16. }
  17. }

4.刷脸通行

人脸下发成功的会员即可刷脸通过人脸门禁设备,并在云端留下刷脸记录。

5.刷脸记录管理

通过文旅SI后台的会员管理,可以查看并删除3个月以内的会员刷脸记录。