CN112612461A - 一种erp系统中统一管理和发布安全api接口的方法 - Google Patents

Abstract

本说明书实施例公开了一种ERP系统中统一管理和发布API接口的方法。该方法包括：在公共云端统一注册入口注册接口服务，将所述接口服务引入本地私有环境进行所述接口服务本地注册，由本地注册的所述接口服务发布供外部调用的API接口，生成格式统一的在线文档；接收根据所述在线文档编写的调用所述API接口的请求，对所述请求进行预处理；根据所述预处理后的所述请求，由所述API接口返回所述请求对应的信息。

Description

一种ERP系统中统一管理和发布安全API接口的方法

技术领域

本说明书涉及信息管理技术领域，尤其涉及一种企业资源计划(EnterpriseResource Planning，ERP)系统中统一管理和发布安全应用程序接口(ApplicationProgramming Interface，API)的方法。

背景技术

传统的ERP系统，经常面临与其他业务系统的数据集成，需做大量的接口进行交互，一般采用主流的超文本传输协议(HyperText Transfer Protocol，HTTP)方式进行通信，接口开发人员开发异构系统调用的接口时，经常只关注业务处理本身而忽视了接口的安全，或者只采用基本的用户密码安全方式做安全保证，存在被恶意调用攻击的隐患；开发人员的业务处理程序与接口过度耦合，经常是一套程序对应一个接口，或者采用不统一的业务参数进行分支判断来应对一套程序对应多个接口的场景；不同的开发人员编写接口文档有自己的风格，很难形成统一的文档规范，导致同一个产品不同人员开发的接口文档格式不统一。

基于此，需要能够实现在ERP系统中API接口技术统一、安全机制统一的方法，保证统一管理及标准化复用。

发明内容

本说明书一个或多个实施例提供一种ERP系统中统一管理和发布安全API接口的方法。用以解决如下问题：在现有ERP系统中，API接口技术不统一，安全机制不统一，无法做到统一管理及标准化复用的问题。

为解决上述技术问题，本说明书一个或多个实施例是这样实现的：

本说明书一个或多个实施例提供的一种ERP系统中统一管理和发布安全API接口的方法，包括：

在公共云端统一注册入口注册接口服务，将所述接口服务引入本地私有环境进行接口服务本地注册，由本地注册的所述接口服务发布供外部调用的API接口，生成格式统一的在线文档；

接收根据所述在线文档编写的调用所述API接口的请求，对所述请求进行预处理；

根据所述预处理后的所述请求，由所述API接口返回所述请求对应的信息。

提供统一的接口服务注册入口，保证了接口能够有效收集和管理，对调用API接口的请求做预处理，统一做安全及身份认证，能够在ERP系统中做到统一管理和标准化复用。

可选地，所述由本地注册的所述接口服务发布供外部调用的API接口，具体包括：

通过所述接口服务设置不同的路由参数发布供外部调用的多个所述API接口。

通过接口服务能够发布一个或多个API接口，保证多个API接口能够统一管理。

可选地，所述通过所述接口服务设置不同的路由参数发布供外部调用的多个所述API接口，具体包括：

所述接口服务指定所述路由参数的名字和个数，不同的所述路由参数对应不同的所述API接口。

可选地，所述生成格式统一的在线文档，具体包括：

定义在线文档模板，根据所述API接口将文档要素信息写入所述在线文档模板中。

可选地，所述根据所述API接口将文档要素信息写入所述在线文档模板中，具体包括：

提供动态参数获取机制，注册参数获取服务构件，通过所述参数获取服务构件获取参数信息，将包含所述参数信息的所述文档要素信息写入在线文档模板中。

可选地，所述接收根据所述在线文档编写的调用所述API接口的请求，对所述请求进行预处理，具体包括：

对所述请求进行安全及身份认证，确认所述请求是否合法。

可选地，所述对所述请求进行安全及身份认证，确认所述请求是否合法，具体包括：

