DB34 T 4083-2021 政府网站集约化平台应用接口规范.pdf
《DB34 T 4083-2021 政府网站集约化平台应用接口规范.pdf》由会员分享,可在线阅读,更多相关《DB34 T 4083-2021 政府网站集约化平台应用接口规范.pdf(46页珍藏版)》请在麦多课文档分享上搜索。
1、 ICS 35.240.99 CCS L 70 34 安徽省地方标准 DB34/T 40832021 政府网站集约化平台应用接口规范 Application interface specifications for the government website intensive platform 2021-12-28 发布 2022-01-28 实施 安徽省市场监督管理局 发布DB34/T 40832021 I 目次 前言 . II 1 范围 . 1 2 规范性引用文件 . 1 3 术语、定义和缩略语 . 1 3.1 术语和定义 . 1 3.2 缩略语 . 1 4 基本要求 . 1 4.1
2、应用接入方 . 2 4.2 接口提供方 . 2 4.3 平台运营方 . 2 5 接入流程 . 2 6 接口 . 2 6.1 应用场景 . 3 6.2 技术要求 . 3 6.3 API 接口说明 . 3 6.4 API 接口访问 . 3 6.5 清单 . 3 附录 A(资料性) 应用接入申请表 . 34 附录 B(资料性) 接入认证 . 35 B.1 认证说明 . 35 B.2 获取Token . 35 附录 C(资料性) 返回状态码定义 . 37 附录 D(资料性) 接口示例 . 38 D.1 信息新增接口 . 38 D.2 信息报送采用情况分页查询接口 . 38 D.3 信息详情查询接口 .
3、 39 D.4 信息删除接口 . 39 附录 E(规范性) 数据格式的字符定义 . 41 参考文献 . 42 DB34/T 40832021 II 前言 本文件按照 GB/T 1.12020标准化工作导则 第1部分:标准化文件的结构和起草规则的规定 起草。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。 本文件由安徽省人民政府网管理中心提出。 本文件由安徽省信息技术标准化技术委员会(AH/TC 25)归口。 本文件起草单位:安徽省人民政府网管理中心、合肥工业大学、六安市政府网站和新媒体中心、安 徽省质量和标准化研究院、安徽龙讯信息科技有限公司。 本文件主要起草人:陶
4、松、郭亚光、寿志勤、贺良震、宋小娟、王玮、季静、姜东林、许君、朱守 勇。 DB34/T 40832021 1 政府网站集约化平台应用接口规范 1 范围 本文件规定了政府网站集约化平台应用接口的基本要求、接入流程、接口要求。 本文件适用于政府网站集约化平台之间、 政府网站集约平台与政府网站信息资源库及其他业务应用 系统之间的数据共享交换。 2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。 其中, 注日期的引用文件, 仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本 文件。 GB/T 21062.3 政务信息资源交换体系
5、 第3部分:数据接口规范 GB/T 40094.3 电子商务数据交易 第3部分:数据接口规范 DB34/T 3686 电子政务外网数据交换级联接口规范 3 术语、定义和缩略语 3.1 术语和定义 下列术语和定义适用于本文件。 3.1.1 应用接入方 application access unit 需要调用政府网站集约化平台应用接口的组织。 3.1.2 接口提供方 supplier of interfaces 提供政府网站集约化平台应用接口的组织。 3.1.3 平台运营方 operator of integrated platform forgovernment websites 为政府网站集约
6、化平台应用接入提供技术服务支撑的组织。 3.2 缩略语 下列缩略语适用于本文件。 API:应用程序接口(Application Programming Interface) URL:统一资源定位符(Uniform Resource Locator) JSON:JS 对象简谱/对象标记(JavaScriptObject Notation) 4 基本要求 DB34/T 40832021 2 4.1 应用接入方 应满足以下要求: 按需申请接入; 按照本文件要求使用接口服务; 协调所选取的业务应用系统及服务提供方与政府网站集约化平台运营方的对接工作。 4.2 接口提供方 应满足以下要求: 确保开放的接
7、口不影响平台的正常运转; 对业务应用系统及服务的接入制定相应的安全策略,并确保正常执行; 对业务应用系统及服务的接入进行审批和管理; 协调政府网站集约化平台运营方安排专人负责接入应用的日常管理。 4.3 平台运营方 应满足以下要求: 按照 GB/T 21062.3、GB/T 40094.3、DB34/T 3686等的要求定义及开发接口; 负责应用接口的维护更新与缺陷修正,并为应用接入方提供技术支持。 5 接入流程 应用接入流程见图1。 应用接入方 接口提供方 平台运营方 对接需求及安全 评估 接入申请 接入审核 接入认证 开始 结束 授权凭证反馈 接口开通授权 图1 接入流程 注1:应用接入方
8、在提交申请表前应开展对接需求及安全评估,并按照附录A 中的表A.1 要求提交接入申请。 注2:接口提供方对应用接入方提交的申请进行审核。审核通过后,通知平台运营方开通授权。 注3:平台运营方负责开通授权,将授权凭证(用户名、密码)返回至接入方并配合完成认证工作。 注4:应用接入方根据授权凭证,完成接入认证,接入认证的详细说明见附录B。 6 接口 DB34/T 40832021 3 6.1 应用场景 集约化平台应用接口应包括但不限于以下应用场景: 省级、市级政府网站集约化平台之间的数据共享交换业务,包括重要转载、信息报送、网站 工作年报、网站监管年报、绩效考核等。 集约化平台与政府网站信息资源库
9、及其他业务应用系统之间的数据共享交换业务,包括政府 网站信息发布、留言办理回复、栏目及目录查询、单点登录等。 6.2 技术要求 应采用基于 HTTP(超文本传输协议)/HTTPS(超文本传输安全协议)的 API 接口方式进行数据共 享交换。 6.3 API接口说明 API接口说明应包含但不限于: a) 接口名称:接口功能的简要和概况性描述。 示例1:获取Token。 b) 功能描述:接口的功能性描述。 示例2:用于获取Token,每次调用集约化平台应用接口时都要先获取Token。 c) 接口地址:接口的调用地址。 示例3:http:/ip:port/oauth/token。 d) 请求方式:对
10、数据进行操作采用的类型,可采用GET 或POST等方式。 示例4:http GET。 e) 请求参数(请求消息字段说明):访问接口时必要的或可选的参数,说明字段名称、类型、约 束、描述说明;其中,必要参数应给出调用 API 所需的唯一身份令牌(Token)。 示例5:见附录B 表B.2的“请求参数”。 f) 请求示例:请求数据的接口地址示例说明。 示例6:http:/ip:port/oauth/token?client_id=分配给您的用户名&client_secret=分配给您的密码。 g) 返回结果:请求数据后,系统返回的请求结果。返回结果采用 JSON 格式。 示例7:见附录B 表B.2
11、的“返回结果示例”。 h) 返回结果字段说明(返回消息字段说明):返回结果中数据信息的字段说明,包括但不限于 字段名称、类型、描述说明等。 示例8:见附录B 表B.2的“返回结果字段”。 i) 返回状态码:请求数据后,返回的状态代码。 示例9:见附录C 表C.1。 6.4 API接口访问 应用接入方应通过政府网站集约化平台运营方分配的用户名和密码获取身份令牌(Token)后,利 用身份令牌(Token)和应用接口请求参数进行业务接口访问。Token 获取方式见附录B 中的表B.2。 6.5 清单 6.5.1 重要转载 DB34/T 40832021 4 6.5.1.1 重要转载信息 功能描述:
12、用于转载上级政府网站的重要信息。 请求消息字段见表1。 返回消息字段见表2。 表1 重要转载信息请求消息字段 字段名 类型 约束 说明 type String 选填 转载类型 表2 重要转载信息返回消息字段 字段名 类型 说明 status Integer 返回状态码,见附录C中表C.1的定义 id Long 文章id title String 标题 imageLink String 缩略图地址 resources String 来源 url String 访问地址 publishDate String 发布时间 content String 文章内容 remark String 简介 des
13、c String 描述信息 6.5.1.2 重要转载信息点击量上报 功能描述:用于下级政府网站上报转载信息的点击量。 请求消息字段见表3。 返回消息字段见表4。 表3 重要转载信息点击量上报请求消息字段 字段名 类型 约束 说明 id Long 必填 信息ID hit Long 必填 点击量 表4 重要转载信息点击量上报返回消息字段 字段名 类型 说明 status Integer 返回状态码,见附录C中表C.1的定义 desc String 描述信息 6.5.2 信息报送 6.5.2.1 信息报送 功能描述:用于市级平台向省级平台报送信息。 DB34/T 40832021 5 请求消息字段见
14、表5。 返回消息字段见表6。 表5 信息报送接口请求消息字段 字段名 类型 约束 说明 uid String 必填 信息报送系统用户名,数据格式要求:A1.20(字符含义见附录E 中表E.1的定义) title String 必填 标题,数据格式要求:A1.100(字符含义见附录E中表E.1 的定义) author String 必填 作者,数据格式要求:A1.30(字符含义见附录E中表E.1的定义) addDate Date 可选 添加日期,默认当前日期,数据格式要求:D8+T6(字符含义见附录 E中表E.1的定义) classify Integer 可选 报送分类(0:网站信息,1:解读材
15、料,默认网站信息) infoModel Integer 可选 信息分类(0:中文信息,1:英文信息,默认中文信息) reporterName String 必填 报送人姓名,数据格式要求:A1.30(字符含义见附录E中表E.1 的定义) reporterPhone String 必填 报送人手机号,N11(字符含义见附录E中表E.1的定义) content String 必填 信息内容 表6 信息报送接口返回消息字段 字段名 类型 说明 status Integer 返回状态码,见附录C中表C.1的定义 id Integer 信息主键id desc String 描述信息 注: 信息新增的接口
16、示例参见附录D 中 D.1。 6.5.2.2 信息报送采用情况分页查询 功能描述:用于市级平台查询报送信息的采用情况。 请求消息字段见表7。 返回消息字段见表8。 表7 信息报送采用情况分页查询接口请求消息字段 字段名 类型 约束 说明 uid String 必填 信息报送系统用户名,数据格式要求:A1.20(字符含义见附录E 中表E.1的定义) id Integer 可选 信息报送返回的主键id,数据格式要求:A.20(字符含义见附录E 中表E.1的定义) name String 可选 标题,数据格式要求:A.100(字符含义见附录E中表E.1的定义) submitUserName Stri
17、ng 必填 报送人姓名,数据格式要求:A1.30(字符含义见附录E中表E.1 的定义) startDate Date 可选 报送日期的开始时间,数据格式要求:D8+T6(字符含义见附录E中 表E.1的定义) DB34/T 40832021 6 endDate Date 可选 报送日期的结束时间,数据格式要求:D8+T6(字符含义见附录E中 表E.1的定义) useStatus Integer 可选 采用状态(0:未采用,1:已采用,3:已退回) pageIndex Integer 可选 页码开始,默认从0开始 pageSize Integer 可选 一页数据条数 表8 信息报送采用情况分页查询
18、接口返回消息字段 字段名 类型 说明 status Integer 返回状态码,见附录C中表C.1的定义 id Integer 信息ID name String 信息标题 useStatus Integer 采用状态(0:未采用,1:已采用,3:已退回) useDate Date 采用时间 desc String 描述信息 注: 采用情况查询接口示例参见附录D 中 D.2 6.5.3 网站工作年报 6.5.3.1 应报数量查询 功能描述:用于市级平台获取政府网站工作年报应报数量。 请求消息字段见表9。 返回消息字段见表10。 表9 应报数量查询接口请求消息字段 字段名 类型 约束 说明 yea
19、r String 必填 年份,数据格式要求:D4(字符含义见附录E中表E.1 的定义) creditCode String 必填 省市平台对接组织编码 表10 应报数量查询接口返回消息字段 字段名 类型 说明 status Integer 返回状态码,见附录C中表C.1的定义 data Integer 返回数据,应报数量 desc String 描述信息 6.5.3.2 填报数量推送 功能描述:用于市级平台向省级平台推送本年度已填报且审核通过的网站工作年报数量。 请求消息字段见表11。 返回消息字段见表12。 DB34/T 40832021 7 表11 填报数量推送接口请求消息字段 字段名 类
20、型 约束 说明 jsonArray year String 必填 年份,数据格式要求:D4(字符含义见附录E中表E.1 的定义) creditCode String 必填 省市平台对接组织编码 count Integer 必填 网站工作年报数量 表12 填报数量推送接口返回消息字段 字段名 类型 说明 status Integer 返回状态码,见附录C中表C.1的定义 desc String 描述信息 6.5.3.3 上报 功能描述:用于市级平台向省级平台上报网站工作年报数据。 请求消息字段见表13。 返回消息字段见表14。 表13 网站工作年报上报接口请求消息字段 字段名 类型 约束 说明
21、year String 必填 年份, 数据格式要求: D4 (字符含义见附录E 中表E.1的定义) creditCode String 必填 省市平台对接组织编码 reportGovYearDataArray reportUnitCreditCode String 必填 填报单位的省市平台对接组织编码 siteName String 必填 网站名称,数据格式要求:A1.50(字符含义见附录E中表 E.1的定义) indexWebsite String 必填 首页网址,数据格式要求:A1.100(字符含义见附录E 中表 E.1的定义) hostUnit String 必填 主办单位,数据格式要求
- 1.请仔细阅读文档,确保文档完整性,对于不预览、不比对内容而直接下载带来的问题本站不予受理。
- 2.下载的文档,不会出现我们的网址水印。
- 3、该文档所得收入(下载+内容+预览)归上传者、原创作者;如果您是本文档原作者,请点此认领!既往收益都归您。
下载文档到电脑,查找使用更方便
5000 积分 0人已下载
下载 | 加入VIP,交流精品资源 |
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- DB34 4083-2021 政府网站集约化平台应用接口规范 4083 2021 政府 网站 集约化 平台 应用 接口 规范
