DB3502∕T 056.3-2020 政务信息共享协同平台 第3部分：接入要求.docx

《DB3502∕T 056.3-2020 政务信息共享协同平台 第3部分：接入要求.docx》由会员分享，可在线阅读，更多相关《DB3502∕T 056.3-2020 政务信息共享协同平台 第3部分：接入要求.docx（44页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、ICS35.240CCSL773502/T福建省厦门市地方标准DB3502/T056.32020政务信息共享协同平台第3部分：接入要求ThesharingandcollaborativeplatformofgovernmentinformationPart3：Interfacerequirement2020-12-31发布2021-01-01实施厦门市市场监督管理局发布DB3502/T056.32020目次前言.III引言.IV1范围.12规范性引用文件.13术语和定义.14缩略语.25网络链路架构.26生产方接入.3接入服务接口资源.3接入数据文件资源.4接入数据库表资源.4接入数据流资源.

2、57消费方接入.6使用服务接口资源.6使用数据文件资源.7使用数据库表资源.7使用数据流资源.88区级平台接入.8区级平台接入概述.8区级平台接入申请.8调用平台服务接口流程.9公共参数说明.10平台对接接口.10附录A（资料性）协同平台错误码表.21附录B（资料性）共享服务资源调用示例.22B.1调用步骤说明.22B.2Java语言版本调用示例.22附录C（资料性）区级平台接入规范报文示例.28C.1请求报文示例.28C.2退出登录接口.28C.3表码获取接口.29C.4“我的服务”接口.30C.5新增、修改服务接口.32C.6获取服务详细信息接口.33C.7服务提交审核接口.35C.8获取

3、可申请的外部服务列表接口.36C.9申请外部服务接口.38IDB3502/T056.32020参考文献.39IIDB3502/T056.32020前言本文件按照GB/T1.12020标准化工作导则第1部分：标准化文件的结构和起草规则的规定起草。本文件为DB3502/T056政务信息共享协同平台技术规范的第3部分。DB3502/T056已发布了以下部分：第1部分：总体设计；第2部分：资源管理；第3部分：接入要求；第4部分：二次开发。本文件是在DB3502/Z033.32016政务信息共享协同平台技术规范第3部分：平台接入规范的基础上，根据技术和需求变化，重新立项并制定的。与DB3502/Z033

4、.32016相比，除结构性调整和编辑性改动外，主要技术变化如下：a)根据平台资源管理要求，同步调整生产方接入流程及操作，或重新释义（见第6章，DB3502/Z033.32016的第7章）；b)根据平台资源管理要求，同步调整消费方接入流程及操作，或重新释义（见第7章，DB3502/Z033.32016的第6章、第8章）；c)根据平台资源管理要求，同步调整区级平台接入流程及操作，或重新释义（见第8章，DB3502/Z033.32016的第9章）；d)增加接入日志记录要求，建立调用方与平台的对账机制（见7.1.2.2.5）；e)完善带TLS的服务资源接入要求说明（见6.1.2.3，DB3502/Z0

5、33.32016的7.2.3）；f)增加服务接入URL地址释义（见7.1.2.2.1）；g)增加平台错误码表（见附录A）；h)按照当前接入要求提供示例代码（见附录B、附录C，DB3502/Z033.32016的附录B、附录C）。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。本文件由厦门市工业和信息化局提出。本文件由厦门市工业和信息化局归口。本文件起草单位：厦门畅享信息技术有限公司、厦门市标准化研究院、厦门市信息中心。本文件主要起草人：郭劲军、郭望、傅楚隆、揭英杰、吴宸勖、陈尚峰、卢淼先、闫焕友、李童、蔡跃华、张金梅、刘姗姗、吕志仁、赖炜炜、巫晓强、杨远军、朱永上、彭

6、明剑。IIIDB3502/T056.32020引言DB3502/T056政务信息共享协同平台旨在确立政务信息共享协同平台总体设计、资源管理、接入要求、二次开发的技术标准，拟由四个部分构成。第1部分：总体设计。目的在于确立平台关键技术路线和软件系统的组织形式，确保平台总体架构满足国家对政务信息交换与共享的要求，明确平台内主要功能模块和模块间的逻辑关系，避免“过度建设”并确保“必要建设”。第2部分：资源管理。目的在于规范平台所支持的多种资源类型、协议标准、提供方式，为平台对外服务的兼容性提供保障；明确平台不同类型资源的属性，统一属性分类，为平台对外服务的通用性提供保障；针对资源生产、资源注册、资源

