政务信息资源 数据服务接口规范.docx

《政务信息资源 数据服务接口规范.docx》由会员分享，可在线阅读，更多相关《政务信息资源 数据服务接口规范.docx（9页珍藏版）》请在第一文库网上搜索。

1、政务信息资源数据服务接口规范1范围本文件规定了政务信息资源的数据服务接口要求、提供要求、使用要求和安全要求。本文件适用于政务信息资源数据服务接M的设计、开发和实施。注：本文件规定的政务信息资源数据为政务业务办理中产生的结构化数据。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。GB/T2261.1-2003个人基本信息分类与代码第1部分：人的性别代码GB/T33041991中国各民族名称的罗马字母拼写法和代码GB/T22239-2019信息安全

2、技术网络安全等级保护基本要求GB/T352732023信息安全技术个人信息安全规范DB37/T3521.1-2019政务信息资源目录第1部分：编码规则DB37/T3523.22019公共数据开放第2部分：数据脱敏指南3术语和定义下列术语和定义适用于本文件。3.1数据服务dataservice通过一定的技术手段，对外提供政务信息资源。4缩略语下列缩略语适用于本文件。API：应用程序接口(App1icationProgrammingInterface)APP：移动应用(App1ication)HTM15：超文本标记语言5.0(HyperTextMarkup1anguage5.0)IP：网络互连协议

3、(InternetProtoco1)JSON：JaVaSCriPt对象简谱(JaVaSCriPtObjectNotation)REST：表述性状态传递(RePreSentationaIStateTransfer)RPC：远程过程调用(RemoteProcedureCa11)SDK：软件开发工具包(SoftWareDeve1opmentKit)SOAP：简单对象访问协议(Simp1eObjectAccessProtoco1)UTF-8：UniCOde的可变长度字符编码(8-bitUnicodeTransformationFormat)WSD1：Web服务描述语言(WebServicesDescr

4、iption1anguage)XM1：可扩展标记语言(Extensib1eMarkup1anguage)5服务接口要求5.1 服务接口设计原则服务接口设计原则主要包括：a）安全性原则：应提供多种安全可靠的技术手段，保证服务接口的安全；b）开放性原则：应采用通用的接口设计标准，保证与其他系统的互联互通;c）灵活性原则：应能根据业务变化，灵活调整接口性能；d）松耦合原则：应避免服务提供方的业务系统对服务接口实现的依赖。5.2 服务接口名称服务接口名称应采用中文名称，由服务提供方名称、信息资源名称和接口分类三部分组成。服务提供方名称宜使用国家规定的部门简称，如XX省公安厅简称为省公安厅。注1：部门简

5、称可参照XX省人民政府办公厅关于印发省政府机构简称的通知（X政办字（2018）203号）。注2：服务提供方：政务信息资源数据服务接口的提供部门。注3：服务接口的英文表示名称为中文名称的汉语拼音简写，且首字母大写。5.3 服务接口编码服务接口编码由接口提供类型编码、政务信息资源编码、接口分类编码和接口顺序码四部分组成,编码结构见图1。图1服务接口编码结构服务接口编码规则如下：a）第1位为接口提供类型编码，使用1位阿拉伯数字表示，“0”标识服务提供方开发接口，“1”标识省一体化大数据平台统一开发接口；b）第213位为政务信息资源编码，使用12位阿拉伯数字表示，由政务部门系列顺序码和信息资源顺序码组

6、成，编码规则见DB37/T3521.12019中4.2节：c）第14位为接口分类编码，使用1位阿拉伯数字表示，编码范围为19,分类编码见5.4节；d）第1517位为接口顺序码，使用3位阿拉伯数字表示，用于标识同一接口分类下的接口顺序，编码范围为OO1999。5.4 服务接口分类服务接口分类见表1。表1接口分类代码代码分类名称1查询类2验证类3数据传输类4下载类9其他类5.5服务接口技术要求服务接口技术要求包括但不限于：a）接口方式：一般包括WebService和REST两种方式，WebService服务描述的内容格式应符合WSD111服务消息封装应符合SOAP1.1/1.2标准，REST服务消

7、息封装应符合1.0/1.1标准,若为REST方式，应标明REST操作；b）接口授权：服务提供方应对每条申请授权唯一的接口授权码，通过分配的接口密钥调用身份认证接口获取访问令牌，接口授权的安全要求包括但不限于IP地址白名单、动态访问令牌；c）接口输入参数：1） REST类型的服务接口，应允许在header里输入授权验证相关参数；2） WebSerViCe类型的服务接口，不应在header中传递参数，应在Body中传递参数；3） 传递参数为中文字符时，应采用UTF-8编码。d）接口返回数据：4） 返回数据应采用固定格式封装，如XM1、JSON等；5） 服务接口调用失败，应通过返回码响应。5.6服务

8、接口管理要求5.6.1 概述通过服务接口访问时，应提供自动监管和异常处理能力，并统一管理管控参数。5. 6.2接口注册服务接口注册要求包括但不限于：a）应提供测试样例，确保服务使用方能对服务接口进行测试；b）应填写准确的技术联系人信息；c）应填写服务接口注册信息表，经服务管理方审核通过后正式发布，服务接口注册信息表模板见附录A。注1：服务使用方：政务信息资源数据服务接口的使用部门。注2：服务管理方：政务信息资源数据服务接口的管理部门。5.6.3接口发布服务接口发布要求包括但不限于：a）服务管理方和服务提供方应负责服务接口统一发布；b）服务接口发布信息包括但不限于接口概述、接口名称、接口分类、接