根据所述请求对调用方进行登记，分配一个唯一账号和随机密码。

可选地，将所述随机密码与所述请求的部分信息进行组合，使用签名算法对所述随机密码与所述请求的部分信息的组合进行签名，将生成的签名信息作为所述请求的一部分。

可选地，对所述签名信息进行校验；

若所述签名信息合法，将所述签名信息中的时间戳信息与系统时间对比，确定所述请求的有效时间。

防止非法伪造和篡改请求信息，通过确认请求的有效时间，确保即使第三方恶意捕获了请求，也无法使用该请求信息一直进行接口调用。

可选地，所述根据所述预处理后的所述请求，由所述API接口返回所述请求对应的信息，具体包括：

将所述API接口根据所述预处理后的所述请求返回的信息进行标准化封装，统一返回格式；

将经过标准化封装，统一返回格式的所述信息返回给所述调用方。

本说明书一个或多个实施例采用的上述至少一个技术方案能够达到以下有益效果：在ERP系统中，API接口技术统一、安全机制统一、在线文档格式统一，有利于ERP系统的统一管理和标准化复用。

附图说明

为了更清楚地说明本说明书实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本说明书中记载的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。

图1为本说明书一个或多个实施例提供的一种ERP系统中统一管理和发布安全API接口的方法的流程示意图；

图2为本说明书一个或多个实施例提供的一种平台整体架构示意图；

图3为本说明书一个或多个实施例提供的一种统一注册入口注册接口服务示意图；

图4为本说明书一个或多个实施例提供的一种发布多个API接口的示意图；

图5为本说明书一个或多个实施例提供的一种接口URI地址格式的示意图；

图6为本说明书一个或多个实施例提供的一种API信息定义界面示意图；

图7为本说明书一个或多个实施例提供的一种在线文档界面示意图。

具体实施方式

本说明书实施例提供一种ERP系统中统一管理和发布安全API接口的方法。

为了使本技术领域的人员更好地理解本说明书中的技术方案，下面将结合本说明书实施例中的附图，对本说明书实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本申请一部分实施例，而不是全部的实施例。基于本说明书实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都应当属于本申请保护的范围。

本说明书一个或多个实施例提供的一种ERP系统中统一管理和发布安全API接口的方法通过本地私有环境引入经过统一接口服务注册入口注册的接口服务，由公共服务平台统一处理安全及身份认证以及生成格式统一的在线文档，可以实现对接口的统一管理及标准化复用。自动生成统一风格的在线文档，保证文档与程序的统一，提供便捷的在线调试工具，开发完成即可在线调试，统一做安全及身份认证，识别调用方的信息保证接口安全。

传统的ERP系统，一般是私有化部署，各个项目开发接口一般仅是部署在本地，而在本说明书的一个或多个实施例中，分为公共云端和本地私有环境，公共云端提供统一的接口服务注册入口，接口进行统一注册登记，本地私有环境引入该接口服务，根据自身需要发布API接口。

以下结合附图，详细说明本说明书各实施例提供的技术方案。

图2为本说明书一个或多个实施例提供的一种平台整体架构示意图；

在本说明书的一个或多个实施例中平台整体架构分为五层：接口服务层、API层、公共服务层、公共网关层、工具服务层。

其中，接口服务层为图2中最下方所示的注册接口服务，接口开发者开发符合规范的接口逻辑构件，在接口服务层的统一注册入口进行注册，生成接口服务，接口服务层在公共云端部分，本地私有环境能够引入由公共云端部分生成的接口服务。

API层为图2中API接口(获取客户档案接口、获取物料接口、生成销售订单接口、生成库存单据接口……)，在私有环境引入由公共云端部分生成的接口服务后，由接口服务发布供外部调用的API接口。

公共服务层为用于对调用接口的请求做预处理，在图2中所示为安全认证、接口路由、授权验证。

公共网关层在图2中所示为公共网关接收外部请求(HttpHandler)，用于接收外部调用接口的请求，将API接口返回的信息进行标准化封装统一返回格式返给调用方。