7、测试、资源申请、资源调用、资源目录、资源检索、资源版本、资源安全等操作提出全生命周期管理要求，为平台对外服务的可用性提供保障。第3部分：接入要求。目的在于将平台对外接口标准化，明确接口在安全性、完备性、一致性、易用性、稳定性方面要求，进一步提升平台对外提供服务的能力和质量，并从网络接入、平台资源生产方、平台资源消费方、区级平台接入等方面，明确接入的实现方式，为保障平台建设质量及拓展平台应用范围提供技术支撑。第4部分：二次开发。目的在于规范平台提供二次开发的工作方式、对扩展模块管理方式，为后续平台业务流程及插件的完善提供统一标准，既避免了平台直接耦合上层各类业务，又允许不同部门结合特定业务需要，

8、在授权范围内扩展平台功能。IVDB3502/T056.32020政务信息共享协同平台第3部分：接入要求1范围本文件规定了生产方、消费方、区级平台接入政务信息共享协同平台的技术要求。本文件适用于政务信息共享协同平台中的生产方接入、消费方接入、区级平台接入，各部门应用系统接入时参照使用。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。DB3502/T056.12020政务信息共享协同平台第1部分：总体设计DB3502/T056.22020政务信息共

9、享协同平台第2部分：资源管理3术语和定义DB3502/T056.12020、DB3502/T056.22020界定的以及下列术语和定义适用于本文件。请求方IDrequesteridentity协同平台为每个服务消费方分配的唯一标识。服务方IDservicesidentity协同平台为每个服务生产方分配的唯一标识。融合服务compositeservice基于服务流程引擎，融合多个原子服务，实现将多个细颗粒度服务，融合为一个粗颗粒度服务。请求接入requesteraccess按照协同平台标准，服务消费方接入到本平台，并且调用其他单位服务的过程。服务接入servicesaccess按照协同平台标准，

10、服务生产方接入到本平台，对外服务的过程。消息（用于编程语言）message(inprogramminglanguages)对象进行其各一次运算之一的一次请求。来源：GB/T5217.152008，15.09.061DB3502/T056.32020请求报文requestmessage服务消费方向协同平台发出的报文。响应报文responsemessage协同平台返回给服务消费方的结果报文。4缩略语下列缩略语适用于本文件。API：应用程序编程接口（ApplicationProgrammingInterface）APP：应用程序（APPlication）CPU：中央处理器（CentralProces

11、singUnit）GB：计算机存储单位，吉字节（GigaByte）HTTP：超文本传输协议（HyperTextTransferProtocol）ID：唯一编码（IdentityDocument）JSON：基于“JavaScript”语言形式的数据对象表达方式（JavaScriptObjectNotation）RTSP：实时流传输协议（RealTimeStreamingProtocol）REST：表述性状态转移（REpresentationalStateTransfer）SDK：软件开发工具包（SoftwareDevelopmentKit）SFTP：SSH文件传输协议（SSHFileTransf

12、erProtocol）SOAP：简单对象访问协议（SimpleObjectAccessProtocol）SSL：安全套接层（SecureSocketsLayer）TCP：传输控制协议（TransmissionControlProtocol）TLS：传输层安全协议（TransportLayerSecurity）UDP：用户数据报协议（UserDatagramProtocol）UTF-8：8位的针对Unicode的可变长度字符编码（8-bitUnicodeTransformationFormat）URL：统一资源定位系统（UniformResourceLocator）WSDL：Web服务器描述语言

13、（WebServiceDescriptionLanguage）XML：扩展性标识语言（eXtensibleMarkupLanguage）XSD：XML结构定义（XMLSchemaDefinition）5网络链路架构图1网络链路架构2技术点最低版本要求TransferHTTP1.1MessageFormatandProtocolsSOAP1.1or1.2IdentityorLocationWS-Addressing1.0ServiceDefinitionXMLSchemaWSDL1.1DB3502/T056.32020网络链路架构见图1。分控中心应采用独立的服务器作为接入前置机，接通与总控中心服

14、务器的网络。接入前置机和总控中心服务器、分控中心内部业务系统之间，应根据分控中心的安全需求，架设一道或多道防火墙等网络安全设备。基本配置要求如下：a)网络要求：局域网接入速度应大于100Mb/s；b)前置机配置要求：CPU主频不低于1.5GHz，核心数不少于4个，内存不低于4G，采用Linux或自主可控操作系统；c)部署接入前置机应由部门端和总控中心双方共同管理。前置机上主要部署分控中心所需的软件环境，不宜部署其它应用。6生产方接入接入服务接口资源6.1.1服务接入流程服务接入涉及到两类用户，分控管理员和总控管理员。分控管理员登录分控中心，填写服务接口的共享资源信息，包括资源的基础信息、共享权

