DB34/T 4083-2021 政府网站集约化平台应用接口规范
DB34/T 4083-2021 Government website centralization platform application interface specification
基本信息
发布历史
-
2021年12月
研制信息
- 起草单位:
- 安徽省人民政府网管理中心、合肥工业大学、六安市政府网站和新媒体中心、安徽省质量和标准化研究院、安徽龙讯信息科技有限公司
- 起草人:
- 出版信息:
- 页数:46页 | 字数:- | 开本: -
内容描述
ICS35.240.99
CCSL70
34
安徽省地方标准
DB34/T4083—2021
政府网站集约化平台应用接口规范
Applicationinterfacespecificationsforthegovernmentwebsiteintensiveplatform
2021-12-28发布2022-01-28实施
安徽省市场监督管理局发布
DB34/T4083—2021
目次
前言II
1范围1
2规范性引用文件1
3术语、定义和缩略语1
3.1术语和定义1
3.2缩略语1
4基本要求1
4.1应用接入方2
4.2接口提供方2
4.3平台运营方2
5接入流程2
6接口2
6.1应用场景3
6.2技术要求3
6.3API接口说明3
6.4API接口访问3
6.5清单3
附录A(资料性)应用接入申请表34
附录B(资料性)接入认证35
B.1认证说明35
B.2获取Token35
附录C(资料性)返回状态码定义37
附录D(资料性)接口示例38
D.1信息新增接口38
D.2信息报送采用情况分页查询接口38
D.3信息详情查询接口39
D.4信息删除接口39
附录E(规范性)数据格式的字符定义41
参考文献42
I
DB34/T4083—2021
前言
本文件按照GB/T1.1—2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定
起草。
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。
本文件由安徽省人民政府网管理中心提出。
本文件由安徽省信息技术标准化技术委员会(AH/TC25)归口。
本文件起草单位:安徽省人民政府网管理中心、合肥工业大学、六安市政府网站和新媒体中心、安
徽省质量和标准化研究院、安徽龙讯信息科技有限公司。
本文件主要起草人:陶松、郭亚光、寿志勤、贺良震、宋小娟、王玮、季静、姜东林、许君、朱守
勇。
II
DB34/T4083—2021
政府网站集约化平台应用接口规范
1范围
本文件规定了政府网站集约化平台应用接口的基本要求、接入流程、接口要求。
本文件适用于政府网站集约化平台之间、政府网站集约平台与政府网站信息资源库及其他业务应用
系统之间的数据共享交换。
2规范性引用文件
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,
仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本
文件。
GB/T21062.3政务信息资源交换体系第3部分:数据接口规范
GB/T40094.3电子商务数据交易第3部分:数据接口规范
DB34/T3686电子政务外网数据交换级联接口规范
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适用于本文件。
3.1.1
应用接入方applicationaccessunit
需要调用政府网站集约化平台应用接口的组织。
3.1.2
接口提供方supplierofinterfaces
提供政府网站集约化平台应用接口的组织。
3.1.3
平台运营方operatorofintegratedplatformforgovernmentwebsites
为政府网站集约化平台应用接入提供技术服务支撑的组织。
3.2缩略语
下列缩略语适用于本文件。
API:应用程序接口(ApplicationProgrammingInterface)
URL:统一资源定位符(UniformResourceLocator)
JSON:JS对象简谱/对象标记(JavaScriptObjectNotation)
4基本要求
1
DB34/T4083—2021
4.1应用接入方
应满足以下要求:
——按需申请接入;
——按照本文件要求使用接口服务;
——协调所选取的业务应用系统及服务提供方与政府网站集约化平台运营方的对接工作。
4.2接口提供方
应满足以下要求:
——确保开放的接口不影响平台的正常运转;
——对业务应用系统及服务的接入制定相应的安全策略,并确保正常执行;
——对业务应用系统及服务的接入进行审批和管理;
——协调政府网站集约化平台运营方安排专人负责接入应用的日常管理。
4.3平台运营方
应满足以下要求:
——按照GB/T21062.3、GB/T40094.3、DB34/T3686等的要求定义及开发接口;
——负责应用接口的维护更新与缺陷修正,并为应用接入方提供技术支持。
5接入流程
应用接入流程见图1。
应用接入方接口提供方平台运营方
开始
对接需求及安全
评估
接入申请接入审核接口开通授权
接入认证授权凭证反馈
结束
图1接入流程
注1:应用接入方在提交申请表前应开展对接需求及安全评估,并按照附录A中的表A.1要求提交接入申请。
注2:接口提供方对应用接入方提交的申请进行审核。审核通过后,通知平台运营方开通授权。
注3:平台运营方负责开通授权,将授权凭证(用户名、密码)返回至接入方并配合完成认证工作。
注4:应用接入方根据授权凭证,完成接入认证,接入认证的详细说明见附录B。
6接口
2
DB34/T4083—2021
6.1应用场景
集约化平台应用接口应包括但不限于以下应用场景:
——省级、市级政府网站集约化平台之间的数据共享交换业务,包括重要转载、信息报送、网站
工作年报、网站监管年报、绩效考核等。
——集约化平台与政府网站信息资源库及其他业务应用系统之间的数据共享交换业务,包括政府
网站信息发布、留言办理回复、栏目及目录查询、单点登录等。
6.2技术要求
应采用基于HTTP(超文本传输协议)/HTTPS(超文本传输安全协议)的API接口方式进行数据共
享交换。
6.3API接口说明
API接口说明应包含但不限于:
a)接口名称:接口功能的简要和概况性描述。
示例1:获取Token。
b)功能描述:接口的功能性描述。
示例2:用于获取Token,每次调用集约化平台应用接口时都要先获取Token。
c)接口地址:接口的调用地址。
示例3:http://[ip]:[port]/oauth/token。
d)请求方式:对数据进行操作采用的类型,可采用GET或POST等方式。
示例4:httpGET。
e)请求参数(请求消息字段说明):访问接口时必要的或可选的参数,说明字段名称、类型、约
束、描述说明;其中,必要参数应给出调用API所需的唯一身份令牌(Token)。
示例5:见附录B表B.2的“请求参数”。
f)请求示例:请求数据的接口地址示例说明。
示例6:http://[ip]:[port]/oauth/token?client_id=分配给您的用户名&client_secret=分配给您的密码。
g)返回结果:请求数据后,系统返回的请求结果。返回结果采用JSON格式。
示例7:见附录B表B.2的“返回结果示例”。
h)返回结果字段说明(返回消息字段说明):返回结果中数据信息的字段说明,包括但不限于
字段名称、类型、描述说明等。
示例8:见附录B表B.2的“返回结果字段”。
i)返回状态码:请求数据后,返回的状态代码。
示例9:见附录C表C.1。
6.4API接口访问
应用接入方应通过政府网站集约化平台运营方分配的用户名和密码获取身份令牌(Token)后,利
用身份令牌(Token)和应用接口请求参数进行业务接口访问。Token获取方式见附录B中的表B.2。
6.5清单
6.5.1重要转载
3
DB34/T4083—2021
重要转载信息
功能描述:用于转载上级政府网站的重要信息。
请求消息字段见表1。
返回消息字段见表2。
表1重要转载信息请求消息字段
字段名类型约束说明
typeString选填转载类型
表2重要转载信息返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
idLong文章id
titleString标题
imageLinkString缩略图地址
resourcesString来源
urlString访问地址
publishDateString发布时间
contentString文章内容
remarkString简介
descString描述信息
重要转载信息点击量上报
功能描述:用于下级政府网站上报转载信息的点击量。
请求消息字段见表3。
返回消息字段见表4。
表3重要转载信息点击量上报请求消息字段
字段名类型约束说明
idLong必填信息ID
hitLong必填点击量
表4重要转载信息点击量上报返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
descString描述信息
6.5.2信息报送
信息报送
功能描述:用于市级平台向省级平台报送信息。
4
DB34/T4083—2021
请求消息字段见表5。
返回消息字段见表6。
表5信息报送接口请求消息字段
字段名类型约束说明
信息报送系统用户名,数据格式要求:A1..20(字符含义见附录E
uidString必填
中表E.1的定义)
titleString必填标题,数据格式要求:A1..100(字符含义见附录E中表E.1的定义)
authorString必填作者,数据格式要求:A1..30(字符含义见附录E中表E.1的定义)
添加日期,默认当前日期,数据格式要求:D8+T6(字符含义见附录
addDateDate可选
E中表E.1的定义)
classifyInteger可选报送分类(0:网站信息,1:解读材料,默认网站信息)
infoModelInteger可选信息分类(0:中文信息,1:英文信息,默认中文信息)
报送人姓名,数据格式要求:A1..30(字符含义见附录E中表E.1
reporterNameString必填
的定义)
reporterPhoneString必填报送人手机号,N11(字符含义见附录E中表E.1的定义)
contentString必填信息内容
表6信息报送接口返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
idInteger信息主键id
descString描述信息
注:信息新增的接口示例参见附录D中D.1。
信息报送采用情况分页查询
功能描述:用于市级平台查询报送信息的采用情况。
请求消息字段见表7。
返回消息字段见表8。
表7信息报送采用情况分页查询接口请求消息字段
字段名类型约束说明
信息报送系统用户名,数据格式要求:A1..20(字符含义见附录E
uidString必填
中表E.1的定义)
信息报送返回的主键id,数据格式要求:A..20(字符含义见附录E
idInteger可选
中表E.1的定义)
nameString可选标题,数据格式要求:A..100(字符含义见附录E中表E.1的定义)
报送人姓名,数据格式要求:A1..30(字符含义见附录E中表E.1
submitUserNameString必填
的定义)
报送日期的开始时间,数据格式要求:D8+T6(字符含义见附录E中
startDateDate可选
表E.1的定义)
5
DB34/T4083—2021
报送日期的结束时间,数据格式要求:D8+T6(字符含义见附录E中
endDateDate可选
表E.1的定义)
useStatusInteger可选采用状态(0:未采用,1:已采用,3:已退回)
pageIndexInteger可选页码开始,默认从0开始
pageSizeInteger可选一页数据条数
表8信息报送采用情况分页查询接口返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
idInteger信息ID
nameString信息标题
useStatusInteger采用状态(0:未采用,1:已采用,3:已退回)
useDateDate采用时间
descString描述信息
注:采用情况查询接口示例参见附录D中D.2
6.5.3网站工作年报
应报数量查询
功能描述:用于市级平台获取政府网站工作年报应报数量。
请求消息字段见表9。
返回消息字段见表10。
表9应报数量查询接口请求消息字段
字段名
类型
约束
说明
yearString必填年份,数据格式要求:D4(字符含义见附录E中表E.1的定义)
creditCodeString必填省市平台对接组织编码
表10应报数量查询接口返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
dataInteger返回数据,应报数量
descString描述信息
填报数量推送
功能描述:用于市级平台向省级平台推送本年度已填报且审核通过的网站工作年报数量。
请求消息字段见表11。
返回消息字段见表12。
6
DB34/T4083—2021
表11填报数量推送接口请求消息字段
字段名类型约束说明
jsonArray
yearString必填年份,数据格式要求:D4(字符含义见附录E中表E.1的定义)
creditCodeString必填省市平台对接组织编码
countInteger必填网站工作年报数量
表12填报数量推送接口返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
descString描述信息
上报
功能描述:用于市级平台向省级平台上报网站工作年报数据。
请求消息字段见表13。
返回消息字段见表14。
表13网站工作年报上报接口请求消息字段
字段名类型约束说明
yearString必填年份,数据格式要求:D4(字符含义见附录E中表E.1的定义)
creditCodeString必填省市平台对接组织编码
reportGovYearDataArray
reportUnitCreditCodeString必填填报单位的省市平台对接组织编码
网站名称,数据格式要求:A1..50(字符含义见附录E中表
siteNameString必填
E.1的定义)
首页网址,数据格式要求:A1..100(字符含义见附录E中表
indexWebsiteString必填
E.1的定义)
主办单位,数据格式要求:A1..50(字符含义见附录E中表
hostUnitString必填
E.1的定义)
websiteTypeInteger必填网站类型,1:政府门户网站2:部门网站3:专项网站
政府网站标识码,数据格式要求:A1..30(字符含义见附录E
siteCodeString必填
中表E.1的定义)
ICP备案号,数据格式要求:A1..30(字符含义见附录E中表
siteICPString必填
E.1的定义)
公安机关备案号,数据格式要求:A1..30(字符含义见附录E
siteGajgbahString必填
中表E.1的定义)
填报日期,数据格式要求:A1..30(字符含义见附录E中表
reportDateDate必填
E.1的定义)
uvLong必填独立用户访问总量(单位:个)
pvLong必填网站总访问量(单位:次)
7
DB34/T4083—2021
totalPublishCountInteger必填总的信息发布数
glPublishCountInteger必填概况类信息更新量
zwdtPublishCountInteger必填政务动态信息更新量
xxgkPublishCountInteger必填信息公开目录信息更新量
ztzlCountInteger选填专题专栏维护数
newZtzlCountInteger选填新开设专题专栏数
jdhyCountInteger选填解读回应总数
jdclCountInteger选填解读材料数量
jdcpCountInteger选填解读产品数量
mtplCountInteger选填媒体评论文章数量
rdgzOrZdyqCountInteger选填回应公众关注热点或重大舆情数量
isPublishServiceCatalogBoolean必填是否发布服务事项目录(false:否,true:是)
regUserCountInteger选填注册用户数
serviceCountInteger选填政务服务事项数量
qcblServiceCountInteger选填可全程在线办理政务服务事项数量
handleCountInteger选填办件总量
personHandleCountInteger选填自然人办件量
juridicalPersonHandleCountInteger选填法人办件量
isUseUnitePlatformBoolean必填是否使用统一平台(false:否,true:是)
messageRecieveCountInteger必填留言受理数
messageDoneCountInteger必填留言办结数
aveProTimeFloat必填平均办结时间(单位:天)
publicReplyCountInteger必填公开答复数量
surveyCountInteger必填征集调查期数
suggestionCountInteger必填收到意见数量
findingsCountInteger必填公布调查结果期数
interviewCountInteger必填访谈期数
interviewMessageCountInteger必填网民留言数量
interviewMessageReplyCountInteger必填答复网民提问数量
isProvideIntelligenceQABoolean必填是否提供智能问答(false:否,true:是)
safaCountInteger选填安全检测评估次数
safeProblemCountInteger选填发现问题数量
problemRepairCountInteger选填问题整改数量
isBuildSafeWarningBoolean必填是否建立安全监测预警机制(false:否,true:是)
isSafeDrillBoolean必填是否开展应急演练(false:否,true:是)
hasSafeChargePersonBoolean必填是否明确网站安全责任人(false:否,true:是)
hasNewMediaBoolean必填是否有移动新媒体(false:否,true:是)
weiboNameString选填微博名称
weiboInfoCountInteger选填微博信息发布量
weiboFollowCountInteger选填微博关注量
8
DB34/T4083—2021
weChatNameString选填微信名称
weChatInfoCountInteger选填微信信息发布量
weChatFollowCountInteger选填微信订阅数
其他新媒体描述,数据格式要求:A..500(字符含义见附录E
otherNewMediaDescString选填
中表E.1的定义)
创新发展,多选以逗号分割
innovateDevString选填1.搜索即服务2.多语言版本3.无障碍浏览4.千人千网5.
其他
innovateDevDescString选填创新发展描述
unitChargePersonString选填单位负责人
auditPersonString选填审核人
addPersonString选填填报人
contactPhoneString选填联系电话
reportRemarkString选填备注
表14网站工作年报上报接口返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
descString描述信息
退回状态查询
功能描述:用于市级平台获取政府网站工作年报退回状态信息。
请求消息字段见表15。
返回消息字段见表16。
表15年报退回状态查询接口请求消息字段
字段名类型约束说明
yearString必填年份,数据格式要求:D4(字符含义见附录E中表E.1的定义)
creditCodeString必填省市平台对接组织编码
表16年报退回状态查询接口返回消息字段
字段名类型说明
statusInteger返回状态码,见附录C中表C.1的定义
idInteger信息id
backDateDate退回时间
reasonString退回原因说明
descString描述信息
退回状态批量查询
功能描述:批量查询政府网站工作年报退回状态信息(只返回被退回的数据)。
请求消息字段见表17。
9
DB34/T4083—2021
返回消息字段见表18。
表17年报退回状态批量查询接口请求消息字段
字段名类型约束说明
yearString必填年份,数据格式要求:D4(字符含义见附录E中表
定制服务
推荐标准
- DB3301/T 0276-2018 政务数据共享安全管理规范 2018-12-30
- DB3301/T 0274-2018 电梯维保单位星级评定规范 2018-12-30
- DB3301/T 0275-2018 园林绿化植物废弃物资源利用管理规范 2018-12-30
- DB3301/T 74-2019 公共厕所保洁与服务规范 2019-07-30
- DB3301/T 71-2019 数字城管系统运维服务规范 2019-07-30
- DB3301/T 0271-2018 公益性生态公墓建设管理规范 2018-12-30
- DB3301/T 0270-2018 养老机构保护性用具使用规范 2018-12-30
- DB3301/T 0269-2018 文化志愿服务管理规范 2018-12-30
- DB3301/T 0268-2018 社会力量参与公共文化服务评估规范 2018-12-30
- DB3301/T 0272-2018 城市河道养护管理规范 2018-12-30