工具服务层在图2中所示为日志服务、API在线文档、API在线调试等，提供用于特定用途的工具服务或工具应用，能够自动生成API在线文档，实时日志收集，提供API在线测试功能。

图1为本说明书一个或多个实施例提供的一种ERP系统中管理和发布安全API接口的方法的流程示意图。

S101：在公共云端统一注册入口注册接口服务，将所述接口服务引入本地私有环境进行所述接口服务本地注册，由本地注册的所述接口服务发布供外部调用的API接口，生成格式统一的在线文档；

通过接口服务设置不同的路由参数发布供外部调用的多个API接口。

接口服务指定路由参数的名字和个数，不同的路由参数对应不同的API接口。

传统的ERP系统，一般是私有化部署，各个项目开发的接口一般仅是部署在本地，随着时间的积累，项目开发接口越来越多，接口应用技术和形式也无法统一，想要收集各个项目开发接口情况非常困难，在本说明书的一个或多个实施例中，在公共云端的统一注册入口注册接口服务，所有项目接口统一注册登记，本地私有环境引入在公共云端统一注册入口注册的接口服务，本地私有环境无法对引入的接口服务进行新增和修改操作，保证了本地私有环境中的接口服务的统一，有利于接口的收集和管理。在本地私有环境引入在公共云端统一注册入口注册的接口服务后，根据自身需要，由接口服务发布一个或多个API接口。例如需要获取客户档案和物料，则发布获取客户档案接口和获取物料接口，若仅仅需要生成销售订单，则发布生成销售订单接口。在本地注册的接口服务发布供外部调用的API接口后，由工具服务层生成格式统一的在线文档。

如图3所示为本说明书一个或多个实施例提供的一种统一注册入口注册接口服务示意图。

其中，接口服务界面包括基本信息、入参相关、出参相关、路由参数等。接口服务的基本信息包含接口服务的编号、接口服务名称、接口性质、请求方法、状态、统一资源标识符(Uniform Resource Identifier，URI)、程序集、接口描述等信息。路由参数包括参数名、参数说明、赋值时机、顺序号等信息。

在本说明书的一个或多个实施例中，注册接口服务的核心是注册业务处理程序，合法的接口服务处理程序均需继承和实现平台统一的Interface：

在本说明书的一个或多个实施例中，API接口可以为HTTP接口、Web Service接口等，每个API接口对应唯一URI资源路径，一个接口服务可以通过设置不同的路由参数发布多个API接口。例如，注册一个根据时间戳通过数据模型获取数据的接口服务，具体调用的模型身份标识号(Identity Document，ID)作为路由参数，针对每个模型ID可以发布一个API接口，如针对往来单位模型ID可发布一个获取往来单位数据接口，针对生成数据模型ID可发布一个获取生成数据的接口，可以同时针对2个、3个或多个模型ID发布对应的2个、3个或多个接口。

定义在线文档模板，根据所述API接口将文档要素信息写入所述在线文档模板中。

提供动态参数获取机制，注册参数获取服务构件，通过所述参数获取服务构件获取参数信息，将包含所述参数信息的所述文档要素信息写入在线文档模板中。

若通过接口服务发布供外部调用的一个API接口，将出入参信息写入接口服务定义；

若通过接口服务发布供外部调用的多个API接口，提供动态参数获取机制。

传统的接口开发方式一般是先定义好接口，再实现相关逻辑，业务逻辑代码与接口是完全耦合在一起，限定了该业务逻辑代码的应用范围。在本说明书的一个或多个实施例中，将承载业务逻辑的程序与实际调用的接口进行解耦，也就是接口服务与API解耦，一个接口服务通过定义不同的路由参数发布不同的API。

如图4为本说明书一个或多个实施例提供的一种发布多个API接口的示意图。

