《数据接口规范》

DB5110

四川省（内江市）地方标准

DB5110/T6—2023

数据接口规范

DataInterfaceStandardSpecification

i

DB5110/T1—2023

目次

前言II

1范围9

2引用文件9

3术语和定义9

3.1政务信息资源9

3.2元数据9

3.3数据服务化9

3.4数据服务接口9

4概述9

5系统架构10

6数据接口共享流程11

6.1数据源11

6.2接口接入11

6.2.1数据表转RESTful服务接入11

6.2.2RESTful接口接入11

6.2.3WebService接口接入11

6.2.4HTTP自定义服务接口接入11

6.3目录发布12

6.4使用审批12

7接口开发要求12

7.1接口方法12

7.2接口要求12

7.3返回参数13

7.4状态码13

8数据共享接口接入样例13

附录A（资料性附录）JSON接口返回模板14

附录B（资料性附录）数据表转RESTful服务接入样例16

附录C（资料性附录）RESTful接口接入样例18

附录D（资料性附录）WebService接口接入样例19

附录E（资料性附录）HTTP自定义服务接口接入样例21

参考文献23

II

DB5110/T1—2023

,11-1-

刖百

标准号：DB5110/T6-2023。

标准名称：数据接口规范。

本标准部分按照GB/T1.1—2020标准化工作导则第1部分：标准化文件的结构和起草规则的规

定起草。

请注意：本标准的某些内容可能涉及专利，本标准的发布机构不承担识别这些专利的先任。

标准归口单位：由内江市大数据中心提出并归口。

标准起草单位：内江市大数据中心、四川云领智城信息科技有限公司、杭州数梦工场科技有限公司。

标准主要起草人：

III

DB5110/T6—2023

I

DB5110/T6—2023

数据接口规范

1范围

本规范规定了内江市全市范围内数据资源共享的系统架陶，定义了数据接口共享流程，为内江市数

据资源共享接口的规划、实施和管理提供指导。

本规范适用于内江市数据资源共享接口的建设与设计工作，主要用于数据资源共享接口的提供方。

2规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注口期的引用文件，仅所注口期的版本适用于本文

件。凡是不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。

GB/T18391.1・2009信息技术元数据注册系统(MDR)第1部分：框架。

GB7T21062.3-2007政务信息资源交换体系第3部分：数据接口规范。

3术语和定义

下列术语和定义适用于本接口规范。

3.1.1

政务信息资源

政务信息资源是指政务部门在履行职责过程中制作或获取的，以一定形式记录、保存的文件、资料、

图表和数据等各类信息资源，包括政务部门直接或通过第三方依法采集的、依法授权管理的和因履行职

责需要依托政务信息系统形成的信息资源等。

3.2

元数据

政务信息资源元数据是对政务数据资源特征的描述，包括：标识符、中文名称、提供部门、共享类

型、开放类型、数据类型、字段名称、定义、值域、表示格式、备注等。

3.3

数据服务化

数据服务化是将政务数据资源转化为标准的数据服务接口的过程。

3.4

数据服务接口

数据服务接口是指信息建设过程中已开发完成，并在政务外网各信息系统间使用的服务接口。常见

9

DB5110/T6—2023

的数据服务接口协议包括WebService、RESTful、HTTP等。

4概述

本规范中的信息资源是指符合国家政务信息资源共享要求的相关数据。

政务数据共享应遵循统筹规划、全面推进、统一标准、便捷高效、主动提供、依法管理、安全可控

的原则。

可通过数据共享接口共享的政务数据资源不包括：

a）涉及国家秘密的；

b）涉及商业秘密的；

c）涉及个人隐私的：

d）法律法规规定不得开放的其他政府数据。

5系统架构

依托于内江市政务信息资源数据中台提供的数据服务接口开发、接入、发布、共享能力，为全省政

务部门及地市的业务系统提供高性能、高可靠的数据共享服务，整体系统架构参考图

幅信息资源目录系统

接口服务同关度口服务网关

接口调用

部门［酬稣的部门I部息系统

图1内江市政务数据接口服务架构图

内江市政务信息资源共享平台由如下七部分组成:

10

DB5110/T6—2023

a）政务信息资源目录系统：在数据共享场景中，政务信息资源目录系统规范了数据服务接口的展

