HC 物联网系统对接协议

最新推荐文章于 2023-03-24 17:21:20 发布
最新推荐文章于 2023-03-24 17:21:20 发布
阅读量1k 收藏 3
点赞数
分类专栏： hc 文章标签： 物联网
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hc_java110/article/details/111829530
版权

HC 物联网系统对接协议

说明

代码：https://gitee.com/java110/MicroCommunityThings

官网：http://www.homecommunity.cn/

开发前必读

协议规范设计

第三方调用开放接口时，需使用 https 协议、Json 数据格式、UTF8 编码

注：建议封装统一的 API 请求接口，便于进行 token 容错处理，以及相关日志打
印等

请求参数：默认使用 json 方式（access_token 必须传至http header 中）

通用响应报文格式：

   {
   "code":0,
   "msg":"返回码描述内容",
   "data": {}
   }

通用响应报文字段说明：

名称类型描述
codeInteger返回码
msgString对返回码的文本描述内容
dataObject返回数据（部分接口无返回数据）

通用错误码说明

状态描述
0成功
-1失败

授权认证-获取access_token

根据 appId+appSecret 换取 access_token。access_token 是平台全局接口的唯一凭证，调用其他接口均需传 access_token
参数到Http header 中 如 access_token 12312312。

请求方式：GET

请求地址： /extApi/auth/getAccessToken?appId=APPID&appSecret=APPSECRET

注：此处标注大写的单词 APPID 和 APPSECRET，为需要替换的变量，根据实际获取值更新。其它接口也采用相同的标注，不
再说明。

请求参数:

名称类型是否必填示例值描述
appIdString是2fe1465ce30f4bc1b71978d42349c6APPID
appSecretString是2fe1465ce30f4bc1b71978d42349c2APP 秘钥

响应参数:

名称类型示例值描述
access_tokenString2fe1465ce30f4bc1b71978d42349c6accessToken 访问凭据
expires_inInteger7200过期时间为 7200 秒，即 2 小时

响应示例:

    {
        "code":0,
        "msg":"成功",
        "data":{
            "access_token": "225262e8b548b77f76f018d218291647",
            "expires_in": 7200
            }
    }

参考代码：

    //@Java110Synchronized 为分布式全局锁 根据 实际替换为自己的全局锁代码
    @Java110Synchronized(value = "hc_get_token")
    public static String get(RestTemplate restTemplate,boolean refreshAccessToken) {
        //先从缓存中获取是否存在access_token
        String token = CommonCache.getValue(IotConstant.HC_TOKEN);
        if (!StringUtil.isEmpty(token) && !refreshAccessToken) {
            return token;
        }
        HttpHeaders headers = new HttpHeaders();
        HttpEntity httpEntity = new HttpEntity(headers);
        String url = IotConstant.getUrl(IotConstant.GET_TOKEN_URL.replace("APP_ID", IotConstant.getAppId()).replace("APP_SECRET", IotConstant.getAppSecret()));
        ResponseEntity<String> tokenRes = restTemplate.exchange(url, HttpMethod.GET, httpEntity, String.class);

        if (tokenRes.getStatusCode() != HttpStatus.OK) {
            throw new IllegalArgumentException("获取token失败" + tokenRes.getBody());
        }
        JSONObject tokenObj = JSONObject.parseObject(tokenRes.getBody());

        if (!tokenObj.containsKey("code") || ResultVo.CODE_OK != tokenObj.getInteger("code")) {
            throw new IllegalArgumentException("获取token失败" + tokenRes.getBody());
        }

        token = tokenObj.getJSONObject("data").getString("access_token");
        int expiresIn = tokenObj.getJSONObject("data").getInteger("expires_in");

        CommonCache.setValue(IotConstant.HC_TOKEN, token, expiresIn - 200);

        return token;
    }

1.小区资源操作

1.1 新增小区

请求方式： POST

请求地址：/extApi/community/addCommunity

请求参数：

名称类型是否必填示例值描述
nameString是HC小区小区名称
addressString是青海省西宁市小区地址
cityCodeString是510104地区码
extCommunityIdString是702020042194860039小区外部编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "name": "HC小区",
    "address": "青海省西宁市",
    "cityCode": "510104",
    "extCommunityId": "702020042194860039",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

1.2 修改小区

请求方式： POST

请求地址：/extApi/community/updateCommunity

请求参数：

名称类型是否必填示例值描述
nameString是HC小区小区名称
addressString是青海省西宁市小区地址
cityCodeString是510104地区码
extCommunityIdString是702020042194860039小区外部编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "name": "HC小区",
    "address": "青海省西宁市",
    "cityCode": "510104",
    "extCommunityId": "702020042194860039",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