15、责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。服务接入过程中所需注册的信息包括资源类型、主题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、服务地址、服务方法名、入参配置、出参配置、资源描述、资源文档。字段含义参照DB3502/T056.22020中5.1的说明。6.1.2技术要求6.1.2.1WebService接入6.1.2.1.1接入到平台的WebService服务应满足表1的版本要求。表1WebService版本要求6.1.2.1.2接入本平台的服务方默认只支持基本数据类型，以消除由于使用不同语言

16、、不同框架实现WebService框架产生的差异。针对复杂数据结构，宜采用XML结构（string类型）描述，以实现一步式接入。6.1.2.2REST服务接入服务的报文格式及交换形式满足HTTP1.0或HTTP1.1传输协议，采用GET或POST方法提起请求，采用JSON格式、XML或自定义纯文本作为请求或回应报文的载体格式。6.1.2.3带TLS的服务资源接入3DB3502/T056.32020协同平台支持采用TLS1.1及以上的版本进行传输加密的服务资源注册，支持以下方式。对于b)和c)方式，资源在注册过程中应提供相应的身份认证证书。a)不做身份认证仅加密报文。b)加密报文且实现请求方通过

17、证书验证服务方，服务方不验证请求方。c)加密报文且请求与服务方相互验证对方身份三种安全交换方式。接入数据文件资源6.2.1数据文件资源接入流程数据文件资源接入涉及到两类用户，分控管理员和总控管理员。分控管理员登录分控中心，填写数据文件的共享资源信息，包括资源的基础信息、共享权责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。服务接入过程中所需注册的信息包括主题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、上传方式、资源描述、资源文档。字段含义参照DB3502/T056.22020中5.1的说明。6.2.2技

18、术要求数据文件资源应符合以下要求，以提供稳定的数据资源共享服务：a)文件大小单文件应不超过2GB，如超过此限制，应使用压缩分片工具对大文件进行分割后再共享；b)文件目录的目录层级应不超过3层；c)SFTP协议传输时应将目录名、文件名指定为UTF-8编码格式。接入数据库表资源6.3.1数据库表资源接入流程数据库表资源接入涉及到两类用户，分控管理员和总控管理员。分控管理员登录分控中心，填写数据库表的共享资源信息，包括资源的基础信息、共享权责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。服务接入过程中所需注册的信息包括资源类型、主

19、题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、数据加载方式、数据源、数据库类型、数据连接、数据库表、数据库表结构、资源描述、资源文档。字段含义参照DB3502/T056.22020中5.1的说明。6.3.2技术要求6.3.2.1数据库类型协同平台支持Oracle、Mysql、SqlServer等关系型数据库的数据库类型的库表资源共享。6.3.2.2数据库表结构数据库表类型共享资源应符合以下要求：a)数据库表名应不超过30个字符；b)数据库表都应有唯一的主键；c)数据库表都应有描述数据更新的时间戳字段；4ORACLE字段MySQL字段是否支持NUMBERTINYINT支持S

20、MALLINT支持MEDIUMINT支持INT或INTEGER支持BIGINT支持FLOAT支持DOUBLE支持DECIMAL支持YEAR支持DATEDATE支持TIMESTAMPTIME支持DATETIME支持TIMESTAMP支持CHARCHAR支持VARCHAR2VARCHAR支持CLOBTINYTEXT暂不支持TEXT暂不支持MEDIUMTEXT暂不支持LONGTEXT暂不支持BLOBTINYBLOB暂不支持BLOB暂不支持MEDIUMBLOB暂不支持LONGBLOB暂不支持其他其他暂不支持DB3502/T056.32020d)数据库表的字段类型应在可共享字段类型范围内，暂不支持CLO

21、B、BLOB及其他类型字段，具体见表2。表2数据库表支持字段类型说明接入数据流资源6.4.1数据流资源接入流程数据流资源接入涉及到两类用户，分控管理员和总控管理员。分控管理员登录分控中心，填写类型数据流的共享资源信息，包括资源的基础信息、共享权责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。服务接入过程中所需注册的信息包括资源类型、主题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、协议类型、服务IP地址、服务端口、资源描述、资源文档。字段含义参照DB3502/T056.22020中5.1的说明。6.4.2