在本说明书的一个或多个实施例中，由开发者开发的符合规范的接口逻辑构件经公共云端的统一注册入口注册后形成接口服务，本地私有环境对引入接口服务进行本地注册，本地注册后的接口服务通过定义不同的路由参数发布多个不同的API。

在本说明书的一个或多个实施例中，不同的路由参数对应着不同的API，在API发布时进行指定路由参数值，接口服务指定路由参数的名字和个数。

如图5为本说明书一个或多个实施例提供的一种接口URI地址格式的示意图。

一个完整的接口URI地址包括应用路径、接口平台路径、注册服务、路由参数四个部分。

在本说明书的一个或多个实施例中，路由参数值在发布API时具体指定，例如图5中的{modelid}/{dataid}为路由参数，其中路由参数也可以为{datacode}，与路由参数{modelid}/{dataid}或{datacode}对应的具体的路由参数值在发布API是具体指定。

如图6为本说明书一个或多个实施例提供的一种API信息定义界面示意图。

在本说明书的一个或多个实施例中，API信息定义界面包括基本信息、其他信息、路由参数、授权APP等，其中基本信息包括接口服务编号、接口服务名称，服务URI、API名称、状态、API URI等，例如接口服务名称为开放数据接口服务，API名称为API数据获取，服务URI地址为/cwbase/osso/wapi/ossi_opendata/{datacode}，API URI地址为/cwbase/ossi/wapi/ossi_opendata/openapidata，其中接口服务URI地址中的{datacode}为路由参数，API URI地址中的openapidata为发布API时具体指定的路由参数值。

在本说明书的一个或多个实施例中，在发布API时，接口服务可以指定路由参数的名字和个数。例如，如图6中的路由参数信息中，包括参数datacode、参数序号1、参数说明开放数据定义编号、参数值openapidata、备注等，除此之外可以根据具体情况指定另外的路由参数，如{modelid}/{dataid}，在路由参数信息里面参数栏将出现datacode以及{modelid}/{dataid}，参数序号分别为1和2，同样的，还可以指定第三个路由参数，在此不做具体限定。

对外发布的接口一般都要附带调用文档说明，而接口程序的调整往往也需要对文档进行更新，传统ERP接口开发过程中往往使用线下文档，随着文档变更次数的增加，经常会出现调用方拿到的文档与实际程序不一致的情况，且不同的开发人员编写的文档模式差异较大，给异构系统开发人员调用接口造成较大的困扰，影响接口调试周期。

在本说明书的一个或多个实施例中，在本地注册的接口服务发布供外部调用的API接口时，工具服务层会自动生成格式统一的在线文档信息，保证文档格式统一，确保文档版本与接口定义一致。

在本说明书的一个或多个实施例中，在线文档包括接口地址、入参描述、出参描述，入参信息提供样板数据和字段说明表格，根据在线文档中包含的接口地址、入参描述、出参描述等信息定义一个统一的模板，根据各个接口的不同将具体内容填充到模板中。

接口开发人员定义接口的说明信息有两种方式，一种为单一应用的接口服务，一种为复杂的接口服务。其中单一应用的接口服务为一个接口服务对应一个API的情况，此时，可以直接将如入参描述写入接口服务定义的说明信息中。复杂的接口服务为一个接口服务发布多个API接口，不同的API接口出入参描述不同的情况，此时，本说明书的一个或多个实施中提供动态参数获取机制，接口开发人员注册对应的参数获取服务构件，平台在解析接口参数信息时通过调用该构件进行获取参数信息。在ERP系统中有数据建模平台，在动态参数获取服务构件中通过动态解析建模数据，可以实现同一个接口服务处理不同的建模数据。动态参数获取服务均需实现平台相应的Interface：

如图7为本说明书一个或多个实施例提供的一种在线文档界面示意图。图7的左侧为导航栏，包括各个API接口的在线文档信息导航，以API数据获取(测试视图表)为例，在线文档界面中包含接口地址、接口概述、接口认证、路由参数以及路由参数的表格说明、业务入参说明、业务入参模板、业务入参字段说明、接口返回、业务返回说明、业务返回模板、业务失败模板、业务返回字段说明等信息。其中业务入参字段说明以及业务返回字段说明包括字段名、字段描述、是否为空、字段类型和其他说明。业务入参说用于数据查询过滤，业务返回是获取的数据集合。

