DB37-T 4560.4-2022政府网站集约化平台 第4部分:接口规范_第1页
DB37-T 4560.4-2022政府网站集约化平台 第4部分:接口规范_第2页
DB37-T 4560.4-2022政府网站集约化平台 第4部分:接口规范_第3页
DB37-T 4560.4-2022政府网站集约化平台 第4部分:接口规范_第4页
DB37-T 4560.4-2022政府网站集约化平台 第4部分:接口规范_第5页
已阅读5页,还剩18页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

ICS35.240.99

CCSL67

37

山东省地方标准

DB37/T4560.4—2022

政府网站集约化平台

第4部分:接口规范

Intensiveplatformofgovernmentwebsites—Part4:Interfacespecifications

2022-11-30发布2022-12-30实施

山东省市场监督管理局发布

DB37/T4560.4—2022

目次

前言.................................................................................II

引言................................................................................III

1范围...............................................................................1

2规范性引用文件.....................................................................1

3术语和定义.........................................................................1

4缩略语.............................................................................1

5接口目录...........................................................................1

6接口表示要求.......................................................................2

7各集约化平台间对接接口.............................................................2

7.1信息资源同步...................................................................2

7.2附件上传.......................................................................3

7.3信息资源获取...................................................................4

8集约化平台与政府网站信息资源共享库对接接口.........................................5

8.1信息资源列表查询...............................................................5

8.2信息资源获取...................................................................6

8.3信息资源新增...................................................................7

8.4信息资源修改...................................................................8

8.5信息资源删除...................................................................9

8.6信息资源移动..................................................................10

附录A(资料性)各集约化平台间对接接口返回示例......................................12

A.1信息资源同步..................................................................12

A.2附件上传......................................................................12

A.3信息资源获取..................................................................12

附录B(资料性)集约化平台与政府网站信息资源共享库对接接口返回示例..................14

B.1信息资源列表查询..............................................................14

B.2信息资源获取..................................................................14

B.3信息资源新增..................................................................15

B.4信息资源修改..................................................................15

B.5信息资源删除..................................................................15

B.6信息资源移动..................................................................15

参考文献.............................................................................16

I

DB37/T4560.4—2022

前言

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

起草。

本文件是DB37/T4560《政府网站集约化平台》的第4部分。DB37/T4560已经发布了以下部分:

——第1部分:总体要求;

——第2部分:网站迁移规范;

——第3部分:数据规范;

——第4部分:接口规范。

请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。

本文件由山东省大数据局提出、归口并组织实施。

II

DB37/T4560.4—2022

引言

推进政府网站集约化建设是山东省政府部署实施的一项重点工程,对于打破信息壁垒、推进集约共

享,建设整体联动、高效便民的网上政府,具有重要意义。本文件旨在为政府网站集约化平台建设和管

理提供指导,有效推进政府网站集约化建设和迁移实施。

DB37/T4560预计分为4个部分:

——第1部分:总体要求。本部分旨在规范政府网站集约化平台层级架构、总体架构、共享交换

要求等内容。

——第2部分:网站迁移规范。本部分旨在规范政府网站迁移至政府网站集约化平台的迁移要求

等内容。

——第3部分:数据规范。本部分旨在规范政府网站集约化平台数据分类、数据格式等内容。

——第4部分:接口规范。本部分旨在规范政府网站集约化平台数据共享交换接口等内容。

III

DB37/T4560.4—2022

政府网站集约化平台

第4部分:接口规范

1范围

本文件规定了政府网站集约化平台(以下简称“集约化平台”)间、集约化平台与政府网站信息资

源共享库间对接的接口要求。

本文件适用于各级集约化平台通过接口进行的共享交换。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,

仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本

文件。

DB37/T4560.1政府网站集约化平台第1部分:总体要求

3术语和定义

DB37/T4560.1界定的术语和定义适用于本文件。

4缩略语

下列缩略语适用于本文件。