22、技术要求协同平台支持基于TCP、UDP类型的数据流资源共享，如MQ、Redis、HTTP、RTSP等协议传输的资源。5DB3502/T056.320207消费方接入使用服务接口资源7.1.1使用服务接口接入流程7.1.1.1消费方使用服务接口接入流程包括两步：第一步是分控管理员填写申请使用服务的信息，总控管理员审批通过后，将获得调用该服务的权限。第二步是单位的应用系统构建请求报文，调用协同平台的请求接口，获取结果数据。7.1.1.2申请服务所需填写的主要信息包括：a)资源ID：协同平台唯一表征某一共享资源的英文标签，应符合DB3502/T056.22020第5章的要求；b)申请ID：用于在协同

23、平台表征本次申请行为的唯一英文标记；c)联系人：指定请求申请目标服务的联系人信息；d)联系人电话：指定请求申请目标服务的联系人电话；e)授权业务：指定请求申请目标服务所用的授权业务；f)授权应用系统：指定请求申请目标服务所用的授权应用系统；g)使用频率：指定请求申请目标服务所用的最高频率；h)使用并发量：指定请求申请目标服务所用的最高并发量；i)其他技术请求：指定请求申请目标服务所用的其他技术请求。7.1.2接入方式7.1.2.1请求接入协同平台支持基于HTTP+REST风格URL调用。如调用不成功，应返回错误码给消费方。错误码及说明见附录A。7.1.2.2消费方基于REST风格的接入7.1.

24、2.2.1协同平台服务资源宜表示为REST风格的URL地址。格式及说明见图2。7.1.2.2.2协同平台服务资源访问前需通过URL获取凭证令牌才可访问资源。格式及说明见图3。7.1.2.2.3协同平台服务资源短码通过在协同平台申请的资源详情下载使用手册来查阅。授权短码代表应用与共享服务资源的对应关系，不同应用对同个可访问授权资源的授权短码是不同的。7.1.2.2.4通过请求协同平台服务资源来完成的政务业务，URL格式详见图2。7.1.2.2.5协同平台记录被调用日志时，需记录办件编码信息；调用方记录调用日志时，需记录办件编码信息。图2REST风格服务资源URL地址说明6DB3502/T056.

25、32020图3凭证令牌获取URL地址说明7.1.2.3消费方基于SDK的接入协同平台升级版本后，依旧兼容旧版的SDK调用方式，在服务请求方不改变原有调用方式的情况下，原已申请的服务资源应可继续使用。新申请的服务，宜使用REST风格的接入标准。共享服务资源调用示例见附录B。使用数据文件资源7.2.1使用数据文件资源接入流程7.2.1.1消费方使用数据文件资源接入流程包括两步：a)第一步：分控管理员填写信息并申请使用数据文件资源，经总控管理员审批通过后，获得调用该数据文件资源的权限；b)第二步：消费方或消费方的应用系统通过SFTP协议或指定的文件接收目录，获取相应的数据文件资源。7.2.1.2申请

26、数据文件资源所需填写的主要信息包括：a)资源ID：协同平台唯一表征某一共享资源的英文标签，应符合DB3502/T056.22020第5章的要求；b)申请ID：用于在协同平台表征本次申请行为的唯一英文标记；c)联系人：指定请求申请目标数据文件资源的联系人信息；d)联系人电话：指定请求申请目标数据文件资源的联系人电话；e)授权业务：指定请求申请目标数据文件资源所用的授权业务；f)授权应用系统：指定请求申请目标数据文件资源所用的授权应用系统；g)接收方式：指定数据文件资源的接收方式，包含SFTP和本地目录两种方式。SFTP模式需提交SFTP地址、用户名和密码，本地目录接收指定服务器的接收目录。7.2

27、.2接入方式按照申请信息中的相关要求，初始化对应的SFTP用户及目录。使用数据库表资源7.3.1使用数据库表资源流程7.3.1.1消费方使用数据库表资源流程包括三步：a)第一步：分控管理员填写信息并申请使用数据库表，经总控管理员审批通过后，获得使用该数据库表的权限；b)第二步：总控管理员配置数据库交换方案，将数据同步到前置库或推送到业务库；c)第三步：消费方按要求从前置库或本地业务库获取结果数据。7.3.1.2申请服务所需填写的主要信息包括：7DB3502/T056.32020a)资源ID：协同平台唯一表征某一共享资源的英文标签，应符合DB3502/T056.22020第5章的要求；b)申请I

