信息化服务开放平台技术要求

2规范性引用文件 3术语和定义 4缩略语 5数据要求 5.1概述 5.2数据格式要求 25.3数据传输要求 25.4数据结构要求 26API/SDK管理要求 26.1API/SDK的发布 26.2API/SDK的使用 37平台架构 7.1整体架构 47.2客户中心 7.3API接入网关 57.4API接出网关 57.5Web服务模块 57.6API安全中心 57.7运营中心 67.8API治理平台 67.9API监控平台 67.10API组合 7.11工具集 7.12高速共享缓存 77.13数据库 8平台安全技术要求 88.1网络安全 88.2应用安全 88.3数据安全 89应用集成要求 99.1概述 9.2API架构风格 99.3SDK集成技术 99.4数据描述记录规则 99.5版本管理技术 99.6API/SDK使用流程 99.7API网关 信息化服务开放平台通用技术要求本文件规定了信息化服务开放平台各模块应具备的功能和关键指标。本文件适用于各类型组织进行信息化服务开放平台建设。2规范性引用文件本文件没有规范性引用文件。3术语和定义下列术语和定义适用于本文件。3.1开放门户openportal服务开放平台对外提供开发者接入的门户网站。3.2开发者developer服务开放平台的用户，使用服务开放平台对外发布的服务进行自身应用的开发。3.3用户user开发者的应用的使用者。4缩略语下列缩略语适用于本文件。API：应用程序编程接口(ApplicationProgrammingInterface)OCR：OCR识别(OpticalCharacterRecognition)SDK：软件开发工具包(SoftwareDevelopmentKit)5数据要求5.1概述数据要求是对外提供开放服务时，数据展现、格式、定义、结构的共识。数据要求对通过API传输的数据（消息）的语义、语法等进行了统一，为整个服务开放平台提供一种通用的交流语言。2数据要求支持数据元素的一致性，提高可信赖度的同时也降低了成本。5.2数据格式要求数据传输格式应采用JSON报文格式。5.3数据传输要求数据传输应包括公共请求数据、业务数据、数字签名、加密KEY。5.4数据结构要求数据结构应符合表1的要求。表1数据结构是是否是否是是是是否6API/SDK管理要求6.1API/SDK的发布6.1.1通则API/SDK的发布具备以下条件：a)API/SDK应经过渗透性安全测试和SDK安全加固。b)API/SDK应符合数据安全传输规范以及其他安全规范。c)API/SDK发布前具备相关测试报告，包括：1）UAT测试报告应包括测试案例和测试结果，测试过程应由专业的测试人员进行测试；2）安全测试报告宜由有安全资质的第三方测试公司出具，测试过程宜由第三方测试公司的安全人员执行。6.1.2API/SDK设计要求移动端SDK的设计要求应分为没有集成控件的基础移动端SDK和在基础移动端SDK上额外集成各种安全控件的扩展移动端SDK。例如，集成了OCR识别、人脸识别、活体检测等控件的扩展移动端SDK。API的设计要求应包括：a)API的可复用性，API的划分考虑多场景的复用；b)API的可组合性，API的划分考虑可以被组合为新服务场景；c)API的完备性，API具备完整的业务功能。6.1.3API/SDK开发要求API/SDK开发应关注业务流程，避免业务流程安全漏洞。6.1.4API/SDK维护要求API/SDK应定期进行优化和维护，通过监控API的使用情况，发现API的优化线索，包括：a)API的响应时间是否达到设计要求；b)API的调用成功率是否达到业务要求；c)API的超时时间是否达到业务要求。6.2API/SDK的使用6.2.1概述API/SDK使用时能保证使用者身份是经过认证、且避免不同身份的开发者共用一个接入密钥，API/SDK的使用能明确身份，服务开放平台能够严格控制API/SDK使用者身份。6.2.2API/SDK申请流程开发者通过开放门户注册、实名认证后申请使用企业的产品服务。流程应包括：a)开发者注册并登陆开放门户；b)开发者类型应支持个人开发者和企业开发者；c)企业运营人员审核开发者注册；d)开发者创建应用，申请服务；e)企业运营人员审核应用；f)开发者发布应用，并在沙箱环境测试；g)开发者应用上线，接入生产环境。具体流程见图1。图1API/SDK申请流程46.2.3开发者认证模式概述服务开放平台支持基于OAuth2.0模式的集中管理授权和认证信息，当某个第三方应用使用企业的用户体系进行登录时，需要经过系统的安全模块，进行授权认证，获取临时code，根据临时code获取token，并通过token交换用户信息，包括头像、昵称等信息。认证开发者在开放门户上申请应用后，开放门户会为该应用生成appKey和appSecKey；开发者可以在开放门户上进行API的申请，服务开放平台后台会有相关的审核功能，审核通过后，获得API的访问权限，该权限检验基于appKey完成。开发者应用APP和服务开放平台的认证顺序见图2。在用户发起API请求时，应有如下权限认证：a)认证appKey的所属开发者是否经过了实名认证和用户签约；b)认证appKey所对应的应用是否经过了审核；c)认证appKey所对应的token是否准确，并处于有效期内；d)认证appKey所对应的开发者，对该API是否具有访问权限。APPAPP请求终止请求终止请求终止请求终止请求终止实名认证校验用户签约校验应用审核认证Token认证NNNNNAPI权限认证开放平台图2应用授权认证流程7平台技术架构7.1整体架构整体架构见图3。5接入层接入层Java-SDKIOS-SDKAndroid-SDKH5-SDKClientAPI治理(见7.8)API日志监控(见高速共享缓存(见7.12)软负载均衡灰度发布块(见7.5)运营中API接出网API接入网客户中安全中心工具集图3整体架构7.2客户中心客户中心应支持在IE、Firefox、GoogleChrome等主流浏览器上稳定运行，并支持向下兼容。采用前后端分离开发模式和部署架构，后端支持微服务，前端支持动态编译技术。客户中心应提供一系列文档、场景、工具的使用手册，帮助开发者快速熟悉API功能和使用方法，并提供注册和申请的流程。者集成流程及指引、产品信息展示、广告和新闻发布、业务场景介绍、产品发布、知识库等内容。向开者注册、应用创建、产品申请，支持产品业务交易数据统计、业务订单查询、对账文件下载、开放平台SDK下载、产品API文档查看等功能。7.3API接入网关API接入网关是服务开放平台中最核心最基础的运行态功能实现平台。应支持方便整合开源框架。主要包含服务发布、协议转换、安全控制、报文转换、服务路由等技术集成功能，为API的调度提供安全、稳定、可靠的运行环境。7.4API接出网关API接出网关应包含两方面功能，首先是用于整合外部合作企业的服务以完善产品功能；其次是用于行内系统通知第三方企业，具体业务有异步服务处理完成后通知合作用户结果、以及其他主动通知交易。API接出网关应支持协议与网络地址的适配和转义功能，支持服务的异步回调通知功能，支持异常网络请求的记录与处理功能，API接出网关功能可与API接入网关功能一致。7.5Web服务模块Web服务模块支持加载发布H5静态资源，应提供分目录、分资源进行动态加载，并且实时生效的功能。7.6API安全中心API安全中心应为企业服务的发布、开放、运行提供一整套安全解决方案。包括安全管理控制台功能、APP安全控制功能、OAuth2.0功能、限流管理功能、安全数据服务功能。6a)安全管理控制台功能应包括：1）证书管理，提供证书的生成、存储、下发、更新、上传；2）密钥管理，密钥的上传、生成、重置；3）开发者权限管理，提供开发者的权限控制管理。b)APP安全控制功能应包括：1）SDK授权认证，提供SDK的授权认证；2）SDK信息管理，提供SDK签名、版本管理。c)OAuth2.0功能应包括：1）授权码，提供授权码的获取和超时管理；2）token管理，提供token的生成、存储、更新管理；3）授权，提供基于token的授权管理；4）认证，提供基于token的认证管理。d)限流管理功能应包括：1）维度控制，提供多维度的限流控制；2）令牌管理，提供灵活的令牌管理体系；3）统计分析，提供在线实施统计分析功能；4）参数调整，提供在线参数调整并实时生效。e)安全数据服务功能应包括：1）国密算法加解密，提供基于国密算法的加密解密；2）数字信封加解密，提供基于数字信封的加密解密；3）MD5加签验签，提供基于MD5算法的加签验签；4）RSA加签验签，提供基于RSA算法的加签验签；5）HMAC_SHA1加签验签，提供基于HMAC_SHA1算法的加签验签；6）数据脱敏，提供敏感数据的脱敏传输；7）数据还原，提供敏感数据的脱敏还原。7.7运营中心运营中心应为企业运营人员提供图像友好、操作便捷、功能强大的管理控制台，并提供权限管理功能；基于该平台，运营人员可以对开发者进行身份校验审核、创建应用审核、证书审核、申请服务调用审核、合作方回调地址审核管理、用户冻结和解冻管理、应用参数管理等功能，对参数的调整以及动态信息的实时发布、权限管理、日志审计等；并提供报表分析功能和管理认证功能。7.8API治理平台API治理平台应包括API的定义、发布、审批，对API生命周期的管理、对元数据的管理，应与客户中心（开发者门户）联动，API治理正式发布的服务可以通过开发者门户进行查询。注：API治理平台是基于元数据的服务定义、描述、映射、检索、治理系统，以提升组织业务能力为导向的工7.9API监控平台API监控平台应对应用系统的资源、应用服务器、数据库服务器、系统运行、服务和产品运行、业务系统、合作商户进行监控，并提供报表查询和下载。API监控平台监控和提供的内容应包括：a)API监控平台提供系统资源运行情况；7b)API监控平台提供服务运行监控功能情况；c)API监控平台提供各时段服务运行情况的统计报表；d)API调用流水查询功能包括对所有API网关进行的交易流水进行查询，支持多种查询条件，如流水号、时间段、时间点、交易状态、交易返回码等；e)支持图形、邮件、短信的告警功能，并支持告警阈值的自定义设置。7.10API组合为了进一步整合企业内部资源、减少企业内外的交互次数、提高交互效率，系统应对原始服务（接口）进行一定程度的组合。应用系统宜支持多种API的组合方式，典型的类型如下：——串行组合：成员服务顺序执行；——并行组合：成员服务并发执行；——服务分发：成员服务根据条件选择执行，多个成员服务选择其中一个执行；——条件组合：成员服务根据条件选择执行，多个成员服务可能执行、不执行、执行一部分；——并行转串行：两个（或多个）的成员服务存在依赖关系，在不同时参与组合时，可以与其他成员服务并行执行；但是这两个（或多个）成员服务，同时参与组合时，顺序执行；——业务数据查询补填：成员服务的执行需要依赖于其他查询类成员服务的结果；——批量转单笔多次：存在依赖关系的成员服务之间，一个是多条数据一次发送，一个一次仅能处理单条数据；——自动冲正：成员服务应搭配相应的冲正服务，有组合服务在异常时调用，保障数据一致性；——存储转发，定时调用：需要存储相关数据，定时调用成员服务。7.11工具集服务开放平台在建设过程中，提供配套解决系统快速开发，快速集成的管理工具集。工具集宜包括下列内容：——挡板，提供高性能、配置化的挡板供测试使用；——发送报文模拟器，提供可以在线测试的发送报文模拟器；——回归测试工具，支持在准备好测试报文的情况，通过工具进行自动化测试。支持单个服务和多个服务的自动化测试。此工具作为开发工具插件，可用来进行回归测试；——集成开发平台IDE，提供用于敏捷开发的开发平台IDE；——自动化部署工具，提供在线版本发布与部署功能，保证在集群部署的架构模式下，简化版本部署流程，提升版本部署效率；——沙箱环境，沙箱环境提供开发者接入前的联调测试，沙箱环境测试通过后接入正式生产环境。7.12高速共享缓存高速共享缓存用来保证服务的更新频次以及产品的灵活个性，同时为保证安全，必要的验证数据具备随机性和临时性，也需要高速共享缓存存储，功能应包括：a)集群或者分布式的部署方式，避免单点故障后，导致服务停止；b)缓存中的数据丢失后不会导致无法对用户提供服务；c)高速缓存需要具备相应的内存、状态等的监控告警。7.13数据库服务开放平台的数据持久化要求包括：8a)数据应采用分布式数据库，条件尚不成熟的情况下，数据库应具备集群服务的能力；b)面向互联网服务的数据库宜读写分离，流水表宜分表或分库实现；c)面向互联网提供入口服务功能的应用宜能够脱离数据库提供服务。8平台安全技术要求8.1网络安全建立安全的网络与内容交换的通道，应包括：a)网络防火墙：采用双层网络防火墙进行保护，分别是互联网区和DMZ区设置一道防火墙，DMZ区和应用区设置一道防火墙，设置防火墙网络安全策略，确保网络流量的合法性；b)网络隔离区：使用DMZ网络隔离区，设立一个非安全系统与安全系统之间的缓冲区，有效保护内部网络区域的应用安全；c)网络安全设备：借助SSL加速器和防火墙等网络安全设备实现SSL加速、应用攻击过滤以及拒绝服务(DoS)攻击等安全防御功能；d)转发代理：基于资源访问路径的负载路由，可以选择性的将内网应用的接口对外进行暴露。8.2应用安全应用系统应提高应用的安全开发设计能力，提升服务开放平台安全架构能力，在系统架构层面防护大部分攻击行为，并经严格的代码审核，保证产品的安全性。应用安全应包括：a)权限控制，针对不同的平台用户设定不同的角色和权限，不同的平台用户登录展示不同的菜单b)身份验证识别，开放门户支持身份验证识别；c)口令加密，提供加密控件的登录方式，严格保护开发者的密码，防止泄露；d)登录超时控制，开发者登录开放门户30min内无操作，系统强制开发者退出，终端用户会话保持，当开发者再次使用的时候，需要重新登录。8.3数据安全8.3.1加签验签对应用系统的数据请求应经过加密和加签处理，以验证数据是否被篡改，并防止数据被拦截、泄露。数据加签验签方法应符合国家密码管理部门及行业主管部门要求。注：通过数字签名技术，可以有效防止数据被8.3.2加密解密应用系统应具备完善的数据加密及传输加密机制，整个系统数据传输的各个环节无明文数据。为了防止数据在传输过程中被拦截获取，应用系统应提供数据的加密规则和算法。数据加密解密方法应符合国家密码管理部门及行业主管部门要求。8.3.3数据脱敏应用系统与第三方平台在进行数据交互时，涉及到企业内部用户隐私数据的请求，应采用数据脱敏和脱敏还原机制，保障用户的个人信息不被泄露。脱敏还原方法应采用把需脱敏数据进行加密或者移位置换后加密的方法实现，保证脱敏算法不被泄露，加密应采用国密算法或者行政主管部门要求的加密处理方法。9脱敏还原的数据应包括：a)手机号；b)身份证号码；c)卡号；数据脱敏处理过程见图4。APIAPI请求脱敏还原AP