S102：接收根据所述在线文档编写的调用所述API接口的请求，对请求进行预处理；

对请求进行安全及身份认证，确认请求是否合法。

根据请求对调用方进行登记，分配一个唯一账号和随机密码。

将所述随机密码与所述请求的部分信息进行组合，使用签名算法对所述随机密码与所述请求的部分信息的组合进行签名，将生成的签名信息作为所述请求的一部分。

对所述签名信息进行校验；

若所述签名信息合法，将所述签名信息中的时间戳信息与系统时间对比，确定所述请求的有效时间。

API接口是供外部系统调用，可靠的安全机制是整个系统的安全保障，传统的ERP系统项目开发过程中经常忽视API接口安全的重要性，经常采用较简单的密码方式保障系统安全，甚至不做任何安全认证，较为规范的安全认证往往需要做一些负载的开发工作，耽误项目进度。

在本说明书的一个或多个实施例中，将由平台对调用API接口的请求统一做安全及身份认证，确保请求合法之后再对接口进行调用，获取相关数据，保证API接口的安全。公共网关层接收外部调用API接口的请求，在公共网关层中调用公共服务层对请求进行安全及身份认证，经过安全及身份认证的请求在调用本地私有环境的API接口。

在本说明书的一个或多个实施例中，采用AppCode+SecretKey使用签名算法对数据进行签名的方式保证API接口的安全。

系统提供第三方App登记功能，每登记一个第三方App，分配一个唯一AppCode和一个随机生成的SecretKey，AppCode相当于第三方App调用API接口的账号，SecretKey相当于与账号相对应的密码。将密码SecretKey与请求中的部分信息进行组合，并对密码SecretKey与请求中的部分信息的组合用指定签名算法进行签名，生成签名信息。签名算法可以为信息摘要算法5(Message Digest Algorithm 5，MD5)、安全散列算法1(Secure HashAlgorithm 1，SHA-1)、安全散列算法2(Secure Hash Algorithm 2，SHA-2)等。

将生成的签名信息作为请求信息的一部分，对签名信息进行校验，就是对请求信息做安全及身份认证，若签名信息校验不通过，则请求信息为非法的，通过采用AppCode+SecretKey使用签名算法对数据进行签名的方式防止非法伪造和篡改请求信息，保证API接口的安全，SecretKey不在请求中传输也有效避免被人获取。

在本说明书的一个或多个实施例中，将密码SecretKey与请求中的部分信息进行组合，并对密码SecretKey与请求中的部分信息的组合用指定签名算法进行签名，签名时包含时间戳信息，对签名信息进行校验时会比对时间戳与系统时间，若时间戳的时间与系统时间相差超过一定值，请求无效，例如时间戳的时间与系统时间相差5分钟、10分钟等，请求无效，确保请求在5分钟、10分钟内有效，具体的有效时间可以自定义。若请求被恶意捕获，超过了请求的有效时间，恶意捕获请求的一方也无法使用该请求对API接口调用。保证了API接口的安全。

S103：根据预处理后的请求，由API接口返回请求对应的信息。

将所述API接口根据所述预处理后的所述请求返回的信息进行标准化封装，统一返回格式；

将经过标准化封装，统一返回格式的所述信息返回给所述调用方。

调用方发送请求调用API接口，对调用API接口的请求进行安全认证，根据通过安全认证的请求，公共网关层调用公共服务层相关服务后通过路由得到API接口信息，调用相应接口服务构件进行业务处理，对API接口返回的信息进行标准化封装，统一返回格式，将经过标准化封装，统一返回格式的信息返回给调用方。API接口返回的信息先经过公共网关层，经由公共网关层将API接口返回的信心进行标准化封装，统一返回格式，将经过标准化封装，统一返回格式的信息返回给调用方。