示以及提供接口服务的方法和要求：

b）数据接口服务管理系统：对已发布的数据接口进行统一管控并对各接口服务网关进行运维监

控；

c）接口服务网关：为各部门提供服务注册、发布、管理能力。支持多种接口服务协议，转化为

RESTful服务接入服务网关，为各政务部门提供便捷、高可靠的服务支撑；

d）前置库：用「存储各政务部门共享交换的数据资源的关系型数据库；

e）接口服务：各政务部门提供的接口服务；

f）业务库：各政务部门的业务数据库；

g）文件：以文件形式存储的政务数据资源，如CSV文件、TXT文件等。

6数据接口共享流程

数据接口共享包含如下步骤：共享数据源的确定、对应数据服务服务接口挂接、数据服务接口目录

发布、使用审批。见图2。

共享教据源的确定匚二〉接口接入匚二〉目录发布匚二〉使用审批

图2共享流程

6.1数据源

政务信息资源共享前，数据中台管理方需与数据服务接口提供方就信息资源的共享需求和共享方式

达成一致，包括信息资源名称、内容、用途、共享模式、数据格式等内容。

6.2接口接入

各政务部门完成共享数据接口开发并验证通过后，将对应共享数据接口服务注册到接II服务网关。

接口服务网关具备数据表转服务接入、RESTful接口接入、WebService接口接入、HTTP自定义服务接

口接入等能力。

6.2.1数据表转RESTful服务接入

数据表接入接口服务网关时，需录入服务名称、服务描述、调用阈值、超时时间等，用户根据数据

库的数据元信息完成服务接口配置，自动生成RESTful服务。同时可根据数据共享需要设置过滤、排

序、是否分页等条件。

6.2.2RESTful接口接入

RESTful接口接入时，需录入服务名称、服务描述、调用阈值、超时时间等。采用RESTful接口接

入时，可选择免验证、Basic验证、Digest验证、Token验证等四种代理验证方式。用户也可选择下行

验证方式（如不需要验证和用户名验证）。除上述线上填报外，也可通过手工录入或文件上传的方式开

发RESTful服务，满足多种用户需求。

6.2.3WebService接口接入

WcbScrvicc接口接入时，需录入服务名称、服务描述、调用阈值、超时时间等。采用WcbScrvicc

11

DB5110/T6—2023

接口接入时，可选择免验证、Basic验证、Digest验证、Token验证等四种代理验证方式。用户也可通

过录入WSDL文件完成WcbScrvicc接口的接入，满足多种用户需求。

6.2.4HTTP自定义服务接口凄入

HTTP接口接入时，需录入服务名称、服务描述、调用阈值、超时时间等。采用HTTP接口接入时，

用户可选择代理验证类型（免验证、Basic验证、Digest验证、Token验证），用户也可选择下行验证

方式（如不需要验证和用户名验证）。

6.3目录发布

目录发布流程见图3。

目录编目匚二/部门审核匚二〉中心审批匚二》目录发布

图3目录发布

数据共享接口服务通过政务信息资源目录系统统一管理，可完成数据共享接II的编目'发布。

目录编目阶段由服务提供方的部门人员操作，在发布流程中录入该数据接口服务相关的元数据，包

括信息资源名称、信息资源英文、来源信息系统名称、信息资源提供方、资源提供方代码、信息资源格

式类型、信息资源摘要等。

部门审核阶段由服务提供方的部门权签人员操作，用于审核该数据服务接口发布的正确性并提交至

中心审批。

中心审批由系统平台的管理员操作，用于决策是否发布此数据服务接口。

目录发布后即可在政务信息资源目录系统中统一呈现，便于各政务部门或地市进行申请使用该数据

服务接口。

上述是•个完整的数据服务接口目录发布流程，实际操作中，用户可根据需求对目录发布流程进行

订制。

6.4使用审批

使用审批流程见图4。

接口服务申洁I〉获取审批I供应审批

图4使用审批

接口服务申请阶段由服务申请方的部门使用人员操作，用于触发启动审批流程。

获取审批阶段由服务申请方的部门权签人员操作，用于确认是否有必要申请使用该政务数据资源。

