登录 注册
开源 企业版 高校版 私有云 Gitee AI NEW
扫描微信二维码支付
取消
支付完成
Watch
不关注 关注所有动态 仅关注版本发行动态 关注但不提醒动态
1 Star 0 Fork 882

闻仲 / HC小区物联网平台

forked from java110 / HC物联网平台_老版本 
代码 Issues 0 Pull Requests 0 Wiki 统计 流水线
服务
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目，私有仓库也完全免费 ：）
免费加入
克隆/下载
api.md 9.94 KB
一键复制 编辑 原始数据 按行查看 历史
java110 提交于 2020-12-19 13:50 . 清空人脸功能 开发完成

HC 物联网系统对接协议

开发前必读

协议规范设计

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

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

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

通用响应报文格式：

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

通用响应报文字段说明：

名称 类型 描述
code Integer 返回码
msg String 对返回码的文本描述内容
data Object 返回数据（部分接口无返回数据）

通用错误码说明

状态 描述
0 成功
-1 失败

授权认证-获取access_token

根据 appId+appSecret 换取 access_token。access_token 是平台全局接口的唯一凭证，调用其他接口均需携带 access_token 参数。

请求方式：GET

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

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

请求参数:

名称 类型 是否必填 示例值 描述
appId String 是 2fe1465ce30f4bc1b71978d42349c6 APPID
appSecret String 是 2fe1465ce30f4bc1b71978d42349c2 APP 秘钥

响应参数:

名称 类型 示例值 描述
access_token String 2fe1465ce30f4bc1b71978d42349c6 accessToken 访问凭据
expires_in Integer 7200 过期时间为 7200 秒，即 2 小时

响应示例:

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

1.小区资源操作

1.1 新增小区

请求方式： POST

请求地址：/extApi/community/addCommunity

请求参数：

名称 类型 是否必填 示例值 描述
name String 是 HC小区 小区名称
address String 是 青海省西宁市 小区地址
cityCode String 是 510104 地区码
extCommunityId String 是 702020042194860039 小区外部编码

请求示例：

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

返回示例：

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

1.2 修改小区

请求方式： POST

请求地址：/extApi/community/updateCommunity

请求参数：

名称 类型 是否必填 示例值 描述
name String 是 HC小区 小区名称
address String 是 青海省西宁市 小区地址
cityCode String 是 510104 地区码
extCommunityId String 是 702020042194860039 小区外部编码

请求示例：

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

返回示例：

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

1.3 删除小区

请求方式： POST

请求地址：/extApi/community/deleteCommunity

请求参数：

名称 类型 是否必填 示例值 描述
extCommunityId String 是 702020042194860039 小区外部编码

请求示例：

{
    "extCommunityId": "702020042194860039"
}

返回示例：

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

2.设备资源操作

2.1 新增设备

请求方式： POST

请求地址：/extApi/machine/addMachine

请求参数：

名称 类型 是否必填 示例值 描述
machineCode String 是 101010 设备编码
machineVersion String 否 v1.0 设备版本
machineName String 是 HC门禁 设备名称
machineTypeCd String 是 9999 设备类型 门禁9999
machineIp String 否 192.168.1.1 设备IP
machineMac String 否 11:1:11:1 设备mac
extMachineId String 是 702020042194860037 外部设备编码
extCommunityId String 是 702020042194860039 外部小区编码
hmId String 是 1 设备协议 HC物联网系统提供

请求示例：

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

返回示例：

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

2.2 修改设备

请求方式： POST

请求地址：/extApi/machine/updateMachine

请求参数：

名称 类型 是否必填 示例值 描述
machineCode String 是 101010 设备编码
machineVersion String 否 v1.0 设备版本
machineName String 是 HC门禁 设备名称
machineTypeCd String 是 9999 设备类型 门禁9999
machineIp String 否 192.168.1.1 设备IP
machineMac String 否 11:1:11:1 设备mac
extMachineId String 是 702020042194860037 外部设备编码
extCommunityId String 是 702020042194860039 外部小区编码
hmId String 是 1 设备协议 HC物联网系统提供

请求示例：

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

返回示例：

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

2.3 删除设备

请求方式： POST

请求地址：/extApi/machine/deleteMachine

请求参数：

名称 类型 是否必填 示例值 描述
extMachineId String 是 702020042194860037 外部设备编码

请求示例：

{
    "extMachineId": "702020042194860037"
}

返回示例：

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

2.4 远程开门

请求方式： POST

请求地址：/extApi/machine/openDoor

请求参数：

名称 类型 是否必填 示例值 描述
extMachineId String 是 702020042194860037 外部设备编码

请求示例：

{
    "machineCode": "101010"
}

返回示例：

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

2.5 重启设备

请求方式： POST

请求地址：/extApi/machine/restartMachine

请求参数：

名称 类型 是否必填 示例值 描述
extMachineId String 是 702020042194860037 外部设备编码

请求示例：

{
    "machineCode": "101010"
}

返回示例：

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

3.用户资源操作

2.1 添加用户

请求方式： POST

请求地址：/extApi/user/addUser

请求参数：

名称 类型 是否必填 示例值 描述
userId String 是 702020042194860037 用户ID
faceBase64 String 是 base64 base64图片
startTime String 是 2020-12-01 00:00:00 开始时间
endTime String 是 2020-12-31 00:00:00 结束时间
name String 是 张三 名称
idNumber String 否 63216111111111111 身份证
machineCode String 是 101010 设备编码

请求示例：

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

返回示例：

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

2.1 编辑用户

请求方式： POST

请求地址：/extApi/user/updateUser

请求参数：

名称 类型 是否必填 示例值 描述
userId String 是 702020042194860037 用户ID
faceBase64 String 是 base64 base64图片
startTime String 是 2020-12-01 00:00:00 开始时间
endTime String 是 2020-12-31 00:00:00 结束时间
name String 是 张三 名称
idNumber String 否 63216111111111111 身份证
machineCode String 是 101010 设备编码

请求示例：

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

返回示例：

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

2.1 删除用户

请求方式： POST

请求地址：/extApi/user/deleteUser

请求参数：

名称 类型 是否必填 示例值 描述
userId String 是 702020042194860037 用户ID
machineCode String 是 101010 设备编码

请求示例：

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

返回示例：

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

2.1 清空用户

请求方式： POST

请求地址：/extApi/user/clearUser

请求参数：

名称 类型 是否必填 示例值 描述
machineCode String 是 101010 设备编码

请求示例：

{
    "machineCode": "101010"
}

返回示例：

{
    "code":0,
    "msg":"成功",
    "data":""
}
Java
1
https://gitee.com/angeladoudou/MicroCommunityThings.git
git@gitee.com:angeladoudou/MicroCommunityThings.git
angeladoudou
MicroCommunityThings
HC小区物联网平台
master
点此查找更多帮助

搜索帮助

Git 命令在线学习 如何在 Gitee 导入 GitHub 仓库
Git 仓库基础操作
企业版和社区版功能对比
SSH 公钥设置
如何处理代码冲突
仓库体积过大，如何减小？
如何找回被删除的仓库数据
Gitee 产品配额说明
GitHub仓库快速导入Gitee及同步更新
什么是 Release（发行版）
将 PHP 项目自动发布到 packagist.org
评论
仓库举报
回到顶部