DB34_T 4083-2021 政府网站集约化平台应用接口规范.docx

 ICS 35.240.99CCS L 7034安徽省地方标准DB34/T 40832021政府网站集约化平台应用接口规范Application interface specifications for the government website intensive platform2021-12-28 发布2022-01-28 实施安徽省市场监督管理局发 布DB34/T 40832021目次前言 . II1  范围 . 12  规范性引用文件 . 13  术语、定义和缩略语 . 13.1  术语和定义 . 13.2  缩略语 . 14  基本要求 . 14.1  应用接入方 . 24.2  接口提供方 . 24.3  平台运营方 . 25  接入流程 . 26  接口 . 26.1  应用场景 . 36.2  技术要求 . 36.3  API 接口说明. 36.4  API 接口访问. 36.5  清单 . 3附录 A（资料性）  应用接入申请表 . 34附录 B（资料性）  接入认证 . 35B.1  认证说明 . 35B.2  获取 Token. 35附录 C（资料性）  返回状态码定义 . 37附录 D（资料性）  接口示例 . 38D.1  信息新增接口 . 38D.2  信息报送采用情况分页查询接口 . 38D.3  信息详情查询接口 . 39D.4  信息删除接口 . 39附录 E（规范性）  数据格式的字符定义 . 41参考文献 . 42IDB34/T 40832021前言本文件按照 GB/T 1.12020标准化工作导则第1部分：标准化文件的结构和起草规则的规定起草。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由安徽省人民政府网管理中心提出。本文件由安徽省信息技术标准化技术委员会（AH/TC 25）归口。本文件起草单位：安徽省人民政府网管理中心、合肥工业大学、六安市政府网站和新媒体中心、安徽省质量和标准化研究院、安徽龙讯信息科技有限公司。本文件主要起草人：陶松、郭亚光、寿志勤、贺良震、宋小娟、王玮、季静、姜东林、许君、朱守勇。IIDB34/T 40832021政府网站集约化平台应用接口规范1  范围本文件规定了政府网站集约化平台应用接口的基本要求、接入流程、接口要求。本文件适用于政府网站集约化平台之间、政府网站集约平台与政府网站信息资源库及其他业务应用系统之间的数据共享交换。2  规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 21062.3政务信息资源交换体系 第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为政府网站集约化平台应用接入提供技术服务支撑的组织。3.2  缩略语下列缩略语适用于本文件。API：应用程序接口（Application Programming Interface）URL：统一资源定位符（Uniform Resource Locator）JSON：JS 对象简谱/对象标记（JavaScriptObject Notation）4  基本要求1应用接入方接口提供方平台运营方开始对接需求及安全评估接入申请接入认证结束接入审核接口开通授权授权凭证反馈DB34/T 408320214.1  应用接入方应满足以下要求：按需申请接入；按照本文件要求使用接口服务；协调所选取的业务应用系统及服务提供方与政府网站集约化平台运营方的对接工作。4.2  接口提供方应满足以下要求：确保开放的接口不影响平台的正常运转；对业务应用系统及服务的接入制定相应的安全策略，并确保正常执行；对业务应用系统及服务的接入进行审批和管理；协调政府网站集约化平台运营方安排专人负责接入应用的日常管理。4.3  平台运营方应满足以下要求：按照 GB/T 21062.3、GB/T 40094.3、DB34/T 3686 等的要求定义及开发接口；负责应用接口的维护更新与缺陷修正，并为应用接入方提供技术支持。5  接入流程应用接入流程见图1。图1  接入流程注1：应用接入方在提交申请表前应开展对接需求及安全评估，并按照附录A 中的表A.1 要求提交接入申请。注2：接口提供方对应用接入方提交的申请进行审核。审核通过后，通知平台运营方开通授权。注3：平台运营方负责开通授权，将授权凭证（用户名、密码）返回至接入方并配合完成认证工作。注4：应用接入方根据授权凭证，完成接入认证，接入认证的详细说明见附录B。6  接口2DB34/T 408320216.1  应用场景集约化平台应用接口应包括但不限于以下应用场景：省级、市级政府网站集约化平台之间的数据共享交换业务，包括重要转载、信息报送、网站工作年报、网站监管年报、绩效考核等。集约化平台与政府网站信息资源库及其他业务应用系统之间的数据共享交换业务，包括政府网站信息发布、留言办理回复、栏目及目录查询、单点登录等。6.2  技术要求应采用基于 HTTP（超文本传输协议）/HTTPS（超文本传输安全协议）的 API 接口方式进行数据共享交换。6.3  API 接口说明API接口说明应包含但不限于：a)  接口名称：接口功能的简要和概况性描述。示例1：获取 Token。b)  功能描述：接口的功能性描述。示例2：用于获取 Token，每次调用集约化平台应用接口时都要先获取 Token。c)  接口地址：接口的调用地址。示例3：http:/ip:port/oauth/token。d)  请求方式：对数据进行操作采用的类型,可采用 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 的“返回结果示例”。h)  返回结果字段说明（返回消息字段说明）：返回结果中数据信息的字段说明，包括但不限于字段名称、类型、描述说明等。示例8：见附录 B 表 B.2 的“返回结果字段”。i)  返回状态码：请求数据后，返回的状态代码。示例9：见附录 C 表 C.1。6.4  API 接口访问应用接入方应通过政府网站集约化平台运营方分配的用户名和密码获取身份令牌（Token）后，利用身份令牌（Token）和应用接口请求参数进行业务接口访问。Token 获取方式见附录B 中的表B.2。6.5  清单6.5.1  重要转载3字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义idLong文章 idtitleString标题imageLinkString缩略图地址resourcesString来源urlString访问地址publishDateString发布时间contentString文章内容remarkString简介descString描述信息字段名类型约束说明idLong必填信息 IDhitLong必填点击量字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义descString描述信息字段名类型约束说明typeString选填转载类型DB34/T 408320216.5.1.1  重要转载信息功能描述：用于转载上级政府网站的重要信息。请求消息字段见表1。返回消息字段见表2。表1  重要转载信息请求消息字段表2  重要转载信息返回消息字段6.5.1.2  重要转载信息点击量上报功能描述：用于下级政府网站上报转载信息的点击量。请求消息字段见表3。返回消息字段见表4。表3  重要转载信息点击量上报请求消息字段表4  重要转载信息点击量上报返回消息字段6.5.2  信息报送6.5.2.1  信息报送功能描述：用于市级平台向省级平台报送信息。4字段名类型约束说明uidString必填信息报送系统用户名，数据格式要求：A1.20（字符含义见附录 E中表 E.1 的定义）titleString必填标题，数据格式要求：A1.100（字符含义见附录 E 中表 E.1 的定义）authorString必填作者，数据格式要求：A1.30（字符含义见附录 E 中表 E.1 的定义）addDateDate可选添加日期，默认当前日期，数据格式要求：D8+T6（字符含义见附录E 中表 E.1 的定义）classifyInteger可选报送分类（0：网站信息，1：解读材料，默认网站信息）infoModelInteger可选信息分类（0：中文信息，1：英文信息，默认中文信息）reporterNameString必填报送人姓名，数据格式要求：A1.30（字符含义见附录 E 中表 E.1的定义）reporterPhoneString必填报送人手机号，N11（字符含义见附录 E 中表 E.1 的定义）contentString必填信息内容字段名类型约束说明uidString必填信息报送系统用户名，数据格式要求：A1.20（字符含义见附录 E中表 E.1 的定义）idInteger可选信息报送返回的主键 id，数据格式要求：A.20（字符含义见附录 E中表 E.1 的定义）nameString可选标题，数据格式要求：A.100（字符含义见附录 E 中表 E.1 的定义）submitUserNameString必填报送人姓名，数据格式要求：A1.30（字符含义见附录 E 中表 E.1的定义）startDateDate可选报送日期的开始时间，数据格式要求：D8+T6（字符含义见附录 E 中表 E.1 的定义）字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义idInteger信息主键 iddescString描述信息注：信息新增的接口示例参见附录D 中 D.1。5DB34/T 40832021请求消息字段见表5。返回消息字段见表6。表5  信息报送接口请求消息字段表6  信息报送接口返回消息字段6.5.2.2  信息报送采用情况分页查询功能描述：用于市级平台查询报送信息的采用情况。请求消息字段见表7。返回消息字段见表8。表7  信息报送采用情况分页查询接口请求消息字段字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义idInteger信息 IDnameString信息标题useStatusInteger采用状态（0:未采用，1:已采用，3:已退回）useDateDate采用时间descString描述信息注：采用情况查询接口示例参见附录D 中 D.2endDateDate可选报送日期的结束时间，数据格式要求：D8+T6（字符含义见附录 E 中表 E.1 的定义）useStatusInteger可选采用状态（0:未采用，1:已采用，3:已退回）pageIndexInteger可选页码开始，默认从 0 开始pageSizeInteger可选一页数据条数字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义dataInteger返回数据，应报数量descString描述信息字段名 类型 约束 说明 yearString必填年份，数据格式要求：D4（字符含义见附录 E 中表 E.1 的定义）creditCodeString必填省市平台对接组织编码DB34/T 40832021表8  信息报送采用情况分页查询接口返回消息字段6.5.3  网站工作年报6.5.3.1  应报数量查询功能描述：用于市级平台获取政府网站工作年报应报数量。请求消息字段见表9。返回消息字段见表10。表9  应报数量查询接口请求消息字段表10应报数量查询接口返回消息字段6.5.3.2  填报数量推送功能描述：用于市级平台向省级平台推送本年度已填报且审核通过的网站工作年报数量。请求消息字段见表11。返回消息字段见表12。6字段名类型约束说明yearString必填年份，数据格式要求：D4（字符含义见附录 E 中表 E.1 的定义）creditCodeString必填省市平台对接组织编码reportGovYearDataArrayreportUnitCreditCodeString必填填报单位的省市平台对接组织编码siteNameString必填网站名称，数据格式要求：A1.50（字符含义见附录 E 中表E.1 的定义）indexWebsiteString必填首页网址，数据格式要求：A1.100（字符含义见附录 E 中表E.1 的定义）hostUnitString必填主办单位，数据格式要求：A1.50（字符含义见附录 E 中表E.1 的定义）websiteTypeInteger必填网站类型，1：政府门户网站 2：部门网站 3：专项网站siteCodeString必填政府网站标识码，数据格式要求：A1.30（字符含义见附录 E中表 E.1 的定义）siteICPString必填ICP 备案号，数据格式要求：A1.30（字符含义见附录 E 中表E.1 的定义）siteGajgbahString必填公安机关备案号，数据格式要求：A1.30（字符含义见附录 E中表 E.1 的定义）reportDateDate必填填报日期，数据格式要求：A1.30（字符含义见附录 E 中表E.1 的定义）uvLong必填独立用户访问总量（单位：个）pvLong必填网站总访问量（单位：次）字段名类型约束说明jsonArrayyearString必填年份，数据格式要求：D4（字符含义见附录 E 中表 E.1 的定义）creditCodeString必填省市平台对接组织编码countInteger必填网站工作年报数量字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义descString描述信息DB34/T 40832021表11填报数量推送接口请求消息字段表12填报数量推送接口返回消息字段6.5.3.3  上报功能描述：用于市级平台向省级平台上报网站工作年报数据。请求消息字段见表13。返回消息字段见表14。表13网站工作年报上报接口请求消息字段7totalPublishCountInteger必填总的信息发布数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必填答复网民提问数量isProvide IntelligenceQABoolean必填是否提供智能问答（false:否，true:是）safaCountInteger选填安全检测评估次数safeProblemCountInteger选填发现问题数量problemRepairCountInteger选填问题整改数量isBuildSafeWarningBoolean必填是否建立安全监测预警机制（false:否，true:是）isSafeDrillBoolean必填是否开展应急演练（false:否，true:是）hasSafeChargePersonBoolean必填是否明确网站安全责任人（false:否，true:是）hasNewMediaBoolean必填是否有移动新媒体（false:否，true:是）weiboNameString选填微博名称weiboInfoCountInteger选填微博信息发布量weiboFollowCountInteger选填微博关注量DB34/T 408320218weChatNameString选填微信名称weChatInfoCountInteger选填微信信息发布量weChatFollowCountInteger选填微信订阅数otherNewMediaDescString选填其他新媒体描述，数据格式要求：A.500（字符含义见附录 E中表 E.1 的定义）innovateDevString选填创新发展，多选以逗号分割1.搜索即服务 2.多语言版本 3.无障碍浏览 4.千人千网 5.其他innovateDevDescString选填创新发展描述unitChargePersonString选填单位负责人auditPersonString选填审核人addPersonString选填填报人contactPhoneString选填联系电话reportRemarkString选填备注字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义idInteger信息 idbackDateDate退回时间reasonString退回原因说明descString描述信息字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义descString描述信息字段名类型约束说明yearString必填年份，数据格式要求：D4（字符含义见附录 E 中表 E.1 的定义）creditCodeString必填省市平台对接组织编码DB34/T 40832021表14网站工作年报上报接口返回消息字段6.5.3.4  退回状态查询功能描述：用于市级平台获取政府网站工作年报退回状态信息。请求消息字段见表15。返回消息字段见表16。表15年报退回状态查询接口请求消息字段表16年报退回状态查询接口返回消息字段6.5.3.5  退回状态批量查询功能描述：批量查询政府网站工作年报退回状态信息（只返回被退回的数据）。请求消息字段见表17。9字段名类型约束说明creditCodeString必填省市平台对接组织编码yearDate必填年份，数据格式要求：D4（字符含义见附录 E 中表 E.1 的定义）creditCodeString必填省市平台对接组织编码quarterFirstInterviewInteger必填第一季度约谈数，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterFirstInspectionInteger必填第一季度书面检查数，数据格式要求：N3（字符含义见附录E 中表 E.1 的定义）quarterFirstCriticismInteger必填第一季度通报批评数，数据格式要求：N3（字符含义见附录E 中表 E.1 的定义）quarterFirstWarningInteger必填第一季度警告或记过处分，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterFirstTransferPositionInteger必填第一季度调离岗位或免职，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterFirstOtherInteger必填第一季度其他数，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterSecondInterviewInteger必填第二季度约谈数，数据格式要求：N3（字符含义见附录 E 中字段名类型说明statusInteger返回状态码，见附录 C 中表 C.1 的定义idInteger信息 idbackDateDate退回时间reasonString退回原因说明descString描述信息字段名类型约束说明yearString必填年份，数据格式要求：D4（字符含义见附录 E 中表 E.1 的定义）creditCodeString必填省市平台对接组织编码DB34/T 40832021返回消息字段见表18。表17年报退回状态批量查询接口请求消息字段表18年报退回状态批量查询接口返回消息字段6.5.4  网站监管年报6.5.4.1  上报功能描述：向省级平台上报网站监管年报数据。请求消息字段见表19。返回消息字段见表20。表19网站监管年报上报请求消息字段10表 E.1 的定义）quarterSecondInspectionInteger必填第二季度书面检查数，数据格式要求：N3（字符含义见附录E 中表 E.1 的定义）quarterSecondCriticismInteger必填第二季度通报批评数，数据格式要求：N3（字符含义见附录E 中表 E.1 的定义）quarterSecondWarningInteger必填第二季度警告或记过处分，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterSecondTransferPositionInteger必填第二季度调离岗位或免职，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterSecondOtherInteger必填第二季度其他数，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterThirdInterviewInteger必填第三季度约谈数，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterThirdInspectionInteger必填第三季度书面检查数，数据格式要求：N3（字符含义见附录E 中表 E.1 的定义）quarterThirdCriticismInteger必填第三季度通报批评数，数据格式要求：N3（字符含义见附录E 中表 E.1 的定义）quarterThirdWarningInteger必填第三季度警告或记过处分，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterThirdTransferPositionInteger必填第三季度调离岗位或免职，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterThirdOtherInteger必填第三季度其他数，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterFourthInterviewInteger必填第四季度约谈数，数据格式要求：N3（字符含义见附录 E 中表 E.1 的定义）quarterFourthInspectionInteger必填第四季度书面检查数，数据格式要求：N3（字符含义见附录E 中表 E.1 的定义）quarterFourthCriticism