【开发文档】智能小区PC客户端接口文档

接口如下:

http://localhost:8080/FamilyGuardAdmin/api.do?handle

查询接口

1.登录接口(参照PlatformAPI项目);

{
    "cmd": "login",
    "user": "hswy", // 用户名
    "pass": "888888", // 密码
    "version": "1.0.0"
}

2.获取小区列表;

{
    "cmd": "community",
    "token": "a343eb67-8d4c-41c2-96a8-33f22aca4b95"
}

3.获取小区下楼宇列表;

{
    "cmd": "building",
    "token": "50657b48-63db-4760-a385-0bd1ac60727e",
    "communityId":"8f861dad-17fd-46a2-8d12-4ec22934f0b9" // 小区ID
}

4.获取具体楼宇、楼层的房间

{
    "cmd": "room",
    "token": "b80a4d06-931d-48d4-a2cb-6678c25fe3ab",
    "buildingId": "1d474687-153c-41f2-9fd8-d306c78df0ea", // 楼宇ID
    "floor":"1", //楼层(可选)
    "roomNo": "101" //房号(可选)
}

5.获取房间的会员列表,会员表使用扩展字段增加身份证号及NFC卡号字段;

{
    "cmd": "member",
    "token": "0bf4b298-b133-432f-a2e1-c133c9c8beab",
    "roomId": "502c43c4-827e-4353-9b2f-2c4080b04130" // 房间ID
}

门禁接口

6.根据身份证号/NFC卡号/临时密码/卡号等判断是否具体有设备开门的权限;

{
    "cmd": "door",
    "code":"设备ID", 
    // 必填一项
    "idCard":"", // 卡号
    "cardNo":"", // 身份证
    "nfcNo":"", // NFC卡号
    "passwd":"279975" // 临时密码
}

7.临时密码生成策略,可提前生成一批临时密码至数据库并缓存至Redis(此时未与房间关联),临时密码被使用后有效期均为24小时有效,过期则可从Redis自动删除。临时密码被申请时则与具体的申请人的房间作关联。

{
    "cmd": "passwd",
    "roomId":"502c43c4-827e-4353-9b2f-2c4080b04130" // 房间ID
}

发表评论

电子邮件地址不会被公开。