websocket client面板机业务协议.doc

,并增加人脸业务相关协议。/9//10//11//12/20Web设置Websocket数据下发协议使用概述该协议面板机作为WebsocketClient端主动连接服务器,和服务器建立Websocket连接后,服务器调用下发请求数据,设备端执行后回复数据。需要在设备的Web端配置WebsocketURL。Websocket请求headr项内容说明HTTPMethodGETHTTPURLws://<IP>:Port/URL?SerialNo=RY231SerialNo产品系列号,唯一标识。Websocketweb设置websocket认证流程(不填写密钥则无需认证)ExampleDescriptionValue备注说明1,设备->网关:login(1){"method":"login","params":{"SN":"SN00000001"}}->设备:401(Unauthorized){"result":false,"error":{"code":401,"nonce":"102adc3901","message":"Unauthorized"}}->网关:login(2)参数:SN,nonce,hmac(SN+nonce,serckey),realm{"method":"login","params":{"SN":"SN00000001","nonce":"102adc3901","sign":"102adc3901102adc","realm":"XXXX"}}->设备:200(OK)参数:authInfo{"result":true,"authInfo":"XXXXXX"}认证签名算法sign=hmac256(SN+":"+nonce,sercKey)https认证签名算法sign=hmac256(SN+":"+t+seq+body,sercKey)authInfo生成算法authInfo=hmac256(SN+":"+realm,sercKey)保活方式使用websocket协议层标准pingpong模式保活人员操作业务接口人员增加(编号重复时覆盖)ExampleDescriptionValue是否为必填Request(服务器---->设备){"id":12,回复id编号;成对出现,用来关联平台的发送和设备的回复int"method":"","params":[{"Person":{"Type":1,人员类型,1-内部员工,2-访客,3-黑名单;必填"Code":"10086",证件号,与CertificateType组合构成全局唯一人员标识,不允许更新,避免前端和平台端不一致。必填"GroupName":"默认权限组",必填"Name":"张三",姓名必填"Sex":"male",性别必填"Birthday":"1980-01-01"出生日期必填"GuestInfo":{ 访客信息,人员类型是访客时有效(非访客不填)"Corp":"",单位"Phone":"**********",电话"CarLicense":"",车牌号码"Partner":5,随行人数"Host":"李四",被访人"AccessTime":[{ 准入时间"from":1541756000,开始时间"to":1541856000结束时间}]}//GuestInfo"URL":["/picture/"]通过HTTP协议下载图片的地址;只支持JPG格式;两者里面只能选一个"Images":["base64Data"]Base64编码的图片数据,与URL字段互斥;"Cards":[{卡信息"ID":"abcd"卡号"Type":1,卡类型,1-普通卡,2-胁迫卡"Validity":[有效期日期"2018-10-1",开始日期,yyyy-MM-dd"2019-10-1"结束日期,yyyy-MM-dd],//Validity"Validit