HTTP:超文本传输协议(HyperTextTransferProtocol)

HTTPS:超文本安全传输协议(HyperTextTransferProtocolSecure)

ID:身份标识码(IdentityDocument)

JSON:JavaScript对象简谱(JavaScriptObjectNotation)

URL:统一资源定位器(UniformResourceLocator)

UUID:唯一通用标识码(UniversallyUniqueIdentifier)

5接口目录

政府网站信息资源(以下简称“信息资源”)对接接口包括各集约化平台间的对接接口、集约化平

台与政府网站信息资源共享库间的对接接口,接口目录见表1。

1

DB37/T4560.4—2022

表1接口目录

序号接口分类接口名称

1信息资源同步

2各集约化平台间对接接口附件上传

3信息资源获取

4信息资源列表查询

5信息资源获取

6信息资源新增

集约化平台与政府网站信息资源共享库间对接接口

7信息资源修改

8信息资源删除

9信息资源移动

6接口表示要求

接口表示要求包括但不限于:

a)接口描述:应描述出接口的功能概要信息;

b)接口方式:应给出接口采用的请求方式;

c)输入参数:应给出参数名称、数据类型、说明等输入信息;

d)输出参数:若有输出参数,应给出参数名称、数据类型、说明等输出信息;

e)接口返回示例:应给出接口返回示例,接口返回示例见附录A、附录B。

接口输入参数、输出参数中允许的数据类型见表2。

表2参数数据类型

数据类型说明

字符型通过字符形式表达的值的类型

数字型通过从“0”到“9”数字形式表达的值的类型

日期型通过YYYY—MM—DD的形式表达的值的类型,符合GB/T7408

通过YYYYMMDDhhmmss或YYYY—MM—DDhh:mm:ss的形式表达的值的类型,符合GB/T

日期时间型

7408

7各集约化平台间对接接口

7.1信息资源同步

7.1.1接口描述

用于向其他集约化平台推送信息资源。

7.1.2接口方式

接口方式为HTTP/HTTPS。

2

DB37/T4560.4—2022

7.1.3输入参数

接口输入参数见表3。

表3输入参数

序号参数名称数据类型说明

1站点ID数字型信息资源所属站点的数字编号

2栏目ID数字型信息资源所属栏目的数字编号

3时间戳数字型记录获取信息资源的时间,单位精确至毫秒

4站点签名值字符型用于验证同步信息资源的来源站点

5信息内容字符型推送的信息资源具体内容

7.1.4输出参数

返回JSON字符串,接口输出参数见表4。

表4输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

7.1.5接口返回示例

接口返回示例见A.1。

7.2附件上传

7.2.1接口描述

用于向其他集约化平台同步信息资源时附件的上传。

7.2.2接口方式

接口方式为HTTP/HTTPS。

7.2.3输入参数

接口输入参数见表5。

3

DB37/T4560.4—2022

表5输入参数

序号参数名称数据类型说明

1站点ID数字型附件上传站点的数字编号

2栏目ID数字型附件上传栏目的数字编号

3时间戳数字型记录获取信息资源的时间,单位精确至毫秒

4站点签名值字符型用来验证同步信息资源的来源站点

5附件信息字符型上传的附件信息内容,包括附件名称、访问链接等

7.2.4输出参数

返回JSON字符串,接口输出参数见表6。

表6输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

7.2.5接口返回示例

接口返回示例见A.2。

7.3信息资源获取

7.3.1接口描述

用于从其他集约化平台获取所需的信息资源。

7.3.2接口方式

接口方式为HTTP/HTTPS。

7.3.3输入参数

接口输入参数见表7。

表7输入参数

序号参数名称数据类型说明

1站点ID数字型信息资源所属站点的数字编号

2栏目ID数字型信息资源所属栏目的数字编号

3时间戳数字型记录获取信息资源的时间,单位精确至毫秒

4