1.3 删除小区

请求方式： POST

请求地址：/extApi/community/deleteCommunity

请求参数：

名称类型是否必填示例值描述
extCommunityIdString是702020042194860039小区外部编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "extCommunityId": "702020042194860039",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

2.设备资源操作

2.1 新增设备

请求方式： POST

请求地址：/extApi/machine/addMachine

请求参数：

名称类型是否必填示例值描述
machineCodeString是101010设备编码
machineVersionString否v1.0设备版本
machineNameString是HC门禁设备名称
machineTypeCdString是9999设备类型 9999 门禁9996 道闸9997 考勤机
machineIpString否192.168.1.1设备IP
machineMacString否11:1:11:1设备mac
extMachineIdString是702020042194860037外部设备编码
extCommunityIdString是702020042194860039外部小区编码
hmIdString是1设备协议 HC物联网系统提供
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "machineCode": "101010",
    "machineName": "HC门禁",
    "machineTypeCd": "9999",
    "extMachineId": "702020042194860037",
    "extCommunityId": "702020042194860039",
    "hmId": "702020042194860039",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

2.2 修改设备

请求方式： POST

请求地址：/extApi/machine/updateMachine

请求参数：

名称类型是否必填示例值描述
machineCodeString是101010设备编码
machineVersionString否v1.0设备版本
machineNameString是HC门禁设备名称
machineTypeCdString是9999设备类型 门禁9999
machineIpString否192.168.1.1设备IP
machineMacString否11:1:11:1设备mac
extMachineIdString是702020042194860037外部设备编码
extCommunityIdString是702020042194860039外部小区编码
hmIdString是1设备协议 HC物联网系统提供
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "machineCode": "101010",
    "machineName": "HC门禁",
    "machineTypeCd": "9999",
    "extMachineId": "702020042194860037",
    "extCommunityId": "702020042194860039",
    "hmId": "702020042194860039",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

2.3 删除设备

请求方式： POST

请求地址：/extApi/machine/deleteMachine

请求参数：

名称类型是否必填示例值描述
extMachineIdString是702020042194860037外部设备编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "extMachineId": "702020042194860037",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

2.4 远程开门

请求方式： POST

请求地址：/extApi/machine/openDoor

请求参数：

名称类型是否必填示例值描述
extMachineIdString是702020042194860037外部设备编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "machineCode": "101010",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

2.5 重启设备

请求方式： POST

请求地址：/extApi/machine/restartMachine

请求参数：

名称类型是否必填示例值描述
extMachineIdString是702020042194860037外部设备编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "machineCode": "101010",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

3.用户资源操作

3.1 添加用户

请求方式： POST

请求地址：/extApi/user/addUser

请求参数：

名称类型是否必填示例值描述
userIdString是702020042194860037用户ID
faceBase64String是base64base64图片
startTimeString是2020-12-01 00:00:00开始时间
endTimeString是2020-12-31 00:00:00结束时间
nameString是张三名称
idNumberString否63216111111111111身份证
personTypeString是2002人员类型，1001 员工 2002 业主 3003 访客
machineCodeString是101010设备编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "userId": "702020042194860037",
    "faceBase64": "base64",
    "startTime": "2020-12-01 00:00:00",
    "endTime": "2020-12-31 00:00:00",
    "name": "张三",
    "idNumber": "63216111111111111",
    "personType": "2002",
    "machineCode": "101010",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

3.2 编辑用户

请求方式： POST

请求地址：/extApi/user/updateUser

请求参数：

名称类型是否必填示例值描述
userIdString是702020042194860037用户ID
faceBase64String是base64base64图片
startTimeString是2020-12-01 00:00:00开始时间
endTimeString是2020-12-31 00:00:00结束时间
nameString是张三名称
idNumberString否63216111111111111身份证
machineCodeString是101010设备编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "userId": "702020042194860037",
    "faceBase64": "base64",
    "startTime": "2020-12-01 00:00:00",
    "endTime": "2020-12-31 00:00:00",
    "name": "张三",
    "idNumber": "63216111111111111",
    "machineCode": "101010",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

3.3 删除用户

请求方式： POST

请求地址：/extApi/user/deleteUser

请求参数：

名称类型是否必填示例值描述
userIdString是702020042194860037用户ID
machineCodeString是101010设备编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "userId": "702020042194860037",
    "machineCode": "101010",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

3.4 清空用户

请求方式： POST

请求地址：/extApi/user/clearUser

请求参数：

