DB3304T097-2023政务感知中台数据接口技术规范.docx
《DB3304T097-2023政务感知中台数据接口技术规范.docx》由会员分享,可在线阅读,更多相关《DB3304T097-2023政务感知中台数据接口技术规范.docx(14页珍藏版)》请在咨信网上搜索。
1、ICS35.020CCSL703304 浙 江 省 嘉 兴 市 地 方 标 准DB 3304/T 0972023政务感知中台数据接口技术规范Technical specification of data interface for goverment sensing mid-end2023 - 06 - 05 发布2023 - 07 - 05 实施嘉兴市市场监督管理局发 布前言本文件按照GB/T 1.12020标准化工作导则 第1部分:标准化文件的结构和起草规则的规定起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由嘉兴市政务服务和数据资源管理办公室提出
2、并归口。 本文件起草单位:平湖市政务服务和数据资源管理办公室、平湖市大数据中心、浙江省大数据发展中心、平湖市农业农村局、嘉兴市政务服务和数据资源管理办公室、嘉兴市大数据中心、杭州城市大数据运营有限公司、睿哲科技股份有限公司、杭州海康威视数字技术股份有限公司。 本文件主要起草人:邬妤琼、金舟、周士飞、李烨、盛春杰、邵洁、濮栋伟、金醇醇、严强、杨国良、李伟波、徐志欢。 政务感知中台数据接口技术规范1 范围本文件规定了政务感知中台数据接口的架构、通用要求和接口规范。 本文件适用于政务感知中台北向接口和南向接口的设计、开发和维护管理。 2 规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件
3、必不可少的条款。其中,注日期的引用文件, 仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。 GB/T 337452017 物联网 术语 GB/T 36478.12018物联网 信息交换和共享 第1部分:总体架构 3 术语和定义GB/T 337452018界定的以及下列术语和定义适用于本文件。 政务感知中台 government sensing mid-end面向于政务领域感知物联网的中台系统,用于连接感知设备接入平台与应用系统,并提供数据接口与实现数据交互能力。 4 缩略语下列缩略语适用于本文件。 HTTP:超文本传输协议(Hyper Text
4、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)要求。中台与物联网系统的关系见图。 3.1政务感知中台算力算法服务感知资源服务应用服务数据网关应用系统1应用系统2.
5、应用系统n北向接口南向接口物联接入平台视频接入平台设备边缘网关设备边缘网关省市县一体化智能化公共数据平台注: 政务感知中台有两类数据接口,北向接口实现与上层应用系统的信息共享与交换;南向接口实现与设备接入平台(物联接入平台和视频接入平台)的感知数据、事件消息的共享与交换。 图1 政务感知中台接口架构6.1 通信协议政务感知中台的数据接口宜支持请求/响应模式,宜使用HTTP、HTTPS协议,优先采用加密传输。 6.2 消息队列政务感知中台的数据接口宜支持发布/订阅模式,如Kafka消息队列,优先采用加密传输。 6.3 接口签名与认证应用系统在调用数据接口时,应在请求消息头(如HTTP的head)
6、包含与对appKey和appSecret的签名信息sign; appKey和appSecret在应用系统向中台注册时统一分配,签名信息sign宜通过对appKey、appSecret和timestamp进行MD5运算得出。 6.4 请求/响应接口格式6.4.1 请求消息通用格式在请求/响应模式下,应遵循统一的数据接口格式,请求消息格式应符合表1给出的规范。 表1 请求消息通用格式6 数据接口通用要求类型 参数名称 数据类型 说明 请求路径 path/interface-name string 请求接口的URL路径 请求方法 POST | GET string 请求方法宜使用HTTP的POST或
7、GET方法 请求参数 application/json string 请求参数,key-value格式 6.4.2 响应消息通用格式在请求/响应模式下,应遵循统一的数据接口格式,响应消息格式应符合表2给出的规范。 表2 响应消息通用格式类型 参数名称 数据类型 说明 响应代码 code string HTTP响应代码,200表示成功 响应描述 msg string 响应消息描述; 响应数据 data string 响应数据内容,通常以JSON格式返回字符串键值对。 7 北向接口规范7.1 登录与鉴权7.1.1 手机号验证码登录7.1.1.1 手机验证码发送接口描述:向登录手机号码发送短信验证码
8、。 接口地址:/hz-auth-center/mobile/sendIdentifyCode。接口类型:POST。 表3 请求参数表返回参数:应符合表4给出的规范。 表4 返回参数表7.1.1.2 手机验证码认证接口描述:通过手机号码+验证码进行登录,验证手机短信验证码是否正确。 接口地址:/hz-auth-center/mobile/token。 接口类型:POST。 请求参数:应符合表5给出的规范。 请求参数:应符合表3给出的规范。 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key,预先统一分配。 timestamp True head
9、 long 时间戳 sign True head string 签名信息,见6.3。 phoneNumbers True body string 短信接收号码。 参数名称 数据类型 说明 code string 状态码,200表示成功,其他表示失败。 msg string 接口返回码对应信息。 result string 接口返回的数据,此处是短信验证码。 表5 请求参数表参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key,预先统一分配。 timestamp True head long 时间戳 sign True head string 签
10、名信息,见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的安全令牌 expires_in string 认证Token的有效期限 scope string 授权范围,默认:all select。 7.1.2 根据 toke
11、n 获取用户信息接口地址:/hz-auth-center/auth/user/me/v2/getDetailInfo。 接口类型:GET。 请求参数:应符合表7给出的规范。 表7 请求参数表返回参数:应符合表8给出的规范。 接口描述:应用系统调用,根据token获取登录用户信息。 参数名称 必填 位置 数据类型 说明 appKey True head string 应用系统的Key,预先统一分配。 timestamp True head long 时间戳 sign True head string 签名信息,见6.3。 phoneNumbers True body string 短信接收号码,
12、支持向多个手机号码发送短信,多个手机号码以英文逗号隔开。一次批量发送上限为1000。 templateCode True body string 消息模板编号,由消息服务管理员在消息服务控制台提交消息模板申请,审核通过后下发该消息模板编号。 templateParams True body string 消息模板各参数内容,以JSON字符串形式。若没有动态参数,直接传空字符串。 signId True body string 消息签名编号,由消息服务管理员在消息服务控制台提交消息签名申请,审核通过后下发该消息签名编号。 replyMapping False body string 如果你的项目
13、允许发送上行短信,且需要用户进行回复,可以JSON字符串的形式配置业务编码和业务含义的映射。如果不需要上行短信, 则不传此参数即可。 返回参数:应符合表10给出的规范。 表10 返回参数表7.2.2 发送浙政钉消息接口描述:由应用系统调用,根据消息模板和消息签名生成消息内容,通过政务用户ID向指定政务组织成员发送浙政钉2.0工作通知,支持向多个成员发送浙政钉2.0消息。 注: 内容完全相同的一条浙政钉2.0消息,一天内只能向接收人发送一次。 表8 返回参数表参数名称 数据类型 说明 data string 返回结果,成功返回单次任务的taskId,可根据taskId查询短信结果 code st
14、ring 状态码,200表示成功,其他表示失败 msg string 状态描述 7.2 消息发送接口7.2.1 发送手机短信接口描述:由应用系统调用,根据消息模板和消息签名生成消息内容,向指定接收人发送手机短信。接口地址:/sms/send/template/sign/ky。 接口类型:POST。 请求参数:应符合表9给出的规范。 表9 请求参数表参数名称必填位置数据类型说明appKey True head string 应用系统的Key,预先统一分配。 timestamp True head long 时间戳 sign True head string 签名信息,见6.3。 phoneNum
15、bers True body string 短信接收号码,支持向多个手机号码发送短信,多个手机号码以英文逗号隔开。注:一次批量发送上限为1000。 templateCode True body string 消息模板编号,由消息服务管理员在消息服务控制台提交消息模板申请,审核通过后下发该消息模板编号。 templateParams True body string 消息模板各参数内容,以JSON字符串形式。若没有动态参数,直接传空字符串。 signId True body string 消息签名编号,由消息服务管理员在消息服务控制台提交消息签名申请,审核通过后下发该消息签名编号。 replyM
16、apping False body string 如果你的项目允许发送上行短信,且需要用户进行回复,可以JSON字符串的形式配置业务编码和业务含义的映射,如果不需要上行短信,则不传此参数即可。 参数名称数据类型说明data string 返回结果,成功返回单次任务的taskId,可根据taskId查询短信结果 code string 状态码,200表示成功,其他表示失败 msg string 状态描述 接口地址:/dingTalk/send/text/template/sign/userId。接口类型:POST。 请求参数:应符合表11给出的规范。 表11 请求参数表参数名称 必填 位置 数据
17、类型 说明 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的employeeCode。 templateCode True body string 消息模板编号,由中台的消息服务管理员在“消息服务控制台”提交消息模板申请,审核通过后下发该消息模板编号。 templatePa
18、rams True body string 消息模板参数,以JSON字符串形式。 signId True body string 消息签名编号,由消息服务管理员在消息服务控制台提交消息签名申请,审核通过后下发该消息签名编号。 注1:可以指定多个用户ID,即向多个政务用户发送浙政钉2.0消息,多个用户ID用英文逗号隔开。 注2:一次批量发送上限为1000。 表12 返回参数表7.3 感知设备信息7.3.1 获取感知设备列表接口描述:应用系统调用,中台根据请求参数查询和筛选感知设备,返回设备列表信息。接口地址:/public-api/equip/queryDeviceList。 接口类型:POST
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- DB3304T097 2023 政务 感知 数据 接口 技术规范
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【Fis****915】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【Fis****915】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。