DB37/T4560.4—2022

表7输入参数(续)

序号参数名称数据类型说明

4站点签名值字符型用来验证同步信息资源的来源站点

信息资源发布区间的起始时间,YYYY—MM—DDhh:mm:ss的形式,符

5起始时间日期时间型

合GB/T7408

信息资源发布区间的结束时间,YYYY—MM—DDhh:mm:ss的形式,符

6结束时间日期时间型

合GB/T7408

7.3.4输出参数

返回JSON字符串,接口输出参数见表8。

表8输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

3信息内容字符型获取的信息资源具体内容

7.3.5接口返回示例

接口返回示例见A.3。

8集约化平台与政府网站信息资源共享库对接接口

8.1信息资源列表查询

8.1.1接口描述

用于通过指定栏目ID查询政府网站信息资源共享库的信息资源,仅展现指定栏目下的信息资源列表,

并不查看具体信息资源内容。

8.1.2接口方式

接口方式为HTTP/HTTPS。

8.1.3输入参数

接口输入参数见表9。

5

DB37/T4560.4—2022

表9输入参数

序号参数名称数据类型说明

1集约化平台ID数字型指定栏目所属集约化平台的数字编号

2政府网站ID数字型指定栏目所属政府网站的数字编号

3栏目ID数字型指定栏目的数字编号

4关键词字符型查询信息资源时输入的关键字

信息资源检索范围代码;

0-全字段;

5查询范围数字型

1-作者;

2-标题

查询信息资源的开始时间,YYYY—MM—DDhh:mm:ss的形式,符合GB/T

6开始时间日期时间型

7408

查询信息资源的结束时间,YYYY—MM—DDhh:mm:ss的形式,符合GB/T

7结束时间日期时间型

7408

8.1.4输出参数

返回JSON字符串,接口输出参数见表10。

表10输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

3信息资源总数数字型查询到的信息资源总体数量

4信息资源UUID字符型信息资源的唯一标识,长度不超过64位

5信息资源标题字符型信息资源的标题

8.1.5接口返回示例

接口返回示例见B.1。

8.2信息资源获取

8.2.1接口描述

用于获取信息资源的详细内容。

8.2.2接口方式

接口方式为HTTP/HTTPS。

6

DB37/T4560.4—2022

8.2.3输入参数

接口输入参数见表11。

表11输入参数

序号参数名称数据类型说明

1集约化平台ID数字型信息资源所属集约化平台的数字编号

2政府网站ID数字型信息资源所属政府网站的数字编号

3栏目ID数字型信息资源所属栏目的数字编号

4信息资源UUID字符型信息资源的唯一标识,长度不超过64位

8.2.4输出参数

返回JSON字符串,接口输出参数见表12。

表12输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

3集约化平台ID数字型信息资源所属集约化平台的数字编号

信息

4政府网站ID数字型信息资源所属政府网站的数字编号

资源

5栏目ID数字型信息资源所属栏目的数字编号

内容

6信息内容字符型信息资源的具体内容

7集约化平台ID数字型引用信息资源所属集约化平台的数字编号

8引用政府网站ID数字型引用信息资源所属政府网站的数字编号

9信息栏目ID数字型引用信息资源所属栏目的数字编号

10信息资源UUID字符型引用信息资源的唯一标识,长度不超过64位

11信息资源URL字符型信息资源的访问URL

8.2.5接口返回示例

接口返回示例见B.2。

8.3信息资源新增

8.3.1接口描述

用于向政府网站信息资源共享库新增信息资源。

8.3.2接口方式

7

DB37/T4560.4—2022

接口方式为HTTP/HTTPS。

8.3.3输入参数

接口输入参数见表13。

表13输入参数

序号参数名称数据类型说明

1集约化平台ID数字型新增信息资源所属集约化平台的数字编号

2政府网站ID数字型新增信息资源所属政府网站的数字编号

