DB3304 T 097-2023 政务感知中台数据接口技术规范.pdf

《DB3304 T 097-2023 政务感知中台数据接口技术规范.pdf》由会员分享，可在线阅读，更多相关《DB3304 T 097-2023 政务感知中台数据接口技术规范.pdf（14页珍藏版）》请在麦多课文档分享上搜索。

1、 ICS 35.020 CCS L70 3304 浙江省嘉兴市地方标准 DB 3304/T 0972023 政务感知中台数据接口技术规范 Technical specification of data interface for goverment sensing mid-end2023-06-05 发布2023-07-05 实施嘉兴市市场监督管理局发 布 DB 3304/T 0972023 I 前言 本文件按照GB/T 1.12020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由嘉兴市政务服务

2、和数据资源管理办公室提出并归口。本文件起草单位：平湖市政务服务和数据资源管理办公室、平湖市大数据中心、浙江省大数据发展中心、平湖市农业农村局、嘉兴市政务服务和数据资源管理办公室、嘉兴市大数据中心、杭州城市大数据运营有限公司、睿哲科技股份有限公司、杭州海康威视数字技术股份有限公司。本文件主要起草人：邬妤琼、金舟、周士飞、李烨、盛春杰、邵洁、濮栋伟、金醇醇、严强、杨国良、李伟波、徐志欢。DB 3304/T 0972023 1 政务感知中台数据接口技术规范 1 范围 本文件规定了政务感知中台数据接口的架构、通用要求和接口规范。本文件适用于政务感知中台北向接口和南向接口的设计、开发和维护管理。2 规范

3、性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 337452017 物联网 术语 GB/T 36478.12018物联网 信息交换和共享 第1部分：总体架构 3 术语和定义 GB/T 337452018界定的以及下列术语和定义适用于本文件。3.1 政务感知中台 government sensing mid-end 面向于政务领域感知物联网的中台系统，用于连接感知设备接入平台与应用系统，并提供数据接口与实现数据交互能力。4 缩略语 下列缩略

