沃土开放平台

SDK > JAVA-SDK > SDK方法具体文档
1、设备操作交互

1、设备禁用接口

  • 设备禁用接口。
RDeviceOperationService deviceOperationService = new DeviceOperationService();
ContentResult disable = deviceOperationService.disable(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号

2、设备启用接口

  • 设备启用接口。
RDeviceOperationService deviceOperationService = new DeviceOperationService();
ContentResult enable = deviceOperationService.enable(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号

3、设备重置接口

  • 设备重置接口。
RDeviceOperationService deviceOperationService = new DeviceOperationService();
ContentResult reset = deviceOperationService.reset(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号

4、设备升级接口

  • 设备升级接口。
RDeviceOperationService deviceOperationService = new DeviceOperationService();
ContentResult upgrade = deviceOperationService.upgrade(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
2、设备交互

1、设备录入接口

  • 设备录入接口。
RDeviceService deviceService = new DeviceService();
ContentResult<Device> device = deviceService.create(com.uniubi.ground.entity.Device device);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
{
  "code": "string",
  "data": {
    "appId": "string",
    "regNum": 0,
    "clientId": "string",
    "createTime": "2017-06-13T03:22:26.601Z",
    "deviceKey": "string",
    "id": 0,
    "name": "string",
    "sceneGuid": "string",
    "state": "string",
    "status": "string",
    "systemVersionNo": "string",
    "tag": "string",
    "userGuid": "string",
    "versionNo": "string"
  },
  "msg": "string",
  "result": "string"
}

2、设备删除接口

  • 设备删除接口。
RDeviceService deviceService = new DeviceService();
ContentResult delete = deviceService.delete(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
{
  "code": "string",
  "msg": "string",
  "result": "string"
}

3、设备销权人员接口

  • 设备销权人员接口。
RDeviceService deviceService = new DeviceService();
ContentResult deletePeople = deviceService.deletePeople(String deviceKey, String personGuid);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
personGuid Y String 人员personGuid,为空时代表设备上所有的人员

4、设备销权批量人员接口

  • 设备销权批量人员接口。
RDeviceService deviceService = new DeviceService();
ContentResult deleteSomePeople = deviceService.deleteSomePeople(String deviceKey, String personGuids);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
personGuids Y String 人员personGuid使用","拼接

5、设备查询接口

  • 设备查询接口。
RDeviceService deviceService = new DeviceService();
ContentResult<Device> device = deviceService.get(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
{
  "code": "string",
  "data": {
    "appId": "string",
    "regNum": 0,
    "clientId": "string",
    "createTime": "2017-06-13T03:22:26.601Z",
    "deviceKey": "string",
    "id": 0,
    "name": "string",
    "sceneGuid": "string",
    "state": "string",
    "status": "string",
    "systemVersionNo": "string",
    "tag": "string",
    "userGuid": "string",
    "versionNo": "string"
  },
  "msg": "string",
  "result": "string"
}

6、设备名称查询接口

  • 设备名称查询接口。
RDeviceService deviceService = new DeviceService();
ContentResult<String> name = deviceService.getName(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
{
  "code": "string",
  "data": "string",
  "msg": "string",
  "result": "string"
}

7、设备授权人员查询接口(返回people列表)

  • 设备授权人员查询接口(返回people列表)。
RDeviceService deviceService = new DeviceService();
ContentResult<List<Person>> people = deviceService.getPeople(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
{
  "code": "string",
  "data": {
    "appId": "string",
    "createTime": "2017-06-13T03:22:26.601Z",
    "guid": "string",
    "idNo": "string",
    "name": "string",
    "phone": "string",
    "tag": "string",
    "userGuid": "string",
  },
  "msg": "string",
  "result": "string"
}

8、查询设备配置接口

  • 查询设备配置接口。
RDeviceService deviceService = new DeviceService();
ContentResult<DeviceSetting> deviceSetting = deviceService.getSetting(String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
{
	"code": "GS_SUS334",//查询设备配置接口调用成功
	"data": {
		"deviceKey": "84E0F42005DCABCD",//设备序列号
		"applicationName": "测试应用",//应用名称
		"deviceName": "测试设备",//设备名称
		"ttsModType": 1,//语音模式类型,1:不需要语音播报,2:播报名字,... 100:自定义
		"ttsModContent": "欢迎光临",//语言模式自定义内容
		"displayModType": 1,//显示模式类型,1:显示名字,... 100:自定义
		"displayModContent": "名字",//显示模式自定义内容
		"comModType": 1,//串口模式类型,1:开门,2:不输出,3:输出电话,4:输出卡号(IC卡/身份证),... 100:自定义
		"comModContent": "test",//串口模式自定义内容
		"recDisModType": 1,//识别距离模式类型,0:无限制,1:0.5米以内,2:1米以内,3:1.5米以内,4:2米以内,5:3米以内,6:4米以内
		"previewModType": 1,//是否预览视频流开关,1:正常(根据序列号判断),2:预览,3:不预览
		"recScore": 80//识别分数阈值,默认80
		"nameType": 1,//设备名称显示类型,1:显示应用名称;2:显示设备名称;3:显示应用名称+设备名称
		"logoUrl": "img.com/test.jpg",//设备LOGO素材,支持类型(jpg格式;mp4格式):高160、宽214
		"recStrangerType": 1,//陌生人识别 配置项,1:不识别陌生人;2:识别陌生人
		"recStrangerTimesThreshold": 1,//(陌生人开关打开情况下设置有效)陌生人语音模式类型,1:不需要语音播报,2:陌生人警报,... 100:自定义
		"ttsModStrangerType":"注意陌生人",//陌生人语音播报自定义内容
		"orientationType": 1,//设备方向配置项,1:横屏,2:竖屏
		"intro": "介绍",//介绍
		"slogan": "短语",//短语
		"recTimeWindow": 1,//识别时间窗(单位min),默认1;在该时间窗内(如:设置为3分钟),人员多次识别,只上传一次识别记录
		"recTimeWindowInSeconds": 0,//识别时间窗(单位s),默认0;实际设置时间为识别时间窗(分钟)及识别时间窗(秒)的累加,若设置为0分0秒,则上传记录无时间间隔限制
		"recRank": 1,//设备识别等级 Uface-M5201系列设备默认1,Uface-M72XX系列设备默认2
		"wiegandType": 1,//韦根类型,1:不需要韦根(默认值),2:韦根26输出 WG{idNo}
		"wiegandContent": "测试",//韦根输出自定义内容
		"recModeFaceEnable": 1,//刷脸模式开关,1:关,2:开 默认
		"recModeCardEnable": 1,//刷卡模式开关,1:关,2:开 默认
		"recModeCardIntf": 2,//刷卡模式接口类型 1:USB 2: TTL串口(默认) 3:232串口
		"recModeCardHardware": 1,//刷卡模式硬件类型1: IC读卡器(默认) 2: 二维码读头 3: 新中新 4.:精伦 5:中控
		"recModeCardFaceEnable": 1,//双重认证(先刷卡再刷脸),1:关 默认, 2:开
		"recModeCardFaceIntf": 2,//双重认证模式接口类型 1:USB 2: TTL串口(默认) 3:232串口
		"recModeCardFaceHardware": 1,//双重认证模式硬件类型1: IC读卡器(默认) 2: 二维码读头 3: 新中新 4.:精伦 5:中控
		"recModeIdcardFaceEnable": 1,//人证比对,1:关 默认, 2:开
		"recModeIdcardFaceIntf": 2,//人证比对模式接口类型 1:USB 2: TTL串口 3:232串口(默认)
		"recModeIdcardFaceHardware": 1,//人证比对模式硬件类型1: IC读卡器 2: 二维码读头 3: 新中新(默认) 4.:精伦 5:中控
		"recCardFaceValue": 60,//人证比对以及刷卡刷脸双重认证模式识别阈值
		"relayTime": 500//继电器保持时间.默认500毫秒
	},
	"msg": "success",
	"result": 1
}

9、设备分页搜索接口

  • 设备分页搜索接口。
RDeviceService deviceService = new DeviceService();
ContentResult<PaginationData<Device>> search = deviceService.search(DeviceSearchModel searchModel, InputPagination inputPagination);
参数名 必选 类型 说明
searchModel Y DeviceSearchModel 设备查询实体
inputPagination Y InputPagination 分页相关
{
  "code": "string",
  "data": {
    "content": [
      {
        "appId": "string",
        "regNum": 0,
        "clientId": "string",
        "createTime": "2017-06-13T03:22:26.601Z",
        "deviceKey": "string",
        "id": 0,
        "name": "string",
        "sceneGuid": "string",
        "state": "string",
        "status": "string",
        "systemVersionNo": "string",
        "tag": "string",
        "userGuid": "string",
        "versionNo": "string"
      }
    ],
    "pagination": {
      "beginIndex": 0,
      "endIndex": 0,
      "index": 0,
      "length": 0,
      "size": 0,
      "total": 0
    }
  },
  "msg": "string",
  "result": "string",
  "success": true
}

10、设备授权人员接口

  • 设备授权人员接口。
RDeviceService deviceService = new DeviceService();
ContentResult setPeople = deviceService.setPeople(String deviceKey,String personGuids,String passTimes);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
personGuids Y String 人员personGuid使用”,”拼接
passTimes N String 人员可通过时间(“11:00:01,12:00:02,13:00:00,14:00:00”),2个时间一对,一对中前者为起始时间后者为末尾时间,最多3对,使用”,”拼接

11、设备更新接口

  • 设备更新接口。
RDeviceService deviceService = new DeviceService();
ContentResult updateDevice = deviceService.updateDevice(String deviceKey, String name, String tag);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
name N String 设备名称
tag N String 标记

12、修改设备配置接口

  • 修改设备配置接口。
RDeviceService deviceService = new DeviceService();
ContentResult updateSetting = deviceService.updateSetting(DeviceSetting deviceSetting);
参数名 类型 必选 说明
deviceKey String Y 设备序列号
ttsModType 语音模式类型 int Y 1:不需要语音播报;
2:播报name;
......
100:自定义
ttsModContent 语音模式自定义内容 String N 1:模板中只允许{name}字段,字段格式固定;
2:模板中只允许数字、英文、中文和 “{”、“}”;
3:内容长度限制32个字,请自行调整
例:{name}欢迎光临
displayModType 显示模式类型 int Y 1:显示name;
......
100:自定义
displayModContent 显示模式自定义内容 String N 1:模板中只允许{name}字段,字段格式固定;
2:模板中只允许数字、中英文、中英文符号和“{”、“}”;
3:内容长度限制32个字,请自行调整
例:{name},签到成功!
comModType 串口模式类型 int Y 1:开门;
2:不输出;
3:输出phone;
4:输出idNo;
......
100:自定义
comModContent 串口模式自定义内容 String N 1:模板中只允许{idNo}、{phone}字段,字段格式固定;
2:模板中只允许英文和英文符号;
3:内容长度限制64个字符,请自行调整
recDisModType 识别距离类型 int N 0:无限制(默认)
1:0.5米以内
2:1米以内
3:1.5米以内
4:2米以内
5:3米以内
6:4米以内
previewModType 预览视频流开关 int N 1:正常(默认,RGB可视,红外不可视)
2:预览/可视
3:不预览/不可视
nameType 设备名称显示类型 int N 1:显示应用名称
2:显示设备名称
3:显示应用名称+设备名称
logoUrl 设备LOGO素材 String N 支持类型(png、jpg、jpeg格式;mp4格式):高160 宽214
recScore 识别记录阈值 int N 默认80
recStrangerType 陌生人识别 配置项 int N 1:不识别陌生人
2:识别陌生人
orientationType 设备方向配置 int N 1:横屏
2:竖屏
intro 介绍 String N
slogan 短语 String N
recTimeWindow 识别时间窗(分钟) int N 识别时间窗(单位min),默认1;在该时间窗内(如:设置为3分钟),人员多次识别,只上传一次识别记录
recTimeWindowInSeconds 识别时间窗(秒) int N 识别时间窗(单位s),默认0;实际设置时间为识别时间窗(分钟)及识别时间窗(秒)的累加;若设置为0分0秒,则上传记录无时间间隔限制
recStrangerTimesThreshold 陌生人判定 int N 设备判定为陌生人所需时间等级(陌生人开关打开情况下设置有效),默认3;1表示快速判定但精确率最低,随着数值增加,判定时间增加,精确度提高
ttsModStrangerType 陌生人语音模式类型 int Y 陌生人开关打开情况下设置有效
1:不需要语音播报;
2:陌生人警报;
......
100:自定义
ttsModStrangerContent 陌生人语音播报自定义内容 String N 1:模板中只允许数字、英文和中文;
2:内容长度限制32个字,请自行调整
例:注意陌生人
wiegandType 韦根类型 int Y 1:不需要韦根(默认值);
2:韦根26输出 WG{idNo}
wiegandContent 韦根输出自定义内容 String N 韦根输出自定义内容
例:WG{idNo}
recRank 设备识别等级 int N 设备识别等级
Uface-M5201系列设备默认1,Uface-M72XX系列设备默认2
recModeFaceEnable 刷脸模式开关 int Y 1:关;
2:开 默认
recModeCardEnable 刷卡模式开关 int Y 1:关;
2:开 默认
recModeCardIntf 刷卡模式接口类型 int N 1:USB;
2:TTL串口(默认);
3:232串口
recModeCardHardware 刷卡模式硬件类型 int N 1:IC读卡器(默认);
2:二维码读头;
3:新中新;
4:精伦;
5:中控
recModeCardFaceEnable 双重认证模式开关(先刷卡再刷脸) int Y 1:关;默认
2:开
recModeCardFaceIntf 双重认证模式接口类型 int N 1:USB;
2:TTL串口(默认);
3:232串口
recModeCardFaceHardware 双重认证模式硬件类型 int N 1:IC读卡器(默认);
2:二维码读头;
3:新中新;
4:精伦;
5:中控
recModeIdcardFaceEnable 人证比对 int Y 1:关;默认
2:开
recModeIdcardFaceIntf 人证比对模式接口类型 int N 1:USB;
2:TTL串口;
3:232串口(默认)
recModeIdcardFaceHardware 人证比对模式硬件类型 int N 1:IC读卡器;
2:二维码读头;
3:新中新(默认);
4:精伦;
5:中控
recCardFaceValue 人证比对以及双重认证模式识别阈值 int Y 60
relayTime 继电器保持时间 int Y 继电器保持时间.默认500毫秒

13、复制设备权限接口

  • 复制设备权限接口。
RDeviceService deviceService = new DeviceService();
ContentResult updateSetting = deviceService.peopleCopy(String srcDeviceKey, String destDeviceKey);
参数名 必选 类型 说明
srcDeviceKey Y String 复制源设备序列号
destDeviceKey Y String 复制目标设备序列号

13、设备交互(远程开门)

  • 设备交互。
RDeviceService deviceService = new DeviceService();
ContentResult result = deviceService.interactiveCreate(String deviceKey, int type);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
type Y int 设备交互行为类型 1:远程开门
3、人员照片交互

1、照片注册接口(Base64)

  • 照片注册接口(Base64)。
RFaceService faceService = new FaceService();
ContentResult<Face> device = faceService.create(BaseImgFace face);
参数名 必选 类型 说明
personGuid Y String 人脸Guid
img Y InputStream 带base64图的人脸对象
{
  "code": "string",
  "data": {
    "guid": "string",
    "userGuid": "string",
    "createTime": "2017-06-13T03:22:26.601Z",
    "appId": "string",
    "personGuid": "string",
    "type":"byte"
	"faceUrl":"String"
  },
  "msg": "string",
  "result": "string"
}

2、照片注册接口(url)

  • 照片注册接口(url)。
RFaceService faceService = new FaceService();
ContentResult<Face> device = faceService.createByUrl(String personGuid, String imageUrl);
参数名 必选 类型 说明
personGuid Y String 人脸Guid
imageUrl Y String 带人脸的url(jpg或png格式)
{
  "code": "string",
  "data": {
    "guid": "string",
    "userGuid": "string",
    "createTime": "2017-06-13T03:22:26.601Z",
    "appId": "string",
    "personGuid": "string",
    "type":"byte",
    "faceUrl":"String"
  },
  "msg": "string",
  "result": "string"
}

3、照片删除接口

  • 照片删除接口。
RFaceService faceService = new FaceService();
ContentResult<Face> device = faceService.delete(String personGuid, String guid);
参数名 必选 类型 说明
personGuid Y String 人员guid
guid Y String 人脸记录guid

4、照片状态查询接口

  • 照片状态查询接口。
RFaceService faceService = new FaceService();
ContentResult<List<FaceDeviceState>> list = faceService.getState(String personGuid, String guid, String deviceKey);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
personGuid Y String 人员guid
guid Y String 人脸记录guid
4、人员交互

1、人员录入接口

  • 人员录入接口。
RPersonService personService = new PersonService();
ContentResult<Person> device = personService.create(Person person);
参数名 必选 类型 说明
name Y String 姓名
{
  "code": "string",
  "data": {
    "guid": "string",
    "userGuid": "string",
    "createTime": "2017-06-13T03:22:26.601Z",
    "appId": "string",
    "phone": 0,
    "idNo": "string""string",
    "tag": "string",
    "name": "string",
  },
  "msg": "string",
  "result": "string"
}

2、人员删除接口

  • 人员删除接口。
RPersonService personService = new PersonService();
ContentResult device = personService.delete(String guid);
参数名 必选 类型 说明
guid Y String 人员guid

3、人员-设备销权接口

  • 人员-设备销权接口。
RPersonService personService = new PersonService();
ContentResult device = personService.deleteDevices(String guid, String deviceKey);
参数名 必选 类型 说明
guid Y String 人员guid
deviceKey Y String 设备序列号,为空时代表所有设备

4、人员-设备销权接口

  • 人员-设备销权接口。
RPersonService pepersonrsonService = new PersonService();
ContentResult device = personService.deleteSomeDevices(String guid, String deviceKeys);
参数名 必选 类型 说明
guid Y String 人员guid
deviceKeys Y String 设备序列号使用”,”拼接

5、人员搜索接口

  • 人员搜索接口。
RPersonService personService = new PersonService();
ContentResult<PaginationData<Person>> person = personService.get(PersonSearchModel searchModel, InputPagination inputPagination);
参数名 必选 类型 说明
searchModel Y PersonSearchModel 人员搜索对象
inputPagination Y InputPagination 分页相关
{
  "code": "string",
  "data": {
    "content": [
      {
        "guid": "string",
        "userGuid": "string",
        "createTime": "2017-06-13T03:22:26.601Z",
        "appId": "string",
        "phone": 0,
        "idNo": "string",
        "tag": "string",
        "name": "string",
      }
    ],
    "pagination": {
      "beginIndex": 0,
      "endIndex": 0,
      "index": 0,
      "length": 0,
      "size": 0,
      "total": 0
    }
  },
  "msg": "string",
  "result": "string",
}

6、人员查询接口

  • 人员查询接口。
RPersonService personService = new PersonService();
ContentResult<Person> person = personService.get(String guid);
参数名 必选 类型 说明
guid Y String 人员guid
{
  "code": "string",
  "data": {
    "guid": "string",
    "userGuid": "string",
    "createTime": "2017-06-13T03:22:26.601Z",
    "appId": "string",
    "phone": "string",
    "idNo": "string",
    "tag": "string",
    "name": "string",
  },
  "msg": "string",
  "result": "string"
}

7、人员授权设备查询接口

  • 人员授权设备查询接口。
RPersonService personService = new PersonService();
ContentResult<List<Device>> device = personService.getDevices(String guid);
参数名 必选 类型 说明
guid Y String 人员guid
{
  "code": "string",
  "data": [
	{
	   "guid": "string",
	   "userGuid": "string",
	   "createTime": "2017-06-13T03:22:26.601Z",
	   "appId": "string",
	   "phone": "string",
	   "idNo": "string",
	   "tag": "string",
	   "name": "string",
	}
  ],
  "msg": "string",
  "result": "string"
}

8、人员照片查询接口

  • 人员照片查询接口。
RPersonService personService = new PersonService();
ContentResult<List<Face>> device = personService.getFaces(String guid);
参数名 必选 类型 说明
guid Y String 人员guid
{
  "code": "string",
  "data": [
	{
	   "guid": "string",
	   "userGuid": "string",
	   "createTime": "2017-06-13T03:22:26.601Z",
	   "appId": "string",
	   "personGuid": "string",
	   "type": "byte",
	}
  ],
  "msg": "string",
  "result": "string"
}

9、注册任务状态查询接口

  • 注册任务状态查询接口。
RPersonService personService = new PersonService();
ContentResult<Integer> device = personService.getRegisteration(String guid, String deviceKey, String taskId);
参数名 必选 类型 说明
guid Y String 人员guid
deviceKey Y String 设备序列号
taskId Y String 任务Id
1.任务创建
2.准备就绪
3.开启失败
4.任务完成
5.任务过期
6.任务失败

10、开启注册模式接口

  • 开启注册模式接口。
RDeviceService deviceService = new DeviceService();
ContentResult<String> device = deviceService.turnonDeviceMode(String deviceKey, int type, String personGuid);
参数名 必选 类型 说明
deviceKey Y String 设备序列号
type Y int 注册模式类型 1:拍照注册;2:刷卡注册
personGuid Y String 人员guid
{
"code": "string",
"data": "string",//taskId任务Id
"msg": "string",
"result": "string"
}

11、人员-设备授权接口

  • 人员-设备授权接口。
RPersonService personService = new PersonService();
ContentResult device = personService.setDevices(String guid, String deviceKeys,String passTimes);
参数名 必选 类型 说明
guid Y String 人员guid
deviceKeys Y String 设备序列号,使用”,”拼接
passTimes Y String 人员可通过时间(“11:00:01,12:00:02,13:00:00,14:00:00”),2个时间一对,一对中前者为起始时间后者为末尾时间,最多3对,使用”,”拼接

12、人员更新接口

  • 人员更新接口。
RPersonService personService = new PersonService();
ContentResult device = personService.update(Person person);

13、注册任务状态变更接口

  • 注册任务状态变更接口。
RPersonService personService = new PersonService();
ContentResult device = personService.updateRegisteration(String guid, String deviceKey, String taskId, int state);
参数名 必选 类型 说明
guid Y String 人员guid
deviceKey Y String 设备序列号
taskId Y String 任务Id
state Y int 注册状态