青鸟消防云开放接口
    青鸟消防云开放接口
    • README(开发前必看)
    • 1.事件回调
      • 1.1.事件报送(设备报警、处警、心跳;数据增、删、改)
        POST
      • 1.2.感温电缆注册
        POST
      • 1.3.感温电缆温度上传
        POST
      • 1.4.感温电缆事件
        POST
    • 2.查询接口
      • 2.0.获取Token
        GET
      • 2.1.查询社会单位列表
        GET
      • 2.2.查询设施列表
        GET
      • 2.3.查询设施详情
        GET
      • 2.4.查询设施警情记录
        GET
      • 2.5.查询场所列表
        GET
      • 2.6.查询联系人
        GET
      • 2.7.查询报送记录
        GET
      • 2.8.短信发送记录
        GET
      • 2.9.语音拨打记录
        GET
      • 2.10.查询操作日志(设施)
        GET
      • 2.11.查询操作日志(社会单位)
        GET
      • 2.12.查询操作日志(场所)
        GET
      • 2.13.远程消音
        POST
      • 2.14.远程联动
        POST
      • 2.15.控制器远程控制
        POST
      • 2.16.设备远程控制
        POST
    • 3.数据字典
      • 3.1.警情事件类型
        GET
      • 3.2.警情事件
        GET
      • 3.3.设施类别
        GET
      • 3.4.设施类型
        GET
      • 3.5.模拟量类型
        GET
      • 3.6.传感器类型
        GET
      • 3.7.语音拨打状态
        GET
      • 3.8.处警类型
        GET
      • 3.9.系统类型
        GET
    • 4.上报接口
      • 4.1.事件上报
      • 4.2.设备-新增
      • 4.3.设备-删除
      • 4.4.设备-修改
      • 4.5.无线烟感设备-修改

    README(开发前必看)

    公共参数说明#

    参数类型说明
    endpointstring警情报送http服务地址,由第三方平台提供
    ticketstring警情报送签名票据,可由第三方平台指定,也可由平台随机生成
    X-Signaturestring报文签名
    X-Timestampstring报文签名时间戳
    Monitor-Center-Idnumber监控中心Id。提交对接申请后,由系统管理员分配给第三方
    Fire-Unit-Idnumber防火单位Id。提交对接申请后,由系统管理员分配给第三方
    Tokenstring接口访问令牌 ,参考【查询接口/获取Token】
    Monitor-Center-Id和Fire-Unit-Id仅提供一个即可

    API返回说明#

    参数类型说明
    codenumber1-成功,0-失败
    messagestring提示信息
    dataobject接口返回数据

    安全认证#

    安全认证有两种方式:
    令牌(Token)认证
    http客户端,通过【查询接口/获取Token】得到令牌。客户端发出查询请求时,将Token附加在 http 协议 headers 中,服务端会校验Token是否合法。获取新Token后老Token会立即失效,新Token默认有效期为1小时。
    签名认证
    http客户端根据报文内容(可为空字符串)、时间戳和签名票据,生成签名,附加在 http 协议 headers 中(签名参数名:X-Signature,时间戳参数名:X-Timestamp)。服务端根据签名,校验消息来源。

    签名算法#

    报文内容(可为空字符串)、时间戳、签名票据都采用 utf-8 编码,报文内容+时间戳+签名票据拼接成字符串 string1,对 string1 作 sha1 加密得到签名。

    示例#

    步骤 1:
    报文内容为:
    {"facility":{"addrStr":"869662033589802","descr":"无线设备参与联动测试","facilitiesCode":2,"facilitiesModel":"JBF-VH76N","facilitiesModelId":7,"facilitiesType":"无线感烟","facilitiesTypeCode":332,"facilityId":565788,"isWireless":1},"fireUnit":{"address":"北京市海淀区成府路207号","id":75,"latitude":39.999008,"longitude":116.32534,"name":"北大青鸟"},"stat":[{"time":1565838801,"type":6,"typeStr":"故障","val":66,"valStr":"分离故障"}]}
    当前时间戳为:
    1565838801305
    签名票据为:
    1231
    步骤 2:
    按顺序拼接报文内容、时间戳、签名票据,得到 string1:
    {"facility":{"addrStr":"869662033589802","descr":"无线设备参与联动测试","facilitiesCode":2,"facilitiesModel":"JBF-VH76N","facilitiesModelId":7,"facilitiesType":"无线感烟","facilitiesTypeCode":332,"facilityId":565788,"isWireless":1},"fireUnit":{"address":"北京市海淀区成府路207号","id":75,"latitude":39.999008,"longitude":116.32534,"name":"北大青鸟"},"stat":[{"time":1565838801,"type":6,"typeStr":"故障","val":66,"valStr":"分离故障"}]}15658388013051231
    步骤 3:
    对 string1 进行 sha1 签名,得到签名:
    20770ba8fc475bf417d27a09b0d2c86c52aebba7

    签名算法示例-Java#

    特别注意事项#

    接口频控策略:
    所有接口同一账号2秒钟1次,1小时600次
    我们会根据实际情况,随时调整策略。目的是禁止轮询,防止个别用户访问次数过高,导致其他用户无法使用
    建议初次对接可通过平台Excel导出存量数据,后续数据增、删、改都会通过接口回调告知(参考1.事件回调)

    名词解释#

    本文中,独立式光电感烟火灾探测报警器一般简称无线感烟探测器或独立烟感;防火单位与社会单位同义;

    常见问题#

    警情类型和警情事件的关系?
    警情类型和警情事件是一对多的关系,例如类型是故障,但事件可能是备电故障、备电故障恢复、分离故障、污染故障等。
    火警和报警的区别?
    报警可以理解为预警,一般是模拟量探测设备的模拟量值超过阈值或低于阈值而发出的预警。例如仪表、剩余电流式探测器等。
    警情报送时stat类型为数组,什么情况下stat.length>1?
    设施同时处于多种状态,例如既有分离故障,又有火警(无线感烟探测器探头和底座分离同时发生了火警)。
    数据字典会不会变?
    数据字典一般不会改变,即使改变也是增加,不会变更已有数据,不会影响已有功能,所以获取一次保存下来就够了。
    哪个属性能唯一标识一个消防设施?设施addrStr和facilityId的关系?
    facilityId是消防云数据库同一个设施类别(网关、控制器、现场部件)的唯一标识,同一设施类别全局唯一。但是同一设施在消防云平台删除后,重新注册facilityId会变。
    addrStr是消防设施的标识,对于有线设备,一般内容为“xx机xx-xx”或者“xx机xx-xx xx通道”,例如:“1机 5-4 1通道”,其中“1机”为机器号,“5”为回路号,“4”为部位号,“1通道”为传感器;对于无线设备,内容与印刷在设备上的PSN相同,能唯一标识一个无线设备,例如无线感烟探测器上印刷有PSN,在消防云平台注册无线感烟探测器时需要填写PSN值。
    怎样区分异常和正常?
    警情事件大体可分为:“发生类”、“恢复类”、“其他”。如果警情事件名称中包含“恢复”“撤销”“复位”“在线”即为恢复类,除“其他”和“恢复类”都为发生类。
    设备默认都处在正常状态,如果设备报出任意发生警情事件即算异常。
    从异常恢复到正常有两种方式:
    设备报出恢复类警情事件,比如主电故障与主电故障恢复。
    控制器复位,其下带载的所有设备都恢复正常。比如设施标识(addrStr)为“1机”的设施报出警情事件复位,设施标识为“1机-xx-xx”将全部恢复正常。“1机”代表1号控制器。
    事件回调接口支持https吗?
    支持
    签名计算不一致?
    要保持http body 内容原封不动,签名前不要对body编解码(json),不要改变字符串顺序

    结构示意图#

    下载.png
    下一页
    1.1.事件报送(设备报警、处警、心跳;数据增、删、改)
    Built with