名称类型是否必填示例值描述
machineCodeString是101010设备编码
taskIdString是102020042194860045任务ID，第三方生成唯一值

请求示例：

{
    "machineCode": "101010",
    "taskId": "102020042194860045"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":{
       "taskId": "102020042194860045"
    }
}

4. 开门记录资源

4.1 开门上报

说明：HC物联网系统将开门记录上报第三方平台，需要物联网平台配置

请求方式： POST

请求地址：第三方平台提供

请求参数：

名称类型是否必填示例值描述
userIdString是702020042194860037用户ID
userNameString是张三用户名称
machineCodeString是101010设备编码
openTypeCdString是1000开门方式 1000 人脸开门 2000 钥匙开门
similarString是100开门相似度
photoString是base64,xxx抓拍照片
dateTimeString是2020-12-27 00:00:00开门时间
extCommunityIdString是702020042194860039小区ID
recordTypeCdString是8888记录类型，8888 开门记录 6666 访客留影

请求示例：

{
    "userId": "702020042194860037",
    "userName": "张三",
    "machineCode": "101010",
    "openTypeCd": "1000",
    "similar": "100",
    "photo": "base64,xxx",
    "dateTime": "2020-12-27 00:00:00",
    "extCommunityId": "702020042194860039",
    "recordTypeCd": "8888"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":""
}

4.2 指令上报执行结果

说明：当和物联网系统异步交互时 或者物联网系统采用mqtt 协议时，执行结果 需要异步方式上报，需要物联网系统配置地址

请求方式： POST

请求地址：第三方平台提供

请求参数：

名称类型是否必填示例值描述
taskIdString是702020042194860037任务ID，第三方系统调用结果时传递
codeInteger是0指令执行状态码 0 成功 其他失败
msgString是成功指令执行说明

请求示例：