28、D：用于在协同平台表征本次申请行为的唯一英文标记；c)联系人：指定请求申请目标数据库表资源的联系人信息；d)联系人电话：指定请求申请目标数据库表资源的联系人电话；e)授权业务：指定请求申请目标数据库表资源所用的授权业务；f)授权应用系统：指定请求申请目标数据库表资源所用的授权应用系统；g)同步字段：指定请求申请数据库表资源要同步的字段集；h)接收方式：指定请求申请数据库表资源的接收方式，包含前置库读取或推送到本地业务库；i)接收数据源：指定请求申请数据库表资源的接收数据源相关属性，包含：用户名、密码、数据库类型、字符集、数据库参数、数据库表。7.3.2接入方式按照申请信息中的相关要求，初始化对

29、应的数据库用户及库表信息。使用数据流资源7.4.1使用数据流资源流程7.4.1.1消费方使用数据流资源流程包括两步：a)第一步：分控管理员填写信息并申请使用服务，经总控管理员审批通过后，获得调用该服务的权限；b)第二步：消费方的应用系统构建请求报文，调用协同平台的请求接口，获取结果数据。7.4.1.2申请服务所需填写的主要信息包括：a)资源ID：协同平台唯一表征某一共享资源的英文标签，应符合DB3502/T056.22020第5章的要求；b)申请ID：用于在协同平台表征本次申请行为的唯一英文标记；c)联系人：指定请求申请目标数据流资源的联系人信息；d)联系人电话：指定请求申请目标数据流资源的联

30、系人电话；e)授权业务：指定请求申请目标数据流资源所用的授权业务；f)授权应用系统：指定请求申请目标数据流资源所用的授权应用系统；g)授权IP：指定请求申请目标数据流资源授权可访问的IP地址。7.4.2接入方式按照目标数据流资源指定的数据访问协议，访问协同平台开放的数据流资源IP端口。8区级平台接入区级平台接入概述包括区级协同平台在内的第三方应用（以下以区级平台示例），应通过接入本平台以获得各类已开放的资源。协同平台提供基于WebService形式的开发接口。接入报文示例见附录C。区级平台接入申请8.2.1区级平台接入之前，应在市政务信息共享协同平台管理系统发起接入申请。其中需要选择所需8DB

31、3502/T056.32020要协同平台给予提供的权限接口，可选范围包括：a)我的服务接口：获得查看区级平台向市级平台已申请的服务列表，或区级平台已向市级平台发布的服务列表；b)获取可申请服务接口：获得查看市级平台所有可向区级平台开放的服务目录列表；c)发布服务接口：调用该接口，可向市级平台开放区级平台上的服务资源；d)申请服务接口：调用该接口，可向市级平台申请区级平台所需的服务资源；e)修改服务接口：修改已经发布到市级平台的服务接口的部分配置；f)调用服务接口：调用已通过“申请服务接口”，并完成并通过申请的市级平台服务。8.2.2审核通过后，指定应用即可上线调用指定的市级平台接口。8.2.3

32、应用审核通过后，应获得由市级平台自动分配给本应用的且不可更改的AppID和SecretKey等属性：a)AppID：由系统生成，作为应用的唯一标识；b)SecretKey：由系统生成，用来验证应用合法性的加密串。8.2.4具体操作流程如下：a)在管理页面填写基本信息，应包括：应用名称、简介，并选择待申请使用的接口范围；b)信息填写完成并提交审核后，进入审核阶段；c)平台管理员审核通过，可获得相应权限。调用平台服务接口流程8.3.1拥有平台用户帐号和应用AppID和SecretKey后，应用应凭借二者调用资源，调用时序见图4。8.3.2调用平台中不需要权限的API时，宜直接调用，无须携带Acce

33、ssToken，但仍应对参数进行签名。对于平台中需要权限的API，第三方应用应先进行一个登陆验证，获取访问凭证AccessToken，在调用时将AccessToken作为参数。（平台对接接口应符合8.5的要求）。传入及返回字符集均采用UTF-8格式。图4平台服务接口调用时序9参数名称是否必须类型描述appid是string应用的唯一ID。通过appid查找APP基本信息。sig是string请求串的签名，具体签名算法见上一节第三方应用签名参数sig的说明。format否string返回值的格式。请指定为JSON或者XML，缺省值为JSON，忽略大小写access_token是string登录验证后获得的token（注：调用需权限的资源时必须，没有特别说明不需要的均需携带此参