供应审批阶段由服务提供方的部门权签人员操作，用于决策是否对申请部门做服务接口授权。

授权审批后，服务需求部门可调用该信息资源共享接口.

上述是一个完整的使用审批流程，实际操作中用户可按需对使用审批流程进行订制。

7接口开发要求

7.1接口方法

12

DB5110/T6—2023

市数据中台接口管理平台支持HTTPGET/POST和WebService类型接口。接口参数数据全部使

用UTF-8编码格式。接口数据可选取采用XML和JSON两种格式，WebService方法调用只能返回

XML格式。

注：对于非结构化数据接口、在线交互操作接口、地图操作类型接口，市数据中台采用直接代理方式（隐藏原始IP

地址），对请求参数、返回参数格式等不做要求，但是需要提供接口使用说明文档。

7.2接口要求

a）要求服务接口的请求参数和接口登记时录入的参数完全一致；

b）要求返回错误码和接II登记时录入的参数完全一致；

c）要求返回数据时的数据项名称和接口登记的数据项英文名完全一致；

d）要求接口登记的数据项英文名和信息资源目录注册的信息项的英文名保持一致；

e）资源提供方开发的服务接口，无论是HTTP类型的服务接口还是WebService类型的服务接

口，在设计传入参数时，不允许在Header传递参数,应在Body中进行传递；

f）如果提供方接口存在管控参数,例如:秘钥、用户名、密码等。需要告知市共享交付平台具体参

数数据。并给予市数据中台访问权限。管控值需要固定；

g）服务提供方应明确原始接口地址是否有调用限制，例如,有IP或端口限制。

7.3返回参数

在开发服务接口时，接口成功接到请求，应返回200的HTTP状态值。为保障前后端数据交互的

顺畅，应规范数据的返回，并采用固定的数据格式封装。返回参数见表1。

表1返回参数

参数中文名参数英文名类型必填说明

返回码code数字（int）是状态码/错误码

返回信息msg字符串(string)是返回状态描述

返回数据data字符串(string)是具体的真实数据

每页记录数pageSize数字（int）否每页记录数

当前页pageindex数字(int)否当前页

总页数pages数字（ini）否总页数

总记录数count数字（int）是总记录数

注1：JS0N接口返回模板见附录A。

注2：数据核验接口返回值为yes或者noo

7.4状态码

资源提供方开发的服务接口必须提供状态码表。

8数据共享接口接入样例

本章介绍目前数据表转RESTful服务接入（见附录A）、RESTful接口接入（见附录B）,WebService

接口接入（见附录C）及HTTP自定义服务接口接入（见附录D）对应的样例。

13

DB5110/T6—2023

附录A

(资料性附录)

JS0N接口返回模板

(

status:0,

data:{},

〃"

msg:

)

status:接口的执行状态,=0表示成功。

出ita:接口包含的主要数据，可以是JS0N对象。

msg:接口的返回信息

提示:下载数据每页支持最大条数【pageSize][5000]条

JS0N返回示例：

{

"code":"200〃,/*返回码*/

"msg”:〃成功〃，/*返回消息*/

"data":{/*返回数据*/

"pageSize":15,/*每页记录数*/

“pageindex”:1,/*当前页*/

"pages”:10,/*总页数*/

“count":15(),/*总记录数*/

"data":[{/*数据项*/“ISPROCESSED”:ISPROCESSED,"DATADATA

“LOCKTIME”:LOCKTIME,“TASKID”:TASKID,

“USER」D_":USER」D_,

*LOG_NRJ:LOG_NR_,

"EXECUT1ON」D_〃:EXECUTION_ID_,

“TYPE」：TYPE_,

“PROC」NST_II)_":PROC_INST_n)_,

"LOCK_0WNER_":LOCKOWNER.,

“PROC_DEF_ID_":PROC_DEF_ID_,

"TIME_STAMP_*:TIME_STAMP_,

)]}

)

图A.1接口返回错误信息

错误码错误码类型错误码说明

204代理接口错误码未查询到数据

408代理接口错误码请求超时

14

DB5110/T6—2023

错误码错:吴码类型错误码说明

-200服务级错误码请求失败

-10系统级错误码数据签名不存在

-11系统级错误码无效的数据签名

-20系统级错误码时间裁不存在