3栏目ID数字型新增信息资源所属栏目的数字编号

4信息内容字符型新增信息资源的具体内容

5信息资源URL字符型新增信息资源的访问URL

8.3.4输出参数

返回JSON字符串,接口输出参数见表14。

表14输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

3信息资源UUID字符型新增信息资源的唯一标识,长度不超过64位

8.3.5接口返回示例

接口返回示例见B.3。

8.4信息资源修改

8.4.1接口描述

用于修改政府网站信息资源共享库的信息资源。

8.4.2接口方式

接口方式为HTTP/HTTPS。

8.4.3输入参数

接口输入参数见表15。

8

DB37/T4560.4—2022

表15输入参数

序号参数名称数据类型说明

1集约化平台ID数字型信息资源所属集约化平台的数字编号

2政府网站ID数字型信息资源所属政府网站的数字编号

3栏目ID数字型信息资源所属栏目的数字编号

4信息资源UUID字符型信息资源的唯一标识,长度不超过64位

5信息内容字符型信息资源修改后的具体内容

6信息资源URL字符型信息资源的访问URL

8.4.4输出参数

返回JSON字符串,接口输出参数见表16。

表16输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

8.4.5接口返回示例

接口返回示例见B.4。

8.5信息资源删除

8.5.1接口描述

用于删除政府网站信息资源共享库的信息资源。

8.5.2接口方式

接口方式为HTTP/HTTPS。

8.5.3输入参数

接口输入参数见表17。

表17输入参数

序号参数名称数据类型说明

1集约化平台ID数字型信息资源所属集约化平台的数字编号

2政府网站ID数字型信息资源所属政府网站的数字编号

9

DB37/T4560.4—2022

表17输入参数(续)

序号参数名称数据类型说明

3栏目ID数字型信息资源所属栏目的数字编号

4信息资源UUID字符型信息资源的唯一标识,长度不超过64位

8.5.4输出参数

返回JSON字符串,接口输出参数见表18的要求。

表18输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

8.5.5接口返回示例

接口返回示例见B.5。

8.6信息资源移动

8.6.1接口描述

用于修改政府网站信息资源共享库的信息资源存放路径。

8.6.2接口方式

接口方式为HTTP/HTTPS。

8.6.3输入参数

接口输入参数见表19。

表19输入参数

序号参数名称数据类型说明

1原集约化平台ID数字型信息资源所属集约化平台的数字编号,可为空值

2目标集约化平台ID数字型信息资源移动后所属集约化平台的数字编号

3原政府网站ID字符型信息资源所属政府网站的数字编号,可为空值

4目标政府网站ID字符型信息资源移动后所属政府网站的数字编号

5原栏目ID字符型信息资源所属栏目的数字编号,可为空值

6目标栏目ID字符型信息资源移动后所属栏目的数字编号

10

DB37/T4560.4—2022

表19输入参数(续)

序号参数名称数据类型说明

7信息资源UUID字符型信息资源的唯一标识,长度不超过64位

8信息资源URL字符型信息资源的访问URL

8.6.4输出参数

返回JSON字符串,接口输出参数见表20。

表20输出参数

序号参数名称数据类型说明

返回码:

1返回码数字型0-成功;

1-失败

2返回结果字符型返回结果描述信息

8.6.5接口返回示例

接口返回示例见B.6。

11

DB37/T4560.4—2022

附录A

(资料性)

各集约化平台间对接接口返回示例

A.1信息资源同步

下面给出来信息资源同步接口返回示例。

示例:

{"code":"0","message":"信息资源同步完成!"}

A.2附件上传

下面给出来附件上传接口返回示例。

示例:

{"code":"0","message":"附件上传成功!"}

A.3信息资源获取

下面给出来信息资源获取接口返回示例。

示例:

