版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
ICS03.080.99
CCSM19
DB5206
铜仁市地方标准
DB5206/T157-2023
公共数据综合服务平台接口规范
Interfacespecificationofpublicdataintegratedserviceplatform
2023-07-31发布2023-11-01实施
铜仁市市场监督管理局发布
DB5206/T157—2023
目次
前言Ⅱ
1范围1
2规范性引用文件1
3术语和定义1
4缩略词2
5接口规范2
I
、
DB5206/T157—2023
前 言
本文件按照GB/T1.1-2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定
起草。
本文件由铜仁市大数据发展管理局提出并归口管理。
本文件起草单位:铜仁市大数据发展管理局、贵州梵云大数据集团有限公司、中国电信股份有
限公司铜仁分公司、中国联合网络通信有限公司铜仁市分公司、浪潮云信息技术股份公司。
本文件主要起草人:赵将、雷宏、陈丹、陈进军、李正隆、向辉、杨志刚、牟国强、
杨黔波、宋贺楠、程兴章、施波、杨凡、万嘉华、杨胜明、鲁泓颍、李宗亮、桂先元、李丹、
谭仁飞、陈敏、吕熹、申洋、高健东。
II
、
DB5206/T157—2023
公共数据综合服务平台接口规范
1范围
本文件规定了公共数据综合服务平台的术语和定义、缩略语、接口规范,以及实现接口的具体
要求。
本文件适用于铜仁市公共数据综合服务平台接口的设计与开发。
2规范性引用文件
本文件没有规范性引用文件。
3术语和定义
下列术语和定义适用于本文件。
3.1
接口interface
将应用程序的服务能力封装成接口,并通过API网关开放给客户端调用。
3.2
铜仁市公共数据综合服务平台tongrenpublicdataintegratedserviceplatform
为全市数据提供共享交换的服务平台。
3.3
资源提供方resourceproviders
通过铜仁市公共数据综合服务平台提供资源的实体。
3.4
资源需求方resourcedemanders
通过铜仁市公共数据综合服务平台获取资源的实体。
3.5
WEB接口共享WEBinterfacesharing
通过WEB接口方式进行数据共享,经直接封装或前置机封装,通过目录中心和交换中心发布成功
1
DB5206/T157—2023
后进行的数据交换。
4缩略词
下列缩略词适用于本文件。
SOAP:简单对象访问协议(SimpleObjectAccessProtocol)。
REST:表述性状态传递(RepresentationalStateTransfer)。
JSON:JS对象标记(JavaScriptObjectNotation),一种轻量级的数据交换格式。
HTTPS:超文本传输安全协议(HyperTextTransferProtocoloverSecureSocketLayer)。
Vn:版本号(VersionNumber)。
5接口规范
5.1接口类型
5.1.1REST:REST服务消息封装协议应采用HTTP1.0/1.1标准。
5.1.2WebService:WebService服务消息封装协议应采用SOAP1.1/1.2标准。
资源提供方可以选择其中一种方式进行开发,返回的结果都采用JSON格式。资源提供方在发
布服务的时候需要注明接口的实现方式。
5.2接口地址格式
接口地址采用如下格式:
https://ip:port/部门拼音简写/系统英文名称/模块英文名称/业务操作英文名称/版本号。
部门拼音简写:用每个中文拼音的第一个字母。
系统英文名称:系统的英文缩写,由服务提供者自行定义。
模块英文名称:模块的英文缩写,由服务提供者自行定义。
业务操作英文名称:业务操作处理的英文缩写,由服务提供者自行定义。
版本号:用Vn进行定义。
5.3接口请求方式
接口请求方式应使用GET和POST。
GET:如果资源需求方要获取资源提供方的信息,采用GET请求方式。
POST:如果资源需求方要提交信息给资源提供方,采用POST请求。
5.4接口请求参数
资源需求方在设计传入参数时,应在Body中进行传递,请求参数除了业务系统自身规定的参数
外,还需包含表1的内容。
2
DB5206/T157—2023
表1请求参数类型
请求参数说明是必否须类型
deptName请求部门名称,用于获知该服务被哪个部门调用。是字符串
deptCode请求部门编码,用于获知该服务被哪个部门调用。否字符串
programName请求程序名称,用于获知该服务被哪个业务程序调用。是字符串
用户名,用于安全认证,如果业务系统对安全有要求,可以
userName否字符串
让资源需求方提供认证信息,通过认证后返回业务数据。
用户密码,用于安全认证,如果业务系统对安全有要求,可
password否字符串
以让资源需求方提供认证信息,通过认证后返回业务数据。
当前页(分页参数),需要获取分页数据的时候使用,如果
pageNo否数字
不是分页数据,可以不提供。如果是分页数据,默认为1。
每页记录数(分页参数),需要获取分页数据的时候使用,
pageSize如果不是分页数据,可以不提供。如果是分页数据,默认为否数字
10。
AppKey通过申请获取私人秘钥。是字符串
5.5接口应答内容
接口成功接到请求,应返回状态码,并采用如下数据格式封装:
Code:执行结
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 律师案件处理进度与服务质量绩效分析表
- 2025-2026学年湖北部分高中协作体高一上10月月考生物试卷含答案
- 高中化学实验物质物质有机物酯化反应实验现象观察训练试题及答案
- 2026年化学检验工(高级)职业技能考试题库(重点题库)
- 高中化学物质结构原理分析测试试卷及答案
- 高中生物植物细胞壁结构观察实验设计分析技巧训练试题及答案
- 大学法学民法学物权变动类型案例分析训练试题及答案
- 高三语文一轮复习“叙事要引人入胜”教学设计
- 道德与法治一年级上册第9课《作息有规律》教学设计
- 高二英语译林版选择性必修一Unit 2 Section Ⅴ Extended reading教学设计
- 新苏教版六上数学第4单元第3课《比的意义(3)》课件
- 智能体时代AI基础设施发展研究报告2026-中国电信
- 压力容器爆炸应急处置演练方案
- 成都兴城投资集团有限公司成都天府绿道生态农业科技有限公司2026年招聘农业项目管理等岗位考试模拟试题及答案解析
- 地下综合管廊质量通病和防治
- 四年级(上)数学《多位数乘两位数》专项练习
- VW 80000-2024 中文版 大众汽车电气电子部件环境试验标准(完整原文 + 振动试验部分)
- 长期照护师培训课程大纲
- 内科常见疾病护理常规
- 二年级(上)语文1-8单元高频考点默写单
- 2026年黑龙江省事业单位联考真题及答案
评论
0/150
提交评论