DB37∕T 4560.4-2022 政府网站集约化平台 第4部分：接口规范(山东省).pdf

ICS 35.240.99 CCS L 67 37 山东省地方标准 DB37/T 4560.42022 政府网站集约化平台 第 4 部分：接口规范 Intensive platform of government websitesPart 4:Interface specifications 2022-11-30 发布 2022-12-30 实施 山东省市场监督管理局 发 布 DB37/T 4560.42022 I 目次 前言.II 引言.III 1 范围.1 2 规范性引用文件.1 3 术语和定义.1 4 缩略语.1 5 接口目录.1 6 接口表示要求.2 7 各集约化平台间对接接口.2 信息资源同步.2 7.1 附件上传.3 7.2 信息资源获取.4 7.3 8 集约化平台与政府网站信息资源共享库对接接口.5 信息资源列表查询.5 8.1 信息资源获取.6 8.2 信息资源新增.7 8.3 信息资源修改.8 8.4 信息资源删除.9 8.5 信息资源移动.10 8.6 附录 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 DB37/T 4560.42022 II 前言 本文件按照GB/T 1.12020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。本文件是DB37/T 4560政府网站集约化平台的第4部分。DB37/T 4560已经发布了以下部分：第 1 部分：总体要求；第 2 部分：网站迁移规范；第 3 部分：数据规范；第 4 部分：接口规范。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由山东省大数据局提出、归口并组织实施。DB37/T 4560.42022 III 引言 推进政府网站集约化建设是山东省政府部署实施的一项重点工程，对于打破信息壁垒、推进集约共享，建设整体联动、高效便民的网上政府，具有重要意义。本文件旨在为政府网站集约化平台建设和管理提供指导，有效推进政府网站集约化建设和迁移实施。DB37/T 4560预计分为4个部分：第 1 部分：总体要求。本部分旨在规范政府网站集约化平台层级架构、总体架构、共享交换要求等内容。第 2 部分：网站迁移规范。本部分旨在规范政府网站迁移至政府网站集约化平台的迁移要求等内容。第 3 部分：数据规范。本部分旨在规范政府网站集约化平台数据分类、数据格式等内容。第 4 部分：接口规范。本部分旨在规范政府网站集约化平台数据共享交换接口等内容。DB37/T 4560.42022 1 政府网站集约化平台 第 4 部分：接口规范 1 范围 本文件规定了政府网站集约化平台（以下简称“集约化平台”）间、集约化平台与政府网站信息资源共享库间对接的接口要求。本文件适用于各级集约化平台通过接口进行的共享交换。2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。DB37/T 4560.1 政府网站集约化平台 第1部分：总体要求 3 术语和定义 DB37/T 4560.1界定的术语和定义适用于本文件。4 缩略语 下列缩略语适用于本文件。HTTP：超文本传输协议（Hyper Text Transfer Protocol）HTTPS：超文本安全传输协议（Hyper Text Transfer Protocol Secure）ID：身份标识码（Identity Document）JSON：JavaScript对象简谱（JavaScript Object Notation）URL：统一资源定位器（Uniform Resource Locator）UUID：唯一通用标识码（Universally Unique Identifier）5 接口目录 政府网站信息资源（以下简称“信息资源”）对接接口包括各集约化平台间的对接接口、集约化平台与政府网站信息资源共享库间的对接接口，接口目录见表1。DB37/T 4560.42022 2 表1 接口目录 序号 接口分类 接口名称 1 各集约化平台间对接接口 信息资源同步 2 附件上传 3 信息资源获取 4 集约化平台与政府网站信息资源共享库间对接接口 信息资源列表查询 5 信息资源获取 6 信息资源新增 7 信息资源修改 8 信息资源删除 9 信息资源移动 6 接口表示要求 接口表示要求包括但不限于：a)接口描述：应描述出接口的功能概要信息；b)接口方式：应给出接口采用的请求方式；c)输入参数：应给出参数名称、数据类型、说明等输入信息；d)输出参数：若有输出参数，应给出参数名称、数据类型、说明等输出信息；e)接口返回示例：应给出接口返回示例，接口返回示例见附录 A、附录 B。接口输入参数、输出参数中允许的数据类型见表2。表2 参数数据类型 数据类型 说明 字符型 通过字符形式表达的值的类型 数字型 通过从“0”到“9”数字形式表达的值的类型 日期型 通过 YYYYMMDD 的形式表达的值的类型，符合 GB/T 7408 日期时间型 通过 YYYYMMDD hhmmss 或 YYYYMMDD hh:mm:ss 的形式表达的值的类型，符合 GB/T 7408 7 各集约化平台间对接接口 信息资源同步 7.1 7.1.1 接口描述 用于向其他集约化平台推送信息资源。7.1.2 接口方式 接口方式为HTTP/HTTPS。DB37/T 4560.42022 3 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。DB37/T 4560.42022 4 表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 时间戳 数字型 记录获取信息资源的时间，单位精确至毫秒 DB37/T 4560.42022 5 表 7 输入参数（续）序号 参数名称 数据类型 说明 4 站点签名值 字符型 用来验证同步信息资源的来源站点 5 起始时间 日期时间型 信息资源发布区间的起始时间，YYYYMMDD hh:mm:ss 的形式，符合 GB/T 7408 6 结束时间 日期时间型 信息资源发布区间的结束时间，YYYYMMDD hh:mm:ss 的形式，符合 GB/T 7408 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。DB37/T 4560.42022 6 表9 输入参数 序号 参数名称 数据类型 说明 1 集约化平台 ID 数字型 指定栏目所属集约化平台的数字编号 2 政府网站 ID 数字型 指定栏目所属政府网站的数字编号 3 栏目 ID 数字型 指定栏目的数字编号 4 关键词 字符型 查询信息资源时输入的关键字 5 查询范围 数字型 信息资源检索范围代码；0-全字段；1-作者；2-标题 6 开始时间 日期时间型 查询信息资源的开始时间，YYYYMMDD hh:mm:ss 的形式，符合 GB/T 7408 7 结束时间 日期时间型 查询信息资源的结束时间，YYYYMMDD hh:mm:ss 的形式，符合 GB/T 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。DB37/T 4560.42022 7 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 接口方式 DB37/T 4560.42022 8 接口方式为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。DB37/T 4560.42022 9 表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 数字型 信息资源所属政府网站的数字编号 DB37/T 4560.42022 10 表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 字符型 信息资源移动后所属栏目的数字编号 DB37/T 4560.42022 11 表 19 输入参数（续）序号 参数名称 数据类型 说明 7 信息资源 UUID 字符型 信息资源的唯一标识，长度不超过 64 位 8 信息资源 URL 字符型 信息资源的访问 URL 8.6.4 输出参数 返回JSON字符串，接口输出参数见表20。表20 输出参数 序号 参数名称 数据类型 说明 1 返回码 数字型 返回码：0-成功；1-失败 2 返回结果 字符型 返回结果描述信息 8.6.5 接口返回示例 接口返回示例见B.6。DB37/T 4560.42022 12 附录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-14 11:46:48,i_cataid:10,vc_webname:这是测试政府网站,vc_attach:http:/test/attach/0/3b38ff7f76c94006a8b3f8e1c9e8a1ee.txt,vc_describe:,DB37/T 4560.42022 13 i_webid:3,c_deploytime:2021-12-14 11: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 DB37/T 4560.42022 14 附录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-28 15:24:33,phoneNumber:133XXXX3937,address:山东省济南市,logoUrl:cloudfile:/2/2018/07/11/1803291049545202779.jpg ,infoSource:appId:2,groupId:3,DB37/T 4560.42022 15 categoryId:313,uuid:mnacyagctuay78yf8gey33ee3nfn8vv ,fileServerDomain:http:/ B.3 信息资源新增 下面给出来信息资源新增接口返回示例。示例：code:0,message:信息资源新增成功！，infoList:uuid:a8jcusyf7wevodu89syfd67wgeyug B.4 信息资源修改 下面给出来信息资源修改接口返回示例。示例：code:0,message:信息资源修改成功！B.5 信息资源删除 下面给出来信息资源删除接口返回示例。示例：code:0,message:信息资源删除成功！B.6 信息资源移动 下面给出来信息资源移动接口返回示例。示例：code:0,message:信息资源移动成功！DB37/T 4560.42022 16 参考文献 1 GB/T 7408 数据元和交换格式 信息交换 日期和时间表示法