-21系统级错误码无效的时间找

-30系统级错误码无效的数据返回格式

-40系统级错误码访问的服务不存在

-50系统级错误码用户不存在

-60系统级错误码无效的签名方式

-70系统级错误码用户没有权限访问服务

-80系统级错误码系统错误

-90系统级错误码恶意访问

参数异常=请求参数出错，请检查serviceld、ak、timestamp、

-100系统级错误码

sign、appld是否存在!

-110系统级错误码AK不存在

-120系统级错误码请求时间失立不在有效时间内访问接口！

-130系统级错误码服务状态为:亭用，请检查！

-140系统级错误码服务未申请，请检查！

-150系统级错误码服务申请有效期结束，请检查！

-160系统级错误码服务申请权限已回收，请检查！

-170系统级错误码appld非法或者未经过应用授权

-180代理接口错误类型代理接口错误类型

-190代理接口错误类型接口已升级，需要调用更高版本

15

DB5110/T6—2023

附录B

(资料性附录)

数据表转RESTful服务接入样例

List<Rcst2DbRulcRequestModel>ruleRcquestModcls=newArrayList<>();

Rest2DbRuleRequestModelruleRequestModel=newRest2DbRjleRequestModel();

nilcRcqucstModcl.sctRulcNamc(,'jdbcRulcNamc");

ruleRequestModel.setProxyAuthType("digest");

nileRequestModel.setlIttpPath(,'/test/rule/jdbc,');

ruleRequestModel.setHttpPathMode("custom");

ruleRequestModel.setIIttpMethod(Hgetn);

ruleRequestModel.setCreator("usersystem");

ruleRequestModel.setCreatorGroup("instance01");

ruleRequestModel.sctTypc("OraclcH);

ruleRequestModel.setHost(u46");

nileRequestMode!.setPort(1521);

ruleRequestModel.setDatabaseCORCL");

nileRequestModeLsetTableCtbr*);

ruleRequestModel.setUsemame("username");

ruleRequestModeLsetPassv/ord("password");

ruleRequestModel.sctHasPagination(falsc);

ruleRequestModel.setCountLimit(l00);

nilcRcqucstModcI.sctSqlDcscJson(H!\Htype\,*:\"modcl\,,.\,,modcl\',:!\',columns\*,:[{\',expression\,,:!\"sourc

e\H:\',tbl\",\"column\u:\,,C_CHAR\,,,\"type\":\,,Column\',,\"dataType\',:\"CHAR\',},\,'label\',:\"C_CHAR\,,,\',desc

ription\',:\,,\,,,\H$Sselected\,':false,\"$ShashKey\,,:\,,object:1927\"),{\,,expression\,,:{\"sourceV,:\,'tbl\,,,\,'column\H:

\',C_DATE\',,\,,type\,':V,Column\,,,\"dataType\n:\,,TIMESTAMP\M),\"label\,,:\"C_DATE\,,,\,,description\,,:\,,\,,,\"$

$selected\,,:false,\,'$$hashKey\,':\"object:1933\"}],\,'filter\,':{\,'type\,,:\"Group\',,\"operator\,,:\',And\",\"items\H:[]

,\ndcsc\,,:\"\",\,,S$sclcctcd\":falsc},\"ordcrBy\,,:[],\"sourccs\":[]}}");

ruleRequestModel.setJdbcUrl(,'jdbc:oracle:lhin:@46:1521:ORCLn);

nilcRcquestModcl.setSql("selecttbl.CCHARasCCHAR,tochar(table.CDATE,'yyyy-MM-dd

HH24:mi:ss')asC_DATEfrom:bl")；

RileRequestModel.setDbId(,'d23fdb3b933442ae970073c468de3dl5',);

ruleRequestModel.setMaxPoolSize(100);

ruleRequestModels.add(ruleRequestModel);

StringswaggcrJson="”根据实际服务构造

List<RuleResponse>rest2DbRule=CSBCIientUtil.createRest2DbRules(instance,ruleRequestMcdels,

swaggerJson,false);

16

DB5110/T6—2023

表B.1参数说明

参数名类型是否必需描述

setRuieNameString必选路由名称

setProxyAuthTypeString必选代理认证类型

setllttpPathString可选代理地址路径

setHttpPathModeString必选代理地址生成方式

selHlIpMelliodSuiii^必选http请求方法

setCreatorString必选创建者

setCreatorGroupString必选创建者所属组

setTypcString必选数据库类型

setHostString必选数据库地址

mysql和postgresql下为查询的数据库，

setDatabaseString必选

oracle下为ScrviccNanic

setTableString必选表名

setUsernameString必选用户名

setPasswordString必选密码

sctHasPaginationboolean必选查询是否带分页

setCountLimitlong必选不分页时数据返回条数限制

setSqlDescJsonString必选sql解释json

setJdbcUrlString必选JDBCURL

setSqlString必选SQL语句

setDbldString必选数据源ID

setMaxPoolSizeint必选线程池最大线程数

DB5110/T6—2023

附录C

(资料性附录)

RESTful接口接入样例

List<Rest2RestRuleRequestModel>rest2RestRuleRequesttfodels=newArrayListO():

Rest2RestRu1eRequestMode1rest2RestRu1eRequestMode1=newRest2RestRuleRequestModel();

rest2RestRuleRequestModel.setRuleNameC/restRule/，);

rest2RestRu1eRequestMode1.setProxyAuthType("digest");

rest2RestRuleRequestModel.setHttpPathC/test/rule/rest，z);

rest2RestRulcRequestModcl.sctHttpPathMode("custom");

rest2RestRuleRequestMode1.setHttpMethod("get");

rest2RestRuleRcquestModel.sctCreatorC'uscrsystem");

rest2RestRuleRequestMode1.setCreatorGroup(z，instance0r，);

rest2RestRuleRequestModel.setHasSandbox(false);

rest2RestRuleRequestModel.setRealAddress("http:〃192.168.129.100:9000");

rest2RestRuleRequestModel.setRealHttpPath(z7api/v1/1ist，y);

rest2RestRuleRequestModcl.sctAuthTypc("none");

rest2RestRuleRequestModel.setNeedCertificate(false);

rest2RcstRuleRcquestModcls.add(rest2RestRulcRcquestModcl);

StringswaggerJson=〃"；//根据实际服务构造

List<RuleResponse>rest2RestRule=CSBClientUtil.createRest2RestRule(instance,

rest2RestRu1eRequestMode1s,swaggerJson,null,false);

表C.1参数说明

参数名类型是否必需描述

setRuleNameString必选路由名称

setProxyAuthTypeString必选代理认证类型

setHttpPathString可选代理地址路径

sctHttpPathModeString必选代理地址生成方式

setHttpMethodString必选http请求方法

setCreatorString必选创建者

setCreatorGroupSiring必选创建者所属组

setRealAddressString必选真实服务地址

setBealHttpPathString必选真实服务路径

setAuthTypeString必选真实服务验证类型

setNeedCertificateboolean可选是否需要证书

18

DB5110/T6—2023

附录D

(资料性附录)

WebService接口接入样例

List<Rest2WsRuleRequestModel>ruleRequestModels=newArrayListO();

Rest2WsRu1eRequestMode1rest2WsRu1eRequestMode1=newRest2WsRuleRequestModel0;

rest2WsRu1eRequestMode1.setRuieName(，zWsRuleName/z);

rest2WsRu1eRequestMode1.setProxyAuthType("digest");

rest2WsRuleRequestModel.setHttpPath(/z/test/rule/wsw);

rest2WsRuleRequestModel.sctllttpPathModcC，custom/，);

rest2WsRu1eRequestMode1.setHttpMethod("post");

rest2WsRuleRequestMode1.setCrcator(/zusersystem/，);

rest2WsRu1eRequestMode1.setCreatorGroupinstanceOl〃)；