{
    "taskId": "702020042194860037",
    "code": 0,
    "msg": "成功"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":""
}
hc_java110
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
请求的session为null 或 每次请求的session都不同的问题。
Xiaofeng_Lu__的博客
08-17 4557
在项目开发中，使用了session保存邮箱验证的验证码，当使用swagger测试时没有问题，但是vue项目中测试的时候，明明验证码都发送成功了，也填写了发送过来的验证码，却返回“验证码未发送”。这是验证验证码的代码，返回“验证码未发送”，则可以知道，该浏览器在服务器的session为null，即传过来的sessionid为空，因为服务器要根据请求cookie中的sessionid找服务器中对应的session。可是，......
Springboot解决跨域问题的三种方式
weixin_50528222的博客
05-30 2632
对应的方法上添加@CrossOrigin或者类上添加@CrossOrigin。新建配置类CorsConfig，创建。
应用系统之间数据传输的几种方案
热门推荐
阿叁博客
11-21 2万+
应用系统之间数据传输的几种方式 第一种方案：socket方式 Socket方式是最简单的交互方式。是典型才C/S交互模式。一台客户机，一台服务器。 服务器提供服务，通过IP地址和端口进行服务访问。而客户机通过连接服务器指定的端口进行消息交互。 其中传输协议可以是TCP/UDP 协议。而服务器和约定了请求报文格式和响应报文格式。 如图一所示
Java开发官网地址大全
qq_60878529的博客
03-24 1252
Java快速开发网址大全
uni-app封装一个request请求
祈澈菇凉
07-09 8596
在上一篇文章里面，写到使用uni.request请求的方法 https://www.jianshu.com/p/bc62c9e1beed getList() { uni.request({ url: "https://unidemo.dcloud.net.cn/api/news", ...
HC物联网平台是一款小区硬件管理的物联网管理平台
10-13
在这个平台上，通过HTTP、MQTT和Comnet等多种通信协议，HC物联网平台能够与各类小区云平台无缝对接，极大地简化了系统集成和维护工作。 HTTP是一种广泛应用的协议，常用于Web服务，使得设备可以通过互联网进行数据...
基于Java和Vue的HC物联网平台设计源码
03-29
这是一个基于Java和Vue的HC物联网平台设计，使用Java、JavaScript、CSS、Vue和HTML语言开发，包含986个文件。主要文件类型包括451个Java源文件、268个JavaScript文件、79个CSS文件、50个Vue文件、42个XML文件、11个...
HC物联网平台是一款小区硬件管理的物联网管理平台，主要对接各大厂商门禁设备，道闸设备，监控设备，智能锁和充电桩等
最新发布
04-29
HC物联网平台是一款针对小区硬件管理的专业物联网管理解决方案，旨在整合并高效运营各种智能设备，如门禁系统、道闸装置、监控摄像头、智能门锁以及电动汽车充电桩等。这个平台的关键特性在于其高度的兼容性和互操作...
uni-app封装request请求
前端视听
07-10 2万+
在上一篇文章里面，写到使用uni.request请求的方法 https://www.jianshu.com/p/bc62c9e1beed getList() { uni.request({ url: "https://unidemo.dcloud.net.cn/api/news", method: 'get', dataType: 'json', success: (res) => { console.log(res.data
常见的系统间接口方式（03）- 文件传输的系统接口模式
Kerwin-G的博客
05-15 1万+
导读： 原文路径：https://mp.weixin.qq.com/s/FRMMthtA64gaXhBqyTlknw 大家可以关注我个人公众号，所有分享内容，会在公众号第一时间推送，且阅读排版更好。 愿大家的学习，轻松且愉快。 如果大家觉得有用，希望转发关注，谢谢 导读 我们在上一篇内容中，简单介绍了中间数据库的交互模式。 其中，我们提到：如果其他外部公司要与自己企业内部的系统有...
软件间对接时，常用的接口类型和协议类型有哪些
ludanatong的博客
02-18 1万+
软件对接时，常用的接口类型 软件对接时，常用的协议类型 软件系统之间的接口是实现一个系统跟另外系统进行信息交互的桥梁，接口一般分为两种：程序内部的接口和系统对外的接口，软件接口的通常分为两类：webservice接口和http api接口 webservice接口 webService接口是走soap协议通过http传输，请求报文和返回报文都是xml格式的，我们在测试的时候都用通过工具才能进行调用，测试。 http api接口 http api接口是走http协议，通过路径来区分调用的方法，请求报文都是ke
uniApp 实现微信小程序和app视频播放flv格式视频监控
风花一世月
05-08 6974
测试要在真机测试，微信开发者工具不能测试 video 支持 App平台： 支持本地视频(mp4/flv)、网络视频地址(mp4/flv/m3u8)及流媒体(rtmp/hls/rtsp)。 小程序： live-player 支持 app不支持 百度小程序支持 m3u8 格式；微信小程序支持 flv, rtmp 格式 所以决定微信小程序使用liveplayer,app中使用...
为什么request.getCookies()获取不到Cookie？而浏览器缓存中可以看到（已解决）
weixin_44588243的博客
05-29 7732
废话不说上图：可以直接看最后解决方法！ 第一个是设置cookie的代码，第二个是要取cookie的代码。 代码都没有毛病，为什么就是取不到值，很奇怪。 看了浏览器的cookie，明明有值的。。。但是path值确有问题。 有问题的： 修改后正确的如下: 总结： 目前只是发现path路径不同，具体原因烦请各位指点！ 解决方案： 初始化cookie的时候，加一个cookieV.setPath("/"); ...
关于Cookie[] cookies = request.getCookies();报空指针异常的问题解决
PlanetWalker的博客
01-13 6634
项目中报java.lang.NullPointerException异常 Cookie[] cookies = request.getCookies(); for (Cookie cookie:cookies){ if(cookie.getName().equals("token")){ String token=cookie...
Servlet Cookie取不到值原因
diaomu5377的博客
02-13 1617
现象： 在测试带Cookie的HTTP请求时发现，服务端用request.getHeader("cookie")可以去到值;但是用request.getCookies()却不行Cookie mycookies[] = request.getCookies();中永远获取不到uid的值；（80端口号除外） 原因： 查了浏览器的具体cookie值，发现http://localho...
Java进阶学习第十天——request&response
lutianfei的专栏
05-04 5422
response对象（响应对象） HttpServletResponse对象服务器的响应 响应行 响应头 响应体 常见案例 重定向（登陆页面） 页面定时刷新（页面读秒操作） 禁用浏览器缓存（三个头信息） 向页面输出中文（乱码问题） 实现文件下载（初级下载） 实现验证码（重点） request对象（请求对象） 获取客户机信息 获取请求头信息 获取请求参数（重点） 乱码问题解决
Request&Response
msn131420的博客
10-01 664
一、Request和Response的概述 Request是请求对象，Response是响应对象。这两个对象在我们使用Servlet的时候有看到： @WebServlet("/demo1") public class ServletDemo1 implements Servlet { @Override public void service(ServletRequest request, ServletResponse response) throws ServletExcep
东莞电商HC的物联网战略：挑战与发展方向
本文首先系统地介绍了物联网的理论背景，包括其定义、国内外的发展历程，以及在供应链管理中的应用。接着，针对东莞本土物联网企业的现状进行了深入剖析，明确了供应链管理的现有水平和存在的问题。作者还探讨了...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值