DB5206_T 157-2023 公共数据综合服务平台接口规范.docxVIP

ICS?03.080.99 CCS?M?19 DB5206 铜 仁 市 地 方 标 准 DB5206/T?157-2023 公共数据综合服务平台接口规范 Interface?specification?of?public?data?integrated?service?platform 2023-07-31?发布 2023-11-01?实施 铜仁市市场监督管理局 发?布 DB5206/T?157—2023 目 次 前言? Ⅱ 1?范围? 1 2?规范性引用文件 1 3?术语和定义 1 4?缩略词 2 5?接口规范 2 I 、 DB5206/T?157—2023 前??言 本文件按照GB/T?1.1-2020《标准化工作导则?第1部分：标准化文件的结构和起草规则》的规定 起草。 本文件由铜仁市大数据发展管理局提出并归口管理。 本文件起草单位：铜仁市大数据发展管理局、贵州梵云大数据集团有限公司、中国电信股份有 限公司铜仁分公司、中国联合网络通信有限公司铜仁市分公司、浪潮云信息技术股份公司。 本文件主要起草人：赵??将、雷??宏、陈??丹、陈进军、李正隆、向??辉、杨志刚、牟国强、 杨黔波、宋贺楠、程兴章、施??波、杨??凡、万嘉华、杨胜明、鲁泓颍、李宗亮、桂先元、李??丹、 谭仁飞、陈??敏、吕??熹、申??洋、高健东。 II 、 DB5206/T?157—2023 公共数据综合服务平台接口规范 1??范围 本文件规定了公共数据综合服务平台的术语和定义、缩略语、接口规范，以及实现接口的具体 要求。 本文件适用于铜仁市公共数据综合服务平台接口的设计与开发。 2??规范性引用文件 本文件没有规范性引用文件。 3??术语和定义 下列术语和定义适用于本文件。 3.1 3.2 3.3 3.4 3.5 interface接口??? interface 将应用程序的服务能力封装成接口，并通过?API?网关开放给客户端调用。 铜仁市公共数据综合服务平台??tongren?public?data?integrated?service?platform 为全市数据提供共享交换的服务平台。 资源提供方?resource?providers 通过铜仁市公共数据综合服务平台提供资源的实体。 资源需求方?resource?demanders 通过铜仁市公共数据综合服务平台获取资源的实体。 WEB?接口共享?WEB?interface?sharing 通过WEB接口方式进行数据共享，经直接封装或前置机封装，通过目录中心和交换中心发布成功 1 DB5206/T?157—2023 后进行的数据交换。 4??缩略词 下列缩略词适用于本文件。 SOAP：简单对象访问协议（Simple?Object?Access?Protocol）。 REST：表述性状态传递（Representational?State?Transfer）。 JSON：JS对象标记（JavaScript?Object?Notation），一种轻量级的数据交换格式。 HTTPS：超文本传输安全协议（Hyper?Text?Transfer?Protocol?over?SecureSocket?Layer）。 Vn：版本号（Version?Number）。 5??接口规范 5.1??接口类型 5.1.1??REST:REST?服务消息封装协议应采用?HTTP?1.0/1.1?标准。 5.1.2??Web?Service:Web?Service?服务消息封装协议应采用?SOAP?1.1/1.2?标准。 资源提供方可以选择其中一种方式进行开发，返回的结果都采用?JSON?格式。资源提供方在发 布服务的时候需要注明接口的实现方式。 5.2??接口地址格式 接口地址采用如下格式： https://ip:port/部门拼音简写/系统英文名称/模块英文名称/业务操作英文名称/版本号。 部门拼音简写：用每个中文拼音的第一个字母。 系统英文名称：系统的英文缩写，由服务提供者自行定义。 模块英文名称：模块的英文缩写，由服务提供者自行定义。 业务操作英文名称：业务操作处理的英文缩写，由服务提供者自行定义。 版本号：用Vn进行定义。 5.3??接口请求方式 接口请求方式应使用GET和POST。 GET：如果资源需求方要获取资源提供方的信息，采用GET请求方式。 POST：如果资源需求方要提交信息给资源提供方，采用POST请求。 5.4??接口请求参数 资源需求方在设计传入参数时，应在Body中进行传递，请求参数除了业务系统自身规定的参数 外，还需包含表1的内容。 2 请求参数 说明 是必否须 类型 deptName 请求部门名称，用于获知该服务被哪个部门调用。 是 字符串 deptCode 请求部门编码，用于获知该服务被哪