9、口方式、接口地址、接口授权、接口方法、输入输出参数和接口示例，接口描述信息表填写示例见附录B。5. 6.4接口变更服务接口变更要求包括但不限于：a）服务提供方对已发布的服务接口进行变更时应不影响服务接口的正常使用；b）如服务接口已被服务使用方调用，服务提供方应首先发布新版服务接口并通知服务使用方在一定期限内应用新版服务接口；c）接口变更应实行版本控制机制；d）接口变更应实行备案制，备案内容包括但不限于接口更新的计划停止时间、重新后用时间、更新内容。5. 6.5接口撤销服务接口撤销要求包括但不限于：a）服务接口无服务使用方调用，服务提供方应向服务管理方提交接口撤销申请并备案；b）服务接口已被服务

10、使用方调用，服务提供方应通知服务使用方后向服务管理方提交接口撤销申请并备案；c）服务接口撤销应实行备案制，备案内容包括但不限于接口撤销的原因，计划撤销时间；d）服务管理方应对接口撤销备案进行审核，审核通过后撤销接口。6服务提供要求提供的服务应满足的要求包括但不限于：a）应提供审计功能，记录数据服务调用的时间、服务提供方、服务使用方、接口调用情况等信息;b）应满足服务数据获取有效性、及时性、准确性和完整性等数据质量要求；c）服务接口应根据具体情况满足一定的技术要求，如接口响应时间、并发数等；d）接口调用应保持良好的稳定性，如高并发调用服务时，稳定性应达到99.99%以上。7服务使用要求7.1 服

11、务申请服务申请的具体要求主要包括：a）服务使用方调用服务接口时，应提交服务接口使用申请并填写服务申请信息表，服务使用申请信息表模板见附录C；b）服务提供方和服务管理方应在服务申请审核通过后，为服务使用方提供唯一的接口授权码；c）服务使用方使用服务接口过程中获取的数据信息应遵守保密规定，不应泄露给第三方。7.2 服务使用服务使用方应获取授权认证信息后进行服务接口调用，调用的具体步骤如下：a）获取唯一授权码：服务使用方应获取接口的唯一授权码，唯一授权码不限调用次数；b）接口调用：服务使用方调用服务接口时输入参数应满足服务提供方的格式、位置等要求，同时须在header中增加传入服务访问令牌Ioken

12、信息验证访问权限，验证通过后，返回接口响应结果；c）鉴权监测：服务提供方应获取header中服务访问令牌token信息进行权限验证并监测接口调用情况；d）服务处理：服务提供方应根据服务使用方的输入参数进行服务处理，同时保存服务处理过程中产生的日志信息。8服务安全要求服务安全应满足GB/T222392019、GB/T352732023、DB37/T3523.22019中的要求。附录A（资料性）服务接口注册信息表模板服务接口注册信息表模板见表A.1。表AJ服务接口注册信息表序号名称描述1服务名称数据服务接口的中文名称，确保唯一性2服务摘要提供服务的简单描述3服务提供方代码数据服务接I1的服务提供方

13、代码（统一社会信用代码）4服务提供方名称数据服务接11的服务提供方名称5所属资源目录数据服务接口所属的资源目录，资源目录由服务提供方编目并注册，当服务接口注册时，选择相应的资源目录6服务地址服务接口的IP地址7协议类型基于协议的类型,如RPC、RESTFU1、SOAPWEBSERVICE8请求方法数据服务接口的请求方法,如POST9响应格式数据服务接I1的响应方法，如JSON10调用频率服务接11的每天调用频次之和的上限值，（如：1000次/天）11服务有效日期服务接口调用的有效截止日期，日期格式（YYYY-MM-DD）12参数表参数表13参数名参数名14参数位置参数位置（1：header：2

14、：body）15参数类型参数类型包括但不限于String、int1ong、array、boo1ean-,object16约束条件参数约束限制条件，如字符长度等17描述信息参数的描述信息18服务接口说明文档详细的服务接口使用说明文档，内容应包括但不限于服务接口概述、服务接口访问限制、服务接口参数说明、服务接口授权说明、服务接口调用示例注：避免在服务接口使用说明文档中暴露原始服务接口地址。附录B（资料性）服务接口描述信息填写示例B-1服务接口返回JSON格式示例用户信息查询接口描述信息填写示例见表B.1。表B.1用户信息查询接口描述信息填写示例接口概述通过姓名、身份证件号码，在人口信息资源库中定位

15、人员信息，并将该人员的性别、民族、出生日期和出生地信息进行反馈接口名称省公安厅XX省户籍人口信息查询接口接口分类查询类接口方式REST接口地址XX.XXX.XXX.XXX:XXX/gateway/1/SgatXXCX接口授权服务提供方授权接口方法GET输入（业务请求参数说明）参数名参数说明类型约束姓名在户籍管理部门正式登记注册，人事档案中正式记载的姓氏名称。字符型必填身份证件号码身份证件上记载的、可唯一标识个人身份的号码。字符型必填输出（业务返回参数）参数名参数说明类型备注姓名在户籍管理部门正式登记注册，人事档案中正式记载的姓氏名称。字符型非空项身份证件号码身份证件上记载的、可唯标识个人身份的号码。字符型非空项性别性别