本说明书一个或多个实施例提供的一种ERP系统中统一管理和发布安全API接口的方法通过将公共云端与本地私有环境区分，在公共云端对接口服务以及调用API的请求做统一化操作，在本地私有环境引入公共云端注册的接口服务，根据自身需要发布API接口，实现了接口的统一管理和标准化复用。

上述对本说明书特定实施例进行了描述。其它实施例在所附权利要求书的范围内。在一些情况下，在权利要求书中记载的动作或步骤可以按照不同于实施例中的顺序来执行并且仍然可以实现期望的结果。另外，在附图中描绘的过程不一定要求示出的特定顺序或者连续顺序才能实现期望的结果。在某些实施方式中，多任务处理和并行处理也是可以的或者可能是有利的。

以上所述仅为本说明书的一个或多个实施例而已，并不用于限制本说明书。对于本领域技术人员来说，本说明书的一个或多个实施例可以有各种更改和变化。凡在本说明书的一个或多个实施例的精神和原理之内所作的任何修改、等同替换、改进等，均应包含在本说明书的权利要求范围之内。

Claims (10)

1.一种ERP系统中统一管理和发布安全API接口的方法，其特征在于，包括：

在公共云端统一注册入口注册接口服务，将所述接口服务引入本地私有环境进行所述接口服务本地注册，由本地注册的所述接口服务发布供外部调用的API接口，生成格式统一的在线文档；

接收根据所述在线文档编写的调用所述API接口的请求，对所述请求进行预处理；

根据所述预处理后的所述请求，由所述API接口返回所述请求对应的信息。

2.根据权利要求1所述的方法，其特征在于，所述由本地注册的所述接口服务发布供外部调用的API接口，具体包括：

通过所述接口服务设置不同的路由参数发布供外部调用的多个所述API接口。

3.根据权利要求2所述的方法，其特征在于，所述通过所述接口服务设置不同的路由参数发布供外部调用的多个所述API接口，具体包括：

所述接口服务指定所述路由参数的名字和个数，不同的所述路由参数对应不同的所述API接口。

4.根据权利要求1所述的方法，其特征在于，所述生成格式统一的在线文档，具体包括：

定义在线文档模板，根据所述API接口将文档要素信息写入所述在线文档模板中。

5.根据权利要求4所述的方法，其特征在于，所述根据所述API接口将文档要素信息写入所述在线文档模板中，具体包括：

提供动态参数获取机制，注册参数获取服务构件，通过所述参数获取服务构件获取参数信息，将包含所述参数信息的所述文档要素信息写入在线文档模板中。

6.根据权利要求1所述的方法，其特征在于，所述接收根据所述在线文档编写的调用所述API接口的请求，对所述请求进行预处理，具体包括：

对所述请求进行安全及身份认证，确认所述请求是否合法。

7.根据权利要求6所述的方法，其特征在于，所述对所述请求进行安全及身份认证，确认所述请求是否合法，具体包括：

根据所述请求对调用方进行登记，分配一个唯一账号和随机密码。

8.根据权利要求7所述的方法，其特征在于，所述方法还包括：

将所述随机密码与所述请求的部分信息进行组合，使用签名算法对所述随机密码与所述请求的部分信息的组合进行签名，将生成的签名信息作为所述请求的一部分。

9.根据权利要求8所述的方法，其特征在于，所述方法还包括：

对所述签名信息进行校验；

若所述签名信息合法，将所述签名信息中的时间戳信息与系统时间对比，确定所述请求的有效时间。

10.根据权利要求1所述的方法，其特征在于，所述根据所述预处理后的所述请求，由所述API接口返回所述请求对应的信息，具体包括：

将所述API接口根据所述预处理后的所述请求返回的信息进行标准化封装，统一返回格式；

将经过标准化封装，统一返回格式的所述信息返回给所述调用方。

Images