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

ICS03.080.99CCSM 19DB5206铜仁市地方标准DB5206/T 157-2023公共数据综合服务平台接口规范Interface specification of public data integrated service platform2023-07-31 发布2023-11-01 实施铜仁市市场监督管理局发 布DB5206/T 1572023、I目次前言.1 范围.12 规范性引用文件.13 术语和定义.14 缩略词.25 接口规范.2DB5206/T 1572023、II前言本文件按照GB/T 1.1-2020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。本文件由铜仁市大数据发展管理局提出并归口管理。本文件起草单位：铜仁市大数据发展管理局、贵州梵云大数据集团有限公司、中国电信股份有限公司铜仁分公司、中国联合网络通信有限公司铜仁市分公司、浪潮云信息技术股份公司。本文件主要起草人：赵将、雷宏、陈丹、陈进军、李正隆、向辉、杨志刚、牟国强、杨黔波、宋贺楠、程兴章、施波、杨凡、万嘉华、杨胜明、鲁泓颍、李宗亮、桂先元、李丹、谭仁飞、陈敏、吕熹、申洋、高健东。DB5206/T 15720231公共数据综合服务平台接口规范1范围本文件规定了公共数据综合服务平台的术语和定义、缩略语、接口规范，以及实现接口的具体要求。本文件适用于铜仁市公共数据综合服务平台接口的设计与开发。2规范性引用文件本文件没有规范性引用文件。3术语和定义下列术语和定义适用于本文件。3.1接口interface将应用程序的服务能力封装成接口，并通过 API 网关开放给客户端调用。3.2铜仁市公共数据综合服务平台tongren public data integrated service platform为全市数据提供共享交换的服务平台。3.3资源提供方resource providers通过铜仁市公共数据综合服务平台提供资源的实体。3.4资源需求方resource demanders通过铜仁市公共数据综合服务平台获取资源的实体。3.5WEB 接口共享WEB interface sharing通过WEB接口方式进行数据共享，经直接封装或前置机封装，通过目录中心和交换中心发布成功DB5206/T 15720232后进行的数据交换。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.1REST:REST 服务消息封装协议应采用 HTTP 1.0/1.1 标准。5.1.2Web 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的内容。DB5206/T 15720233表 1请求参数类型请求参数说明是必否须类型deptName请求部门名称，用于获知该服务被哪个部门调用。是字符串deptCode请求部门编码，用于获知该服务被哪个部门调用。否字符串programName请求程序名称，用于获知该服务被哪个业务程序调用。是字符串userName用户名，用于安全认证，如果业务系统对安全有要求，可以让资源需求方提供认证信息，通过认证后返回业务数据。否字符串password用户密码，用于安全认证，如果业务系统对安全有要求，可以让资源需求方提供认证信息，通过认证后返回业务数据。否字符串pageNo当前页（分页参数），需要获取分页数据的时候使用，如果不是分页数据，可以不提供。如果是分页数据，默认为 1。否数字pageSize每页记录数（分页参数），需要获取分页数据的时候使用，如果不是分页数据，可以不提供。如果是分页数据，默认为10。否数字AppKey通过申请获取私人秘钥。是字符串5.5接口应答内容接口成功接到请求，应返回状态码，并采用如下数据格式封装：Code：执行结果代码，0为成功，其他为失败，其他错误代码根据实际情况定义，并在目录中心登记。Message：执行结果信息，如果失败需要返回失败的详细情况。Data：接口应答所包含的数据。Records：总记录数。Pages：总页数。