DB3502∕T 056.3—2020 政务信息共享协同平台 第3部分：接入要求(厦门市).pdf

ICS 35.240 CCS L77 3502/T 福建省厦门市地方标准 DB3502/T 056.32020 政务信息共享协同平台 第 3 部分：接入要求 The sharing and collaborative platform of government information Part 3：Interface requirement 2020 - 12 - 31 发布 2021 - 01 - 01 实施 厦门市市场监督管理局 发 布 DB3502/T 056.32020 I 目次 前言 . III 引言 . IV 1 范围 . 1 2 规范性引用文件 . 1 3 术语和定义 . 1 4 缩略语 . 2 5 网络链路架构 . 2 6 生产方接入 . 3 接入服务接口资源 . 3 接入数据文件资源 . 4 接入数据库表资源 . 4 接入数据流资源 . 5 7 消费方接入 . 6 使用服务接口资源 . 6 使用数据文件资源 . 7 使用数据库表资源 . 7 使用数据流资源 . 8 8 区级平台接入 . 8 区级平台接入概述 . 8 区级平台接入申请 . 8 调用平台服务接口流程 . 9 公共参数说明 . 10 平台对接接口 . 10 附录 A（资料性） 协同平台错误码表 . 21 附录 B（资料性） 共享服务资源调用示例 . 22 B.1 调用步骤说明 . 22 B.2 Java 语言版本调用示例 . 22 附录 C（资料性） 区级平台接入规范报文示例 . 28 C.1 请求报文示例 . 28 C.2 退出登录接口 . 28 C.3 表码获取接口 . 29 C.4 “我的服务”接口 . 30 C.5 新增、修改服务接口 . 32 C.6 获取服务详细信息接口 . 33 C.7 服务提交审核接口 . 35 C.8 获取可申请的外部服务列表接口 . 36 C.9 申请外部服务接口 . 38 DB3502/T 056.32020 II 参考文献 . 39 DB3502/T 056.32020 III 前言 本文件按照GB/T 1.12020标准化工作导则 第1部分：标准化文件的结构和起草规则的规定起草。 本文件为DB3502/T 056政务信息共享协同平台技术规范的第3部分。DB3502/T 056已发布了以下部分： 第 1 部分：总体设计； 第 2 部分：资源管理； 第 3 部分：接入要求； 第 4 部分：二次开发。 本文件是在DB3502/Z 033.32016政务信息共享协同平台技术规范 第3部分：平台接入规范的基础上，根据技术和需求变化，重新立项并制定的。与DB3502/Z 033.32016相比，除结构性调整和编辑性改动外，主要技术变化如下： a) 根据平台资源管理要求，同步调整生产方接入流程及操作，或重新释义（见第 6 章，DB3502/Z 033.32016 的第 7 章）； b) 根据平台资源管理要求，同步调整消费方接入流程及操作，或重新释义（见第 7 章，DB3502/Z 033.32016 的第 6 章、第 8 章）； c) 根据平台资源管理要求， 同步调整区级平台接入流程及操作， 或重新释义 （见第 8 章， DB3502/Z 033.32016 的第 9 章）； d) 增加接入日志记录要求，建立调用方与平台的对账机制（见 7.1.2.2.5）； e) 完善带 TLS 的服务资源接入要求说明（见 6.1.2.3，DB3502/Z 033.32016 的 7.2.3）； f) 增加服务接入 URL 地址释义（见 7.1.2.2.1）； g) 增加平台错误码表（见附录 A）； h) 按照当前接入要求提供示例代码（见附录 B、附录 C，DB3502/Z 033.32016 的附录 B、附录C）。 请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。 本文件由厦门市工业和信息化局提出。 本文件由厦门市工业和信息化局归口。 本文件起草单位：厦门畅享信息技术有限公司、厦门市标准化研究院、厦门市信息中心。 本文件主要起草人：郭劲军、郭望、傅楚隆、揭英杰、吴宸勖、陈尚峰、卢淼先、闫焕友、李童、蔡跃华、张金梅、刘姗姗、吕志仁、赖炜炜、巫晓强、杨远军、朱永上、彭明剑。 DB3502/T 056.32020 IV 引言 DB3502/T 056政务信息共享协同平台旨在确立政务信息共享协同平台总体设计、资源管理、接入要求、二次开发的技术标准，拟由四个部分构成。 第 1 部分：总体设计。目的在于确立平台关键技术路线和软件系统的组织形式，确保平台总体架构满足国家对政务信息交换与共享的要求，明确平台内主要功能模块和模块间的逻辑关系，避免“过度建设”并确保“必要建设”。 第 2 部分：资源管理。目的在于规范平台所支持的多种资源类型、协议标准、提供方式，为平台对外服务的兼容性提供保障；明确平台不同类型资源的属性，统一属性分类，为平台对外服务的通用性提供保障；针对资源生产、资源注册、资源测试、资源申请、资源调用、资源目录、资源检索、资源版本、资源安全等操作提出全生命周期管理要求，为平台对外服务的可用性提供保障。 第 3 部分：接入要求。目的在于将平台对外接口标准化，明确接口在安全性、完备性、一致性、易用性、稳定性方面要求，进一步提升平台对外提供服务的能力和质量，并从网络接入、平台资源生产方、平台资源消费方、区级平台接入等方面，明确接入的实现方式，为保障平台建设质量及拓展平台应用范围提供技术支撑。 第 4 部分：二次开发。目的在于规范平台提供二次开发的工作方式、对扩展模块管理方式，为后续平台业务流程及插件的完善提供统一标准，既避免了平台直接耦合上层各类业务，又允许不同部门结合特定业务需要，在授权范围内扩展平台功能。DB3502/T 056.32020 1 政务信息共享协同平台 第 3 部分：接入要求 1 范围 本文件规定了生产方、消费方、区级平台接入政务信息共享协同平台的技术要求。 本文件适用于政务信息共享协同平台中的生产方接入、消费方接入、区级平台接入，各部门应用系统接入时参照使用。 2 规范性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。 其中， 注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 DB3502/T 056.12020 政务信息共享协同平台 第1部分：总体设计 DB3502/T 056.22020 政务信息共享协同平台 第2部分：资源管理 3 术语和定义 DB3502/T 056.12020、DB3502/T 056.22020界定的以及下列术语和定义适用于本文件。 请求方 ID requester identity 协同平台为每个服务消费方分配的唯一标识。 服务方 ID services identity 协同平台为每个服务生产方分配的唯一标识。 融合服务 composite service 基于服务流程引擎，融合多个原子服务，实现将多个细颗粒度服务，融合为一个粗颗粒度服务。 请求接入 requester access 按照协同平台标准，服务消费方接入到本平台，并且调用其他单位服务的过程。 服务接入 services access 按照协同平台标准，服务生产方接入到本平台，对外服务的过程。 消息（用于编程语言） message(in programming languages) 对象进行其各一次运算之一的一次请求。 来源：GB/T 5217.152008，15.09.06 DB3502/T 056.32020 2 请求报文 request message 服务消费方向协同平台发出的报文。 响应报文 response message 协同平台返回给服务消费方的结果报文。 4 缩略语 下列缩略语适用于本文件。 API：应用程序编程接口（Application Programming Interface） APP：应用程序（APPlication） CPU：中央处理器（Central Processing Unit） GB：计算机存储单位，吉字节（GigaByte） HTTP：超文本传输协议（Hyper Text Transfer Protocol） ID：唯一编码（Identity Document） JSON：基于“JavaScript”语言形式的数据对象表达方式（JavaScript Object Notation） RTSP：实时流传输协议（Real Time Streaming Protocol） REST：表述性状态转移（REpresentational State Transfer） SDK：软件开发工具包（Software Development Kit） SFTP：SSH文件传输协议（SSH File Transfer Protocol） SOAP：简单对象访问协议（Simple Object Access Protocol） SSL：安全套接层（Secure Sockets Layer） TCP：传输控制协议（Transmission Control Protocol） TLS：传输层安全协议（Transport Layer Security） UDP：用户数据报协议（User Datagram Protocol） UTF-8：8位的针对Unicode的可变长度字符编码（8-bit Unicode Transformation Format） URL：统一资源定位系统（Uniform Resource Locator） WSDL：Web服务器描述语言（Web Service Description Language） XML：扩展性标识语言（eXtensible Markup Language） XSD：XML结构定义（XML Schema Definition） 5 网络链路架构 图1 网络链路架构 DB3502/T 056.32020 3 网络链路架构见图 1。分控中心应采用独立的服务器作为接入前置机，接通与总控中心服务器的网络。接入前置机和总控中心服务器、分控中心内部业务系统之间，应根据分控中心的安全需求，架设一道或多道防火墙等网络安全设备。 基本配置要求如下： a) 网络要求：局域网接入速度应大于 100 Mb/s； b) 前置机配置要求：CPU 主频不低于 1.5 GHz，核心数不少于 4 个，内存不低于 4 G，采用 Linux或自主可控操作系统； c) 部署接入前置机应由部门端和总控中心双方共同管理。前置机上主要部署分控中心所需的软件环境，不宜部署其它应用。 6 生产方接入 接入服务接口资源 6.1.1 服务接入流程 服务接入涉及到两类用户，分控管理员和总控管理员。 分控管理员登录分控中心，填写服务接口的共享资源信息，包括资源的基础信息、共享权责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。 服务接入过程中所需注册的信息包括资源类型、主题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、服务地址、服务方法名、入参配置、出参配置、资源描述、资源文档。字段含义参照DB3502/T 056.22020中5.1的说明。 6.1.2 技术要求 6.1.2.1 Web Service 接入 6.1.2.1.1 接入到平台的 Web Service 服务应满足表 1 的版本要求。 表1 Web Service 版本要求 技术点 最低版本要求 Transfer HTTP 1.1 Message Format and Protocols SOAP 1.1 or 1.2 Identity or Location WS-Addressing 1.0 Service Definition XML Schema WSDL 1.1 6.1.2.1.2 接入本平台的服务方默认只支持基本数据类型，以消除由于使用不同语言、不同框架实现Web Service 框架产生的差异。针对复杂数据结构，宜采用 XML 结构（string 类型）描述，以实现一步式接入。 6.1.2.2 REST 服务接入 服务的报文格式及交换形式满足HTTP1.0或HTTP1.1传输协议，采用GET或POST方法提起请求，采用JSON格式、XML或自定义纯文本作为请求或回应报文的载体格式。 6.1.2.3 带 TLS 的服务资源接入 DB3502/T 056.32020 4 协同平台支持采用TLS1.1及以上的版本进行传输加密的服务资源注册， 支持以下方式。 对于b)和c)方式，资源在注册过程中应提供相应的身份认证证书。 a) 不做身份认证仅加密报文。 b) 加密报文且实现请求方通过证书验证服务方，服务方不验证请求方。 c) 加密报文且请求与服务方相互验证对方身份三种安全交换方式。 接入数据文件资源 6.2.1 数据文件资源接入流程 数据文件资源接入涉及到两类用户，分控管理员和总控管理员。 分控管理员登录分控中心，填写数据文件的共享资源信息，包括资源的基础信息、共享权责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。 服务接入过程中所需注册的信息包括主题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、上传方式、资源描述、资源文档。字段含义参照DB3502/T 056.22020中5.1的说明。 6.2.2 技术要求 数据文件资源应符合以下要求，以提供稳定的数据资源共享服务： a) 文件大小单文件应不超过 2GB，如超过此限制，应使用压缩分片工具对大文件进行分割后再共享； b) 文件目录的目录层级应不超过 3 层； c) SFTP 协议传输时应将目录名、文件名指定为 UTF-8 编码格式。 接入数据库表资源 6.3.1 数据库表资源接入流程 数据库表资源接入涉及到两类用户，分控管理员和总控管理员。 分控管理员登录分控中心，填写数据库表的共享资源信息，包括资源的基础信息、共享权责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。 服务接入过程中所需注册的信息包括资源类型、主题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、数据加载方式、数据源、数据库类型、数据连接、数据库表、数据库表结构、资源描述、资源文档。字段含义参照DB3502/T 056.22020中5.1的说明。 6.3.2 技术要求 6.3.2.1 数据库类型 协同平台支持Oracle、Mysql、SqlServer等关系型数据库的数据库类型的库表资源共享。 6.3.2.2 数据库表结构 数据库表类型共享资源应符合以下要求： a) 数据库表名应不超过 30 个字符； b) 数据库表都应有唯一的主键； c) 数据库表都应有描述数据更新的时间戳字段； DB3502/T 056.32020 5 d) 数据库表的字段类型应在可共享字段类型范围内，暂不支持 CLOB、BLOB 及其他类型字段，具体见表 2。 表2 数据库表支持字段类型说明 ORACLE字段 MySQL字段 是否支持 NUMBER TINYINT 支持 SMALLINT 支持 MEDIUMINT 支持 INT或INTEGER 支持 BIGINT 支持 FLOAT 支持 DOUBLE 支持 DECIMAL 支持 YEAR 支持 DATE DATE 支持 TIMESTAMP TIME 支持 DATETIME 支持 TIMESTAMP 支持 CHAR CHAR 支持 VARCHAR2 VARCHAR 支持 CLOB TINYTEXT 暂不支持 TEXT 暂不支持 MEDIUMTEXT 暂不支持 LONGTEXT 暂不支持 BLOB TINYBLOB 暂不支持 BLOB 暂不支持 MEDIUMBLOB 暂不支持 LONGBLOB 暂不支持 其他 其他 暂不支持 接入数据流资源 6.4.1 数据流资源接入流程 数据流资源接入涉及到两类用户，分控管理员和总控管理员。 分控管理员登录分控中心，填写类型数据流的共享资源信息，包括资源的基础信息、共享权责和技术参数。所填写信息经测试通过后，提交总控中心审批。总控管理员审批通过后，其他单位可查看资源列表，并按需发起申请。 服务接入过程中所需注册的信息包括资源类型、主题信息、资源名称、资源ID、所属应用、失效日期、共享类型、共享范围、协议类型、服务IP地址、服务端口、资源描述、资源文档。字段含义参照DB3502/T 056.22020中5.1的说明。 6.4.2 技术要求 协同平台支持基于TCP、UDP类型的数据流资源共享， 如MQ、Redis、HTTP、RTSP等协议传输的资源。 DB3502/T 056.32020 6 7 消费方接入 使用服务接口资源 7.1.1 使用服务接口接入流程 7.1.1.1 消费方使用服务接口接入流程包括两步：第一步是分控管理员填写申请使用服务的信息，总控管理员审批通过后，将获得调用该服务的权限。第二步是单位的应用系统构建请求报文，调用协同平台的请求接口，获取结果数据。 7.1.1.2 申请服务所需填写的主要信息包括： a) 资源 ID：协同平台唯一表征某一共享资源的英文标签，应符合 DB3502/T 056.22020 第 5 章的要求； b) 申请 ID：用于在协同平台表征本次申请行为的唯一英文标记； 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.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 协同平台记录被调用日志时，需记录办件编码信息；调用方记录调用日志时，需记录办件编码信息。 图2 REST 风格服务资源 URL 地址说明 DB3502/T 056.32020 7 图3 凭证令牌获取 URL 地址说明 7.1.2.3 消费方基于 SDK 的接入 协同平台升级版本后， 依旧兼容旧版的SDK调用方式， 在服务请求方不改变原有调用方式的情况下，原已申请的服务资源应可继续使用。新申请的服务，宜使用REST风格的接入标准。共享服务资源调用示例见附录B。 使用数据文件资源 7.2.1 使用数据文件资源接入流程 7.2.1.1 消费方使用数据文件资源接入流程包括两步： a) 第一步：分控管理员填写信息并申请使用数据文件资源，经总控管理员审批通过后，获得调用该数据文件资源的权限； b) 第二步：消费方或消费方的应用系统通过 SFTP 协议或指定的文件接收目录，获取相应的数据文件资源。 7.2.1.2 申请数据文件资源所需填写的主要信息包括： a) 资源 ID：协同平台唯一表征某一共享资源的英文标签，应符合 DB3502/T 056.22020 第 5 章的要求； b) 申请 ID：用于在协同平台表征本次申请行为的唯一英文标记； c) 联系人：指定请求申请目标数据文件资源的联系人信息； d) 联系人电话：指定请求申请目标数据文件资源的联系人电话； e) 授权业务：指定请求申请目标数据文件资源所用的授权业务； f) 授权应用系统：指定请求申请目标数据文件资源所用的授权应用系统； g) 接收方式：指定数据文件资源的接收方式，包含 SFTP 和本地目录两种方式。SFTP 模式需提交SFTP 地址、用户名和密码，本地目录接收指定服务器的接收目录。 7.2.2 接入方式 按照申请信息中的相关要求，初始化对应的SFTP用户及目录。 使用数据库表资源 7.3.1 使用数据库表资源流程 7.3.1.1 消费方使用数据库表资源流程包括三步： a) 第一步：分控管理员填写信息并申请使用数据库表，经总控管理员审批通过后，获得使用该数据库表的权限； b) 第二步：总控管理员配置数据库交换方案，将数据同步到前置库或推送到业务库； c) 第三步：消费方按要求从前置库或本地业务库获取结果数据。 7.3.1.2 申请服务所需填写的主要信息包括： DB3502/T 056.32020 8 a) 资源 ID：协同平台唯一表征某一共享资源的英文标签，应符合 DB3502/T 056.22020 第 5 章的要求； b) 申请 ID：用于在协同平台表征本次申请行为的唯一英文标记； c) 联系人：指定请求申请目标数据库表资源的联系人信息； d) 联系人电话：指定请求申请目标数据库表资源的联系人电话； e) 授权业务：指定请求申请目标数据库表资源所用的授权业务； f) 授权应用系统：指定请求申请目标数据库表资源所用的授权应用系统； g) 同步字段：指定请求申请数据库表资源要同步的字段集； h) 接收方式：指定请求申请数据库表资源的接收方式，包含前置库读取或推送到本地业务库； i) 接收数据源：指定请求申请数据库表资源的接收数据源相关属性，包含：用户名、密码、数据库类型、字符集、数据库参数、数据库表。 7.3.2 接入方式 按照申请信息中的相关要求，初始化对应的数据库用户及库表信息。 使用数据流资源 7.4.1 使用数据流资源流程 7.4.1.1 消费方使用数据流资源流程包括两步： a) 第一步：分控管理员填写信息并申请使用服务，经总控管理员审批通过后，获得调用该服务的权限； b) 第二步：消费方的应用系统构建请求报文，调用协同平台的请求接口，获取结果数据。 7.4.1.2 申请服务所需填写的主要信息包括： a) 资源 ID：协同平台唯一表征某一共享资源的英文标签，应符合 DB3502/T 056.22020 第 5 章的要求； b) 申请 ID：用于在协同平台表征本次申请行为的唯一英文标记； c) 联系人：指定请求申请目标数据流资源的联系人信息； d) 联系人电话：指定请求申请目标数据流资源的联系人电话； e) 授权业务：指定请求申请目标数据流资源所用的授权业务； f) 授权应用系统：指定请求申请目标数据流资源所用的授权应用系统； g) 授权 IP：指定请求申请目标数据流资源授权可访问的 IP 地址。 7.4.2 接入方式 按照目标数据流资源指定的数据访问协议，访问协同平台开放的数据流资源IP端口。 8 区级平台接入 区级平台接入概述 包括区级协同平台在内的第三方应用（以下以区级平台示例），应通过接入本平台以获得各类已开放的资源。协同平台提供基于Web Service形式的开发接口。接入报文示例见附录C。 区级平台接入申请 8.2.1 区级平台接入之前，应在市政务信息共享协同平台管理系统发起接入申请。其中需要选择所需DB3502/T 056.32020 9 要协同平台给予提供的权限接口，可选范围包括： a) 我的服务接口： 获得查看区级平台向市级平台已申请的服务列表， 或区级平台已向市级平台发布的服务列表； b) 获取可申请服务接口：获得查看市级平台所有可向区级平台开放的服务目录列表； c) 发布服务接口：调用该接口，可向市级平台开放区级平台上的服务资源； d) 申请服务接口：调用该接口，可向市级平台申请区级平台所需的服务资源； e) 修改服务接口：修改已经发布到市级平台的服务接口的部分配置； f) 调用服务接口：调用已通过“申请服务接口”，并完成并通过申请的市级平台服务。 8.2.2 审核通过后，指定应用即可上线调用指定的市级平台接口。 8.2.3 应用审核通过后，应获得由市级平台自动分配给本应用的且不可更改的 App ID 和 Secret Key等属性： a) App ID：由系统生成，作为应用的唯一标识； b) Secret Key：由系统生成，用来验证应用合法性的加密串。 8.2.4 具体操作流程如下： a) 在管理页面填写基本信息，应包括：应用名称、简介，并选择待申请使用的接口范围； b) 信息填写完成并提交审核后，进入审核阶段； c) 平台管理员审核通过，可获得相应权限。 调用平台服务接口流程 8.3.1 拥有平台用户帐号和应用 App ID 和 Secret Key 后，应用应凭借二者调用资源，调用时序见图4。 8.3.2 调用平台中不需要权限的 API 时，宜直接调用，无须携带 Access Token，但仍应对参数进行签名。对于平台中需要权限的 API，第三方应用应先进行一个登陆验证，获取访问凭证 Access Token，在调用时将 Access Token 作为参数。 （平台对接接口应符合 8.5 的要求） 。 传入及返回字符集均采用 UTF-8 格式。 图4 平台服务接口调用时序 DB3502/T 056.32020 10 公共参数说明 8.4.1 平台服务调用接口公共入参表见表 3。各项入参应进行 URL 编码。 表3 平台服务调用接口公共入参表 参数名称 是否必须 类型 描述 appid 是 string 应用的唯一ID。通过appid查找APP基本信息。 sig 是 string 请求串的签名，具体签名算法见上一节第三方应用签名参数sig的说明。 format 否 string 返回值的格式。请指定为JSON或者XML，缺省值为JSON，忽略大小写 access_token 是 string 登录验证后获得的token（注：调用需权限的资源时必须，没有特别说明不需要的均需携带此参数） 8.4.2 平台服务调用公共出参表见表 4。其余业务返回参数封装在 data 字段中，由各个 API 自行定义。 表4 平台服务调用公共出参表 参数名称 描述 ret 返回码。 msg 如果错误，返回错误信息。 data 存放业务返回参数 平台对接接口 8.5.1 签名生成 在使用HTTP协议请求接口时，为了确保应用与API服务器之间的安全通信，防止Secret Key盗用，数据篡改等恶意攻击，平台API服务器使用签名机制（即sig参数）以认证应用。签名由请求参数和应用的私钥Secret Key经过MD5加密后生成的字符串构成。应用在调用平台API之前，应计算出签名，并追加到请求参数中。 8.5.2 签名算法 8.5.2.1 待签名的源串包括 3 部分内容并用“&”字符拼接：HTTP 请求方式 & urlencode(uri) & urlencode(a=x&b=y&.)。 8.5.2.2 在源串的末尾追加上应用的 Secret Key 值得到整个字符串，再对其进行 MD5 计算，得到签名的值。 8.5.2.3 下面以/user/get_info 为例描述签名算法。 a) 第一步：原始请求信息： 1) HTTP 请求方式：GET； 2) 请求的 URI 路径（不含 HOST）：/user/get_info； 3) 请求参数：appid=123456&format=json&name=jack&access_token=e123456。 b) 第二步：构造源串： 1) 将请求的 URI 路径进行 URL 编码（URI 不含 host），得到：%2Fuser%2Fget_info； DB3502/T 056.32020 11 2) 将除 “sig” 外的所有参数按 key 进行字典升序排列， 排列结果为： access_token， appid，format，name； 3) 将 2）中排序后的参数(key=value)用&拼接：access_token=e123456&appid=123456 &format=json&name=jack； 4) 进行 URL 编码 （编码时应关注 URL 编码注意事项， 否则容易导致后面签名不能通过验证） ，编码结果为：access_token%3De123456%26appid%3D123456%26format%3Djson%26name%3D jack； 5) 将 HTTP 请求方式、1）以及 3）中的到的字符串用&拼接起来，得到源串：GET&%2Fuser%2Fget_info&access_token%3De123456%26appid%3D123456%26format%3Djson%26name%3Djack。 c) 第三步：生成签名值： 1) 将源串与应用的 Secret Key 值用&拼接得到整个字符串：GET&%2Fuser%2Fget_info&access_token%3De123456%26appid%3D123456%26format%3Djson%26name%3Djack&1234567890； 2) 对其进行 MD5 计算得到生成签名值：a8c3542c4463fee08337d0ae796bb381。 注： 除非接口文档中特别标注了某参数不参与签名，否则除sig外的所有参数都参与签名。 8.5.3 登录验证接口 8.5.3.1 功能说明：获取需要授权的 Rest API 时候，需要先获取一个 access_token 作为权限资源接口调用的凭证参数。 8.5.3.2 请求方式：POST。 8.5.3.3 请求地址：/auth/token。 8.5.3.4 公共参数：发送请求时应传入公共参数。 8.5.3.5 业务参数：登录验证服务入参表见表 5。 表5 登录验证服务入参表 参数名称 是否必须 类型 描述 login_name 是 string 平台用户的登录名 pwd 是 string 经过加密的平台用户的密码。算法：原密码进行 MD5 计算后的字符串末尾追加上应用的 Secret Key 再进行一次 MD5 计算 8.5.3.6 返回参数说明：包含公共返回参数和业务返回参数。登录验证服务出参表见表 6。 表6 登录验证服务出参表 参数名称 描述 access_token 获取的 Access Token expires_in Access Token 的有效期，以秒为单位 8.5.4 退出登录接口 8.5.4.1 功能说明：退出登录的操作，注销 access_token。 8.5.4.2 请求方式：POST。 8.5.4.3 请求地址：/auth/exit。 8.5.4.4 公共参数：发送请求时应传入公共参数。 8.5.4.5 返回报文：公共参数。 DB3502/T 056.32020 12 8.5.5 表码获取接口 8.5.5.1 功能说明：获取指定表码表的值。 8.5.5.2 请求方式：GET。 8.5.5.3 请求地址：/system/get_table_code。 8.5.5.4 公共参数：发送请求时应传入公共参数。 8.5.5.5 业务参数：表码获取入参表见表 7。 表7 表码获取入参表 参数名称 是否必须 类型 描述 table_id 是 string 表码表对应表 ID 0：服务资源开发语言；1：服务资源开发框架； 2：服务资源参数类型；3：单位表码表； 4：服务组别；5：资源要素表码 8.5.5.6 返回参数说明：包含公共返回参数和业务返回参数。表码获取出参表见表 8。 表8 表码获取出参表 参数名称 描述 label 显示值 value 表码值 sort 排序 8.5.6 我的服务接口 8.5.6.1 功能说明：获取本单位发布的服务列表。第三方应用应根据服务状态和审核状态组装获取不同的服务列表。 8.5.6.2 请求方式：GET。 8.5.6.3 请求地址：/service/get_my_services。 8.5.6.4 公共参数：发送请求时应传入公共参数。 8.5.6.5 业务参数：“我的服务”调用入参表见表 9。 表9 “我的服务”调用入参表 参数名称 是否必须 类型 描述 review_status 否 string 审核状态（0：未审批；1：中心审批通过；2：提交审核；3：中心拒绝通过） ，不传则获取全部状态。 service_status 否 string 服务状态（0：未测试；1：测试通过；2：测试不通过） ，不传则获取全部状态。 service_id 否 string 服务 ID service_name 否 string 服务别名 8.5.6.6 返回参数说明：包含公共返回参数和业务返回参数。“我的服务”调用出参表见表 10。 DB3502/T 056.32020 13 表10 “我的服务”调用出参表 参数名称 描述 id 记录的主键 ID service_id 服务 ID service_name 服务别名 service_group 服务所属组 create_date 发布日期 expiration_date 失效日期 review_status 审核状态（0：未审批；1：中心审批通过；2：提交审核；3：中心拒绝通过） service_status 服务状态（0：未测试；1：测试通过；2：测试不通过） is_enabled 是否禁用（0：否；1：是；2：暂停） review_date 审核时间 service_type 服务类型（0：内置服务；1：原子服务；2：融合服务） review_opinion 审核意见 department 服务所属单位 department_cn 服务所属单位中文名 authorize_dept 授权使用单位 authorize_dept_cn 授权使用单位中文名 is_private 是否私有（0：否；1：是） develop_language 开发语言 develop_framework 开发框架 develop_framework_v 开发框架版本号 version 服务版本 instruction 服务说明 call_directions 调用说明 method 服务方法名 method_cn 服务方法名中文名称 wsdl WSDL 地址 concurrent_limit 服务并发上限 8.5.7 新增、修改服务接口 8.5.7.1 功能说明：第三方应用新增或者修改自己的服务时，应注意：已经通过审核的不允许更改，需要更改应联系总控管理员。 8.5.7.2 请求方式：POST。 8.5.7.3 请求地址：/service/save_service。 8.5.7.4 公共参数：发送请求时应传入公共参数。 8.5.7.5 业务参数：新增、修改服务入参表见表 11。 DB3502/T 056.32020 14 表11 新增、修改服务入参表 参数名称 是否必须 类型 描述 id 否 string 记录的主键 ID，当为空值时，为新增操作；有值则做修改操作 service_id 是 string 服务 ID，自定义后缀的串，平台会给添加，例如，DsWs003最终存储在平台为：XM.GOV.YZ.DS.DsWs003 service_name 是 string 服务别名 service_group 否 string 服务所属组 expiration_date 是 string 失效日期 authorize_dept 是 string 授权使用单位，英文逗号将单位 ID（单位表码表码值）分隔组成的字符串，当 is_private 为 1 时