4、语适用于本文件。HTTP：超文本传输协议（Hyper Text Transfer Protocol）HTTPS：超文本传输安全协议(Hyper Text Transfer Protocol over Secure Socket Layer或Hyper Text Transfer Protocol Secure）JSON：轻量级的数据交换格式（JavaScript Object Notation）5 数据接口架构 政务感知中台用于连接设备接入平台与应用系统，实现物联网系统间的信息共享和交换，符合GB/T 36478.12018中5.1 b）要求。中台与物联网系统的关系见图。DB 3304/T 0

5、972023 2 政务感知中台视频接入平台物联接入平台设备设备边缘网关边缘网关.数据网关应用系统1应用系统2应用系统n北向接口南向接口应用服务感知资源服务算力算法服务省市县一体化智能化公共数据平台 注：政务感知中台有两类数据接口，北向接口实现与上层应用系统的信息共享与交换；南向接口实现与设备接入平台（物联接入平台和视频接入平台）的感知数据、事件消息的共享与交换。图1 政务感知中台接口架构 6 数据接口通用要求 通信协议 6.1 政务感知中台的数据接口宜支持请求/响应模式，宜使用HTTP、HTTPS协议，优先采用加密传输。消息队列 6.2 政务感知中台的数据接口宜支持发布/订阅模式，如Kafka

6、消息队列，优先采用加密传输。接口签名与认证 6.3 应用系统在调用数据接口时，应在请求消息头（如HTTP的head）包含与对appKey和appSecret的签名信息sign；appKey和appSecret在应用系统向中台注册时统一分配，签名信息sign宜通过对appKey、appSecret和timestamp进行MD5运算得出。请求/响应接口格式 6.4 6.4.1 请求消息通用格式 在请求/响应模式下，应遵循统一的数据接口格式，请求消息格式应符合表1给出的规范。表1 请求消息通用格式 类型 参数名称 数据类型 说明 请求路径 path/interface-name string 请求接

7、口的URL路径 请求方法 POST|GET string 请求方法宜使用HTTP的POST或GET方法 请求参数 application/json string 请求参数，key-value格式 DB 3304/T 0972023 3 6.4.2 响应消息通用格式 在请求/响应模式下，应遵循统一的数据接口格式，响应消息格式应符合表2给出的规范。表2 响应消息通用格式 类型 参数名称 数据类型 说明 响应代码 code string HTTP响应代码，200表示成功 响应描述 msg string 响应消息描述；响应数据 data string 响应数据内容，通常以JSON格式返回字符串键值对。

8、7 北向接口规范 登录与鉴权 7.1 7.1.1 手机号验证码登录 7.1.1.1 手机验证码发送 接口描述：向登录手机号码发送短信验证码。接口地址：/hz-auth-center/mobile/sendIdentifyCode。接口类型：POST。请求参数：应符合表3给出的规范。表3 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True head string 签名信息，见6.3。phoneNumbers True body string

9、短信接收号码。返回参数：应符合表4给出的规范。表4 返回参数表 参数名称 数据类型 说明 code string 状态码，200表示成功，其他表示失败。msg string 接口返回码对应信息。result string 接口返回的数据，此处是短信验证码。7.1.1.2 手机验证码认证 接口描述：通过手机号码+验证码进行登录，验证手机短信验证码是否正确。接口地址：/hz-auth-center/mobile/token。接口类型：POST。请求参数：应符合表5给出的规范。DB 3304/T 0972023 4 表5 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True he

10、ad string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True head string 签名信息，见6.3。phoneNumbers True body string 短信接收号码。identifyCode True body string 手机验证码 返回参数：应符合表6给出的规范。表6 返回参数表 参数名称 数据类型 说明 access_token string 认证Token信息 token_type string 认证Token的类型，默认：bearer refresh_token string 刷新Token的安全令牌

11、 expires_in string 认证Token的有效期限 scope string 授权范围，默认：all select。7.1.2 根据 token 获取用户信息 接口描述：应用系统调用，根据token获取登录用户信息。接口地址：/hz-auth-center/auth/user/me/v2/getDetailInfo。接口类型：GET。请求参数：应符合表7给出的规范。表7 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True hea

12、d string 签名信息，见6.3。phoneNumbers True body string 短信接收号码，支持向多个手机号码发送短信，多个手机号码以英文逗号隔开。一次批量发送上限为1000。templateCode True body string 消息模板编号，由消息服务管理员在消息服务控制台提交消息模板申请，审核通过后下发该消息模板编号。templateParams True body string 消息模板各参数内容，以JSON字符串形式。若没有动态参数，直接传空字符串。signId True body string 消息签名编号，由消息服务管理员在消息服务控制台提交消息签名申请，

13、审核通过后下发该消息签名编号。replyMapping False body string 如果你的项目允许发送上行短信，且需要用户进行回复，可以JSON字符串的形式配置业务编码和业务含义的映射。如果不需要上行短信，则不传此参数即可。返回参数：应符合表8给出的规范。DB 3304/T 0972023 5 表8 返回参数表 参数名称 数据类型 说明 data string 返回结果，成功返回单次任务的taskId,可根据taskId查询短信结果 code string 状态码，200表示成功，其他表示失败 msg string 状态描述 消息发送接口 7.2 7.2.1 发送手机短信 接口描述：

14、由应用系统调用,根据消息模板和消息签名生成消息内容，向指定接收人发送手机短信。接口地址：/sms/send/template/sign/ky。接口类型：POST。请求参数：应符合表9给出的规范。表9 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True head string 签名信息，见6.3。phoneNumbers True body string 短信接收号码，支持向多个手机号码发送短信，多个手机号码以英文逗号隔开。注：一次批量发送上

15、限为1000。templateCode True body string 消息模板编号，由消息服务管理员在消息服务控制台提交消息模板申请，审核通过后下发该消息模板编号。templateParams True body string 消息模板各参数内容，以JSON字符串形式。若没有动态参数，直接传空字符串。signId True body string 消息签名编号，由消息服务管理员在消息服务控制台提交消息签名申请，审核通过后下发该消息签名编号。replyMapping False body string 如果你的项目允许发送上行短信，且需要用户进行回复，可以JSON字符串的形式配置业务编码和业

16、务含义的映射，如果不需要上行短信，则不传此参数即可。返回参数：应符合表10给出的规范。表10 返回参数表 参数名称 数据类型 说明 data string 返回结果，成功返回单次任务的taskId,可根据taskId查询短信结果 code string 状态码，200表示成功，其他表示失败 msg string 状态描述 7.2.2 发送浙政钉消息 接口描述：由应用系统调用,根据消息模板和消息签名生成消息内容，通过政务用户ID向指定政务组织成员发送浙政钉2.0工作通知，支持向多个成员发送浙政钉2.0消息。注：内容完全相同的一条浙政钉2.0消息，一天内只能向接收人发送一次。DB 3304/T 0

17、972023 6 接口地址：/dingTalk/send/text/template/sign/userId。接口类型：POST。请求参数：应符合表11给出的规范。表11 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True head string 签名信息，见6.3。userIds True body string 接收浙政钉2.0消息的政务用户ID。如果是浙政钉1.0，请传入1.0的userId；如果是浙政钉2.0，请传入2.0的empl

18、oyeeCode。templateCode True body string 消息模板编号，由中台的消息服务管理员在“消息服务控制台”提交消息模板申请，审核通过后下发该消息模板编号。templateParams True body string 消息模板参数，以JSON字符串形式。signId True body string 消息签名编号，由消息服务管理员在消息服务控制台提交消息签名申请，审核通过后下发该消息签名编号。注1：可以指定多个用户ID，即向多个政务用户发送浙政钉2.0消息，多个用户ID用英文逗号隔开。注2：一次批量发送上限为1000。返回参数：应符合表12给出的规范。表12 返回参

19、数表 参数名称 数据类型 说明 data string 返回结果，成功返回单次任务的taskId，可根据taskId查询浙政钉2.0结果。code string 状态码，200表示成功，其他表示失败。msg string 返回状态的描述信息。感知设备信息 7.3 7.3.1 获取感知设备列表 接口描述：应用系统调用，中台根据请求参数查询和筛选感知设备，返回设备列表信息。接口地址：/public-api/equip/queryDeviceList。接口类型：POST。请求参数：应符合表13给出的规范。表13 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head st

20、ring 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True head string 签名信息，见6.3。organizationCode True body string 部门组织code region False body string 区域 deviceType False body string 设备类型（sfspsb01 是视频设备,sfspsb02 是传感器设备）DB 3304/T 0972023 7 表13 请求参数表（续）参数名称 必填 位置 数据类型 说明 deviceGbIds False body array 设备

21、id集合 返回参数：应符合表14和表15给出的规范。表14 返回参数表 参数名称 数据类型 说明 code string 状态码，200表示成功，其他表示失败 msg string 状态描述 data JSON 返回数据，包括下表字段信息。表15 返回参数表中的 data 字段信息 参数名称 数据类型 说明 address string 安装地址 detailsAddr string 详细地址 deviceGbId string 设备编号 deviceSourceId string 设备源编号-海康设备编号 latitude number 纬度 longitude number 经度 manu

22、facturerPersonPhone string 厂家联系电话 productId string 产品类型 类型对应的产品名称可看productName参数 onlineStatus integer 在线状态（0:离线,1:在线,2:获取失败,3 未激活）productName string 产品名称 departId string 部门id departName string 部门名称 updateTime string 设备更新时间 7.3.2 获取感知设备详情 接口描述：应用系统调用，中台根据请求参数查询并返回感知设备详情信息。接口地址：/public-api/equip/getDe

23、viceDetail。接口类型：POST。请求参数：应符合表16给出的规范。表16 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True head string 签名信息，见6.3。deviceId True body string 设备ID organizationCode False body string 部门组织code DB 3304/T 0972023 8 返回参数：应符合表17和表18给出的规范。表17 返回参数表 参数名称 数

24、据类型 说明 code string 状态码，200表示成功，其他表示失败 msg string 状态描述 data JSON 返回数据，包括下表字段信息。表18 返回参数表中的 data 字段信息 参数名称 数据类型 说明 address string 安装地址 angle number 角度 cameraType string 摄像头类型 departId string 部门id departName string 部门名称 detailsAddr string 设备安装地址 deviceGbId string 设备国标编号 deviceModel string 设备型号 deviceSo

25、urceId string 设备源编号-海康设备编号 height number 高度 labelNames string 标签名称 latitude number 纬度 longitude number 经度 manufacturer string 设备厂商 onlineStatus integer 在线状态（0:离线,1:在线,2:获取失败,3 未激活）productName string 产品名称 region string 所属区域 updateTime string 设备更新时间 videoDevicetype string sfspsb01视频设备，sfspsb02感知设备 eve

26、neventTextstTexts array 监控事件 7.3.3 播放视频流媒体 接口描述：应用系统调用，播放指定视频设备的流媒体信息。接口地址：https:/ 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 DB 3304/T 0972023 9 表19 请求参数表（续）参数名称 必填 位置 数据类型 说明 sign True head string 签名信息，见6.3。organizationCode True url string 部门组织cod

27、e organizationName True url string 部门名称 userCode True url string 用户编码 userName True url string 用户名称 deviceGbId True url string 设备ID eventId False url string 事件ID，传入次ID，即播放事件回放视频，默认播放时间前后15秒视频 beginTime False url string 回放视频开始时间 endTime False url string 回放视频结束时间 返回参数：无，直接播放视频流。7.3.4 控制摄像头设备 接口描述：应用系统

28、调用，中台通过请求参数，再调用视频接入平台实现摄像头设备的控制。接口地址：/public-api/equip/videoControlling。接口类型：POST。请求参数：应符合表20给出的规范。表20 请求参数表 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key，预先统一分配。timestamp True head long 时间戳 sign True head string 签名信息，见6.3。organizationCode True body string 部门组织code organizationName True body s

29、tring 部门名称 action True body int 开始或停止操作 0-开始 1-停止 command True body string 控制命令（区分英文大小写）说明：LEFT左转、RIGHT右转、UP上转、DOWN下转、ZOOM_IN焦距变大、ZOOM_OUT焦距变小、LEFT_UP左上、LEFT_DOWN左下、RIGHT_UP右上、RIGHT_DOWN右下、FOCUS_NEAR焦点前移、FOCUS_FAR焦点后移、IRIS_ENLARGE光圈扩大、RIS_REDUCE光圈缩小、LOCK锁定、CANCEL_LOCK取消锁定、RESET复位；以下命令presetIndex可为空：

30、GOTO_PRESET到预置点 deviceGbId True body string 设备ID speed False body int 云台速度(取值范围1100,默认40)userCode True body string 用户编码 userName True body string 用户名称 presetIndex False body int 预置点编号(取值范围为1128)timeLimit False body int 锁定时间，单位小时，当command为LOCK时，必传 DB 3304/T 0972023 10 返回参数：应符合表21给出的规范。表21 返回参数表 参数名称

31、数据类型 说明 code int 请求状态，200表示成功 data json status int 状态：0-设备控制成功；3-设备已被其他用户控制中；4-该时间段未申请控制；8-没有该设备控制权限；9-设备不支持控制 msg string 状态描述 message string 状态说明信息 8 南向接口规范 获取视频链接地址 8.1 接口描述：中台调用“视频接入平台”，根据监控点编号获取视频预览url，获取到的预览url可用于支持rtsp/rtmp/hls取流协议的播放器中播放，中台通过此接口实现与预览有关的能力。接口地址：/api/video/v1/cameras/previewURL

32、s。接口类型：POST。数据提交方式：application/json。请求参数：应符合表22给出的规范。表22 请求参数表 参数名称 必填 数据类型 说明 cameraIndexCode string True 监控点唯一标识，通过【分页获取监控点资源】获取。streamType number False 码流类型（0-主码流,1-子码流）,未填默认为主码流 protocol string False 协议类型（rtsp、rtmp、hls），未填写为rtsp协议 transmode number False 传输协议（传输层协议），0:UDP1:TCP默认是TCP。expand string

33、 False 此字段非必要不建议指定，拓展字段（标准协议取流不需要扩展字段信息）当protocol为rtsp时：支持指定streamform=rtp，表示使用标准RTSP协议，典型如使用VLC播放。当使用海康取流播放工具如视频SDK时，请勿指定streamform=rtp。支持指定transcode=1，表示将H265编码视频转换成H264编码，典型使用场景如HLS播放。指定transcode=0表示不转码，默认为transcode=0。可以同时指定streamform与transcode，但二者必须使用“&”连接起来，如transcode=1&streamform=rtp 返回参数：应符合表

34、23给出的规范。表23 返回参数表 参数名称 数据类型 说明 code string 响应码 msg string 请求结果信息 data object 以JSON格式封装如下字段：url：string，取流URL地址。DB 3304/T 0972023 11 发布通知消息 8.2 8.2.1 发布/订阅模式 在发布通知消息时，宜采用发布/订阅模式（如kafka），当应用系统在政务感知中台注册时，统一分配唯一的topic，通过订阅该topic接受通知消息。8.2.2 发布事件消息 8.2.2.1 算法事件消息格式 订阅了算法事件topic后，当算法事件发生时，将接收到算法事件消息通知，字段规范

35、应符合表24给出的规范。表24 算法事件消息字段规范 字段名称 必填 数据类型 说明 address True string 产生事件消息的设备地址 productId True string 设备产品id messageType True number 消息类型 2-表示后端算法消息 eventSource True string 事件来源 eventType True string 事件类型 deviceSn True string 设备编号 productName True string 产品名称 happenTime True string 事件发生时间 data True JSON

36、不同算法事件不一致，对应业务自行解析 8.2.2.2 故障告警消息格式 订阅了故障告警topic后，当发生故障时，将接收到故障告警消息通知，字段规范应符合表25给出的规范。表25 故障告警消息字段规范 字段名称 必填 数据类型 说明 baseAlgorithmName True string 消息名称 messageType True number 消息类型 3-表示故障告警 address true string 设备地址 eventSource True string 数据来源 deviceSn True string 设备编号 productName True string 产品名称 h

37、appenTime True string 事件发生时间 8.2.3 发布设备数据消息 订阅了设备数据topic后，当产生设备数据时，将接收到设备数据消息通知，字段规范应符合表26给出的规范。DB 3304/T 0972023 12 表26 设备数据消息字段规范 字段名称 必填 数据类型 说明 productId True string 设备产品id messageType True number 消息类型 1-表示设备感知数据 eventSource True string 数据来源 deviceSn True string 设备编号 productName True string 产品名称 happenTime True string 事件发生时间 data True JSON 不同设备感知数据不一致，对应业务自行解析