{

"code":"0",

"message":"信息资源获取成功!",

"resultData":[{

"i_id":"7",

"vc_author":"",

"vc_flash":"",

"vc_title":"测试标题",

"vc_userid":"00000",

"vc_keyword":"",

"vc_pic":"http://test/picture/0/s_4537adc21a1d4bd6b3dedcfb4074aeb9.jpg",

"vc_editor":"系统管理员",

"vc_thdtitle":"测试引题",

"vc_cataname":"多信息栏目",

"blink":"http://test/art/2021/12/14/art_10_7.html",

"vc_media":"",

"vc_sectitle":"测试副标题",

"vc_content":"测试正文社会主义核心价值观",

"vc_source":"",

"c_createdate":"2021-12-1411:46:48",

"i_cataid":"10",

"vc_webname":"这是测试政府网站",

"vc_attach":"http://test/attach/0/3b38ff7f76c94006a8b3f8e1c9e8a1ee.txt",

"vc_describe":"",

12

DB37/T4560.4—2022

"i_webid":"3",

"c_deploytime":"2021-12-1411:46:48",

"vc_auditprogram":"单位审核公开",

"vc_jd":"csjd1",

"b_xxgk":"1",

"vc_zpfl":"zp1",

"vc_filenumber":"",

"vc_ztfl":"zt1",

"c_complatedate":"2021-06-27",

"vc_fbjg":"asd",

"vc_tcfl":"tc1"

}]

}

13

DB37/T4560.4—2022

附录B

(资料性)

集约化平台与政府网站信息资源共享库对接接口返回示例

B.1信息资源列表查询

下面给出来信息资源列表查询接口返回示例。

示例:

{"code":"0","message":"信息资源列表查询成功!",

"infoList":{

"total":"288",

"records":[

{

"uuid":"mnrhkss3h32k59dl2wu6a33ee3nfn8vv",

"title":"XX部门发文推动平台经济规范健康持续发展"

},

{

"uuid":"auihvkss6jshuif5ikvodu98sehuva33",

"title":"无障碍环境建设条例"

}]

}

}

B.2信息资源获取

下面给出来信息资源获取接口返回示例。

示例:

{"code":"0","message":"信息资源获取成功!",

"infoContent":{

"appId":"3",

"groupId":"5",

"categoryId":"53",

"body":{

"title":"进城务工人员随迁子女教育",

"showtime":"2021-09-2815:24:33",

"phoneNumber":"133XXXX3937",

"address":"山东省济南市",

"logoUrl":"cloudfile:/2/2018/07/11/1803291049545202779.jpg"

}

},

"infoSource":{

"appId":"2",

"groupId":"3",

14

DB37/T4560.4—2022

"categoryId":"313",

"uuid":"mnacyagctuay78yf8gey33ee3nfn8vv"

},

"fileServerDomain":""

}

B.3信息资源新增

下面给出来信息资源新增接口返回示例。

示例:

{"code":"0","message":"信息资源新增成功!",

"infoList":{

"uuid":"a8jcusyf7wevodu89syfd67wgeyug"

}

}

}

B.4信息资源修改

下面给出来信息资源修改接口返回示例。

示例:

{"code":"0","message":"信息资源修改成功!"}

B.5信息资源删除

下面给出来信息资源删除接口返回示例。

示例:

{"code":"0","message":"信息资源删除成功!"}

B.6信息资源移动

下面给出来信息资源移动接口返回示例。

示例:

{"code":"0","message":"信息资源移动成功!"}

15

DB37/T4560.4—2022

参考文献

[1]GB/T7408数据元和交换格式信息交换日期和时间表示法

16

DB37/T4560.4—2022

目次

前言.................................................................................II

引言................................................................................III

1范围...............................................................................1

2规范性引用文件.....................................................................1

3术语和定义.........................................................................1

4缩略语.............................................................................1

5接口目录...........................................................................1

6接口表示要求.......................................................................2

7各集约化平台间对接接口.............................................................2

7.1信息资源同步...................................................................2

7.2附件上传..........................

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论