res12WsRu1eRequestMode1.setSoapAddress(，zhttp://192.168.129.223:8787/service/ws/calculate，z)

»

rest2WsRuleRequestModel.setSoapVersion(〃L1");

rest2WsRuleRequestModel.sctSoapAction(，z/，);

rest2WsRuleRequestModel.selOperationName("describe");

rcst2WsRulcRcqucstModcl.setOperationDcsc(^ImplementsWSDLoperationdescribe");

rest2WsRu1eRequestMode1.setSoapTemplate(，z<soapenv:Enve1ope

xmlns:soapenv=\/zhttp://schemas,xmlsoap.org/soap/envelope/\/z

xmlns:ws=\，，http://ws.test.com/\，，>\n，/+

“<#ifbody??>\n〃+

“<#assignscrviccljson=body?cva]/>\n"+

”</#if>\n"+

“<soapenv:Header/>\n"+

〃<soapenv:Body>\n'+

“<ws:describe/>\n〃+

，z</soapenv:Body>\n，/+

，z</soapenv:Envelope>，/);

rest2WsRuleRequestMode1.setWsdlUrl(*http://192.168.129.223:8787/service/ws/calculate?wsdl

〃)；

rest2W»Ru1eRequestMode1.setBindingName(，，CulculdteImplPortBinding/，);

19

DB5110/T6—2023

rest2WsRu1eRequestMode1.setNeedCertificate(faIse);

ruleRequestModels.add(rest2WsRuleRequestModel);

StringswaggerJson=根据实际服务构造

List<RuleResponse>rest2WsRule=CSBClientUtil.createRest2WsRules(instance,

ruleRequestModels,swaggerjson,null,false);

表D.l参数说明

参数名类型是否必需描述

setRuleNameString必选路由名称

setProxyAuthTypeString必选代理认证类型

setHttpPathString可选代理地址路径

setHttpPathModeString必选代理地址生成方式

sctHttpMcthodString必选http请求方法

setCreatorString必选创建者

setCreatorGroupString必选创建者所属组

setSoapAddressString必选webservice请求地加

sctSoapVcrsionString必选Soap版本

setSoapActionString必选webservices请求url

setOperationNameString必选webservices请求接口名称

setOperalionDescString必选webservices请求接口描述

setSoapTemplateString必选生成的soap模板信息

setWsdllrlString必选webservices请求的wsdl地址

setBindingNameString必选服务绑定名称

setNeedCertificateboolean可选是否需要证书

20

DB5110/T6—2023

附录E

(资料性附录)

HTTP自定义服务接口接入样例

HTTP接口作为一种基于HTTP协议的常用开发接口，在某些场景下可通过HTTP接口的自定义，满足

政府部门对HTTP转发规则的特殊定义要求，实现根据用户指定的规则进行政务信息的共享，如基于HTTP

请求报文自定义转换规则、基于HTTP应答报文自定义转换规则。

通过HTTP自定义规则接口的访问样例：。

List<HttpSe1fDefRu1eRequestMode1>ruleRequestModels=newArrayListO0;

HttpSclfDcfRulcRcquestModclruleRcqucstModel=newHttpSclfDofRuleRcqucstModelD;

intindex=finalI*20+j;

ruleRequestModcl.setRuleName(proxyAuthType+“batchTaslRulcHltp"+index);

ruleRequestModel.setProxyAuthType(proxyAuthType);

ruleRequestModel.setHttpPath('7*+proxyAuthType+*/batch/test/rule/http*+index);

ruleRequestModel.setHttpPathMode(/zcustom，/);

ruleRequestModel.setHttpMethod(，zget/);

ruleRequestModel.sctCrcator("usersystem");

ruleRequestModel.setCreatorGroup("instance01");

ruleRequestModel.sctHasSandbox(false);

ruleRequestModel.setReal/\ddress(，，htlp://192.168.129.100:9000z，);

ruleRequestModel.setRealHttpPath(，7api/vl/list，/);

ru1eRequestMode1.setAuthType("none");

ruleRequestModel.setNeedCertificate(false);

ruleRequestModel.setResponscTypo(z，other，z);

ruleRequestModel.setResponseDecodeJsonObject(false);

ruleRequestModel.sctProxyllttpMcthod(，，gct，/);

ruleRequestModel.setOnlyDecodeFirstLevel(false);

ruleRequestModel.setContainBodyParameter(false);

ru1eRequestMode1.setBodyEnve1opFromHeader(false);

Map<String,HttpSelfDefParameter>headerMap=newHashMapO();

HttpSolfDefParamctcrparameter=newHttpSelfDefParameter();

parameter.setValue("application/json;charset=UTF-8”)；

parameter.sctDynamic(false);

parameter.setRequired(true);

head