DB3304T 097-2023 政务感知中台数据接口技术规范

ICS35.020CCSL70ICS35.020CCSL70浙 江 省 嘉 兴 市 地 方 标 准DB3304/T097—2023政务感知中台数据接口技术规范Technicalspecificationofdatainterfaceforgovermentsensingmid-end2023-06-05发布 2023-07-05实施嘉兴市场监理局 发布DB3304/T097DB3304/T097—2023II前 言本文件按照GB/T1.1—2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定起草。DB3304/T097DB3304/T097—2023PAGEPAGE1政务感知中台数据接口技术规范范围本文件规定了政务感知中台数据接口的架构、通用要求和接口规范。本文件适用于政务感知中台北向接口和南向接口的设计、开发和维护管理。（GB/T33745—2017物联网术语GB/T36478.1—2018物联网信息交换和共享第1部分：总体架构GB/T33745—2018界定的以及下列术语和定义适用于本文件。3.1政务感知中台governmentsensingmid-end面向于政务领域感知物联网的中台系统，用于连接感知设备接入平台与应用系统，并提供数据接口与实现数据交互能力。缩略语下列缩略语适用于本文件。HTTP：超文本传输协议（HyperTextTransferProtocol）HTTPS：超文本传输安全协议(HyperTextTransferProtocoloverSecureSocketLayer或HyperTextTransferProtocolSecure）JSON：轻量级的数据交换格式（JavaScriptObjectNotation）政务感知中台用于连接设备接入平台与应用系统，实现物联网系统间的信息共享和交换，符合GB/T36478.1—2018中5.1b）要求。中台与物联网系统的关系见图１。政务感知中台算力算法服务感知资源服务应用服务政务感知中台算力算法服务感知资源服务应用服务数据网关应用系统1应用系统2 ... 应用系统n北向接口南向接口物联接入平台视频接入平台设备边缘网关南向接口物联接入平台视频接入平台设备边缘网关设备边缘网关省市县一体化智能化公共数据平台图1 政务知台口构政务感知中台的数据接口宜支持请求/响应模式，宜使用HTTP、HTTPS协议，优先采用加密传输。政务感知中台的数据接口宜支持发布/订阅模式，如Kafka消息队列，优先采用加密传输。应用系统在调用数据接口时，应在请求消息头（如HTTP的head）包含与对appKey和appSecret的签名信息sign；appKey和appSecret在应用系统向中台注册时统一分配，签名信息sign宜通过对appKey、appSecret和timestamp进行MD5运算得出。请求在请求/响应模式下，应遵循统一的数据接口格式，请求消息格式应符合表1给出的规范。表1 请求息用式类型参数名称数据类型说明请求路径path/interface-namestring请求接口的URL路径请求方法POST|GETstring请求方法宜使用HTTP的POST或GET方法请求参数application/jsonstring请求参数，key-value格式DB3304/T097DB3304/T097—2023PAGEPAGE4在请求/响应模式下，应遵循统一的数据接口格式，响应消息格式应符合表2给出的规范。表2 响应息用式类型参数名称数据类型说明响应代码codestringHTTP响应代码，200表示成功响应描述msgstring响应消息描述；响应数据datastring响应数据内容，通常以JSON格式返回字符串键值对。接口描述：向登录手机号码发送短信验证码。接口地址：/hz-auth-center/mobile/sendIdentifyCode。接口类型：POST。请求参数：应符合表3给出的规范。表3 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。phoneNumbersTruebodystring短信接收号码。返回参数：应符合表4给出的规范。表4 返回数表参数名称数据类型说明codestring状态码，200表示成功，其他表示失败。msgstring接口返回码对应信息。resultstring接口返回的数据，此处是短信验证码。/hz-auth-center/mobile/token接口类型：POST。请求参数：应符合表5给出的规范。表5 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。phoneNumbersTruebodystring短信接收号码。identifyCodeTruebodystring手机验证码返回参数：应符合表6给出的规范。表6 返回数表参数名称数据类型说明access_tokenstring认证Token信息token_typestring认证Token的类型，默认：bearerrefresh_tokenstring刷新Token的安全令牌expires_instring认证Token的有效期限scopestring授权范围，默认：allselect。token接口描述：应用系统调用，根据token获取登录用户信息。接口地址：/hz-auth-center/auth/user/me/v2/getDetailInfo。接口类型：GET。请求参数：应符合表7给出的规范。表7 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。phoneNumbersTruebodystring逗号隔开。一次批量发送上限为1000。templateCodeTruebodystring申请，审核通过后下发该消息模板编号。templateParamsTruebodystringJSON空字符串。signIdTruebodystring申请，审核通过后下发该消息签名编号。replyMappingFalsebodystringJSON字符串的形式配置业务编码和业务含义的映射。如果不需要上行短信，则不传此参数即可。返回参数：应符合表8给出的规范。DB3304/T097DB3304/T097—2023PAGEPAGE10表8 返回数表参数名称数据类型说明datastring返回结果，成功返回单次任务的taskId,可根据taskId查询短信结果codestring状态码，200表示成功，其他表示失败msgstring状态描述/sms/send/template/sign/ky接口类型：POST。请求参数：应符合表9给出的规范。表9 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。phoneNumbersTruebodystring逗号隔开。注：一次批量发送上限为1000。templateCodeTruebodystring申请，审核通过后下发该消息模板编号。templateParamsTruebodystringJSON空字符串。signIdTruebodystring申请，审核通过后下发该消息签名编号。replyMappingFalsebodystringJSON字则不传此参数即可。返回参数：应符合表10给出的规范。表10 返回数表参数名称数据类型说明datastring返回结果，成功返回单次任务的taskId,可根据taskId查询短信结果codestring状态码，200表示成功，其他表示失败msgstring状态描述接口描述：由应用系统调用,根据消息模板和消息签名生成消息内容，通过政务用户ID向指定政务组织成员发送浙政钉2.0工作通知，支持向多个成员发送浙政钉2.0消息。注：内容完全相同的一条浙政钉2.0消息，一天内只能向接收人发送一次。接口地址：/dingTalk/send/text/template/sign/userId。接口类型：POST。请求参数：应符合表11给出的规范。表11 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。userIdsTruebodystring接收浙政钉2.0ID.0的userId；如果是浙政钉2.0，请传入2.0的employeeCode。templateCodeTruebodystring消息模板编号，由中台的消息服务管理员在“消息服务控制台”提交消息模板申请，审核通过后下发该消息模板编号。templateParamsTruebodystring消息模板参数，以JSON字符串形式。signIdTruebodystring签名申请，审核通过后下发该消息签名编号。注1：可以指定多个用户ID，即向多个政务用户发送浙政钉2.0消息，多个用户ID用英文逗号隔开。注2：一次批量发送上限为1000。返回参数：应符合表12给出的规范。表12 返回数表参数名称数据类型说明datastringtaskId2.0codestring状态码，200表示成功，其他表示失败。msgstring返回状态的描述信息。/public-api/equip/queryDeviceList接口类型：POST。请求参数：应符合表13给出的规范。表13 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。organizationCodeTruebodystring部门组织coderegionFalsebodystring区域deviceTypeFalsebodystring设备类型（sfspsb01是视频设备,sfspsb02是传感器设备）表13 请参表续）参数名称必填位置数据类型说明deviceGbIdsFalsebodyarray设备id集合返回参数：应符合表14和表15给出的规范。表14 返回数表参数名称数据类型说明codestring状态码，200表示成功，其他表示失败msgstring状态描述dataJSON返回数据，包括下表字段信息。表15 返回数的data信息参数名称数据类型说明addressstring安装地址detailsAddrstring详细地址deviceGbIdstring设备编号deviceSourceIdstring设备源编号-海康设备编号latitudenumber纬度longitudenumber经度manufacturerPersonPhonestring厂家联系电话productIdstring产品类型类型对应的产品名称可看productName参数onlineStatusinteger在线状态（0:离线,1:在线,2:获取失败,3未激活）productNamestring产品名称departIdstring部门iddepartNamestring部门名称updateTimestring设备更新时间/public-api/equip/getDeviceDetail接口类型：POST。请求参数：应符合表16给出的规范。表16 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。deviceIdTruebodystring设备IDorganizationCodeFalsebodystring部门组织code返回参数：应符合表17和表18给出的规范。表17 返回数表参数名称数据类型说明codestring状态码，200表示成功，其他表示失败msgstring状态描述dataJSON返回数据，包括下表字段信息。表18 返回数的data信息参数名称数据类型说明addressstring安装地址anglenumber角度cameraTypestring摄像头类型departIdstring部门iddepartNamestring部门名称detailsAddrstring设备安装地址deviceGbIdstring设备国标编号deviceModelstring设备型号deviceSourceIdstring设备源编号-海康设备编号heightnumber高度labelNamesstring标签名称latitudenumber纬度longitudenumber经度manufacturerstring设备厂商onlineStatusinteger在线状态（0:离线,1:在线,2:获取失败,3未激活）productNamestring产品名称regionstring所属区域updateTimestring设备更新时间videoDevicetypestringsfspsb01视频设备，sfspsb02感知设备eveneventTextstTextsarray监控事件接口描述：应用系统调用，播放指定视频设备的流媒体信息。接口地址：/video。接口类型：GET。请求参数：应符合表19给出的规范。表19 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳表19 请参表续）参数名称必填位置数据类型说明signTrueheadstring签名信息，见6.3。organizationCodeTrueurlstring部门组织codeorganizationNameTrueurlstring部门名称userCodeTrueurlstring用户编码userNameTrueurlstring用户名称deviceGbIdTrueurlstring设备IDeventIdFalseurlstringID，传入次ID15秒视频beginTimeFalseurlstring回放视频开始时间endTimeFalseurlstring回放视频结束时间返回参数：无，直接播放视频流。/public-api/equip/videoControlling。接口类型：POST。请求参数：应符合表20给出的规范。表20 请求数表参数名称必填位置数据类型说明appKeyTrueheadstring应用系统的Key，预先统一分配。timestampTrueheadlong时间戳signTrueheadstring签名信息，见6.3。organizationCodeTruebodystring部门组织codeorganizationNameTruebodystring部门名称actionTruebodyint开始或停止操作0-开始1-停止commandTruebodystring（不区分英文大小写说明：LEFTRIGHTUP转、DOWN下转、ZOOM_IN焦距变大、ZOOM_OUT焦距变小、LEFT_UP左LEFT_DOWNRIGHT_UPRIGHT_DOWNFOCUS_NEARFOCUS_FARIRIS_ENLARGERIS_REDUCE光圈缩小、LOCK锁定、CANCEL_LOCK取消锁定、RESET以下命令presetIndex不可为空：GOTO_PRESET到预置点deviceGbIdTruebodystring设备IDspeedFalsebodyint云台速度(取值范围1‑100,默认40)userCodeTruebodystring用户编码userNameTruebodystring用户名称presetIndexFalsebodyint预置点编号(取值范围为1‑128)timeLimitFalsebodyint锁定时间，单位小时，当command为LOCK时，必传返回参数：应符合表21给出的规范。表21 返回数表参数名称数据类型说明codeint请求状态，200表示成功datajsonstatusint状态：0-设备控制成功；34-8-没有该设备控制权限；9-设备不支持控制msgstring状态描述messagestring状态说明信息urlrtsp/rtmp/hls接口地址：/api/video/v1/cameras/previewURLs。接口类型：POST。数据提交方式：application/json。请求参数：应符合表22给出的规范。表22 请求数表参数名称必填数据类型说明cameraIndexCodestringTrue监控点唯一标识，通过【分页获取监控点资源】获取。streamTypenumberFalse码流类型（0-主码流,1-子码流）,未填默认为主码流protocolstringFalse协议类型（rtsp、rtmp、hls），未填写为rtsp协议transmodenumberFalse传输协议（传输层协议），0:UDP1:TCP默认是TCP。expandstringFalse此字段非必要不建议指定，拓展字段（标准协议取流不需要扩展字段信息当protocolrtspRTSPVLCSDKtranscode=1，表示将H265编码视频转换成H264HLStranscode=0streamform与用“&”连接起来，如transcode=1&streamform=rtp返回参数：应符合表23给出的规范。表23 返回数表参数名称数据类型说明codestring响应码msgstring请求结果信息dataobject以JSON格式封装如下字段：url：string，取流URL地址。发布/如topi