CN108200077B - 一种调用接口的方法及装置 - Google Patents

Abstract

本发明提供一种调用接口的方法及装置，获取待调用接口的标识，根据所述标识，获取所述标识对应的接口协议，根据所述接口协议，调用所述待调用接口。当存在多个合作方时，即存在多个待调用接口时，针对不同的待调用接口，通过获取待调用接口的标识而获取到此待调用接口的接口协议，并根据接口协议调用此待调用接口。实现了同时兼容调用多个不同合作方接口的功能，而不用针对不同的合作方重复开发与合作方接口协议相匹配的接口，解决了现有技术中开发人员根据不同的接口协议重复开发接口导致的工作量大的问题。

Description

一种调用接口的方法及装置

技术领域

本发明属于网络管理中的接口技术，尤其涉及一种调用接口的方法及装置。

背景技术

网络平台之间通过调用接口来实现数据的交互。在开发接口时，通常按照甲方(合作方)的接口协议，开发乙方(我方)的接口，进而使得开发的乙方接口与甲方接口相匹配，通过调用接口实现甲方和乙方的交互。

但是，当存在多个不同的甲方时，由于不同甲方的接口协议可能不同，不能按照多个不同的接口协议同时开发一个乙方接口，因此调用不同的甲方接口时都需要重新开发一次乙方接口，使得重新开发的乙方接口与需要调用的甲方接口相匹配。导致开发人员针对不同的甲方重复开发乙方接口，工作量大。

发明内容

有鉴于此，本发明的目的在于提供一种调用接口的方法及装置，以解决现有技术中存在多个不同的甲方时，需要针对不同的甲方重复开发乙方接口，导致的工作量大的问题。

技术方案如下：

本发明提供一种调用接口的方法，包括：

获取待调用接口的标识；

根据所述标识，获取所述标识对应的接口协议；

根据所述接口协议，调用所述待调用接口。

优选地，所述根据所述接口协议，调用所述待调用接口包括：

根据所述接口协议，确定待调用接口的入参信息和出参信息；

根据所述入参信息和所述出参信息，调用所述待调用接口。

优选地，所述根据所述入参信息和所述出参信息，调用所述待调用接口包括：

对所述入参信息和所述出参信息进行加密操作，生成加密后的文件；

根据所述加密后的文件，调用所述待调用接口。

优选地，所述根据所述加密后的文件，调用所述待调用接口之后，还包括：

接收返回的所述出参信息；

根据所述出参信息，判断所述待调用接口是否被成功调用；

判断所述待调用接口未被成功调用，则返回执行根据所述接口协议，调用所述待调用接口的步骤。

优选地，所述获取合作方的标识之前还包括：

根据业务请求，从全部待调用接口中确定能够响应所述业务请求的待调用接口。

本发明还提供一种调用接口的装置，包括：

第一获取单元，用于获取待调用接口的标识；

第二获取单元，用于根据所述标识，获取所述标识对应的接口协议；

第一调用单元，用于根据所述接口协议，调用所述待调用接口。

优选地，所述第一调用单元包括：

第一确定单元，用于根据所述接口协议，确定待调用接口的入参信息和出参信息；

第二调用单元，根据所述入参信息和所述出参信息，调用所述待调用接口。

优选地，所述第二调用单元包括：

加密子单元，用于对所述入参信息和所述出参信息进行加密操作，生成加密后的文件；

调用子单元，用于根据所述加密后的文件，调用所述待调用接口。

优选地，还包括：

接收单元，用于接收返回的所述出参信息；

判断单元，用于根据所述出参信息，判断所述待调用接口是否被成功调用；

判断所述待调用接口未被成功调用，则调用所述第一调用单元。

优选地，还包括：

第二确定单元，用于根据业务请求，从全部待调用接口中确定能够响应所述业务请求的待调用接口。

与现有技术相比，本发明提供的上述技术方案具有如下优点：

从上述技术方案可知，本申请中获取待调用接口的标识，根据所述标识，获取所述标识对应的接口协议，根据所述接口协议，调用所述待调用接口。当存在多个合作方时，即存在多个待调用接口时，针对不同的待调用接口，通过获取待调用接口的标识而获取到此待调用接口的接口协议，并根据接口协议调用此待调用接口。实现了同时兼容调用多个不同合作方接口的功能，而不用针对不同的合作方重复开发与合作方接口协议相匹配的接口，解决了现有技术中开发人员根据不同的接口协议重复开发接口导致的工作量大的问题。

附图说明

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

图1是本发明实施例提供的一种调用接口的方法的流程图；

图2是本发明实施例提供的另一种调用接口的方法的流程图；

图3是本发明实施例提供的一种调用接口的装置的结构示意图；

图4是本发明实施例提供的另一种调用接口的装置的结构示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

本实施例公开了一种调用接口的方法，所述方法应用于网络平台，其中，所述网络平台可以为资金交易平台或购物平台等。多个网络平台之间具有合作关系，例如，本实施例中网络平台1为网信理财平台，网络平台2为京东，网络平台3为肯德基网购平台，网信理财平台分别与京东、肯德基网购平台都具有合作关系。肯德基网购平台和京东都可以通过网信理财平台向用户发送优惠券。

本实施例中以所述方法应用在网信理财平台为例进行介绍，参见图1，该实施例包括以下步骤：

S101、获取待调用接口的标识；

待调用接口指的是与网信理财平台具有合作关系的网络平台即合作方的接口。

每个合作方都具有唯一确定的标识。在建立合作关系时，为建立的具有合作关系的网络平台即合作方分配标识。

在本实施例中对分配标识的方式并不做具体限定，只要确保为每个具有合作关系的网络平台分配的标识的唯一性即可。其中，标识可以为字符串、数字等形式。

为合作方分配了标识后，建立并存储标识与合作方之间的映射关系。由于待调用接口是合作方的接口，因此，待调用接口的标识与提供此待调用接口的合作方的标识是相同的。

确定了待调用接口后，获取待调用接口的标识。

S102、根据所述标识，获取所述标识对应的接口协议；

不同待调用接口的接口协议不同，预先存储待调用接口与接口协议之间的映射关系。由于待调用接口与为合作方分配的标识之间具有映射关系，因此，标识、待调用接口、接口协议三者之间具有映射关系。通过标识，可以从标识、待调用接口、接口协议三者之间的映射关系中获取到与标识对应的接口协议。

例如，通过调用待调用接口A和待调用接口B，以实现从待调用接口A和待调用接口B中分别获取到商品信息。以待调用接口为A为例，待调用接口A的地址为www.examplea.com/api/getProduct，待调用接口为A对应的接口协议至少包括入参和出参，其中，入参具体包括商家标识(clientId)、商品编号(productId)和加密签名(sign)；出参具体包括错误码(errorCode)、错误信息(errorMessage)和商品信息(data)。

以待调用接口为B为例，待调用接口B的地址为www.exampleb.com/interface/getItem，待调用接口为B对应的接口协议至少包括入参和出参，其中，入参具体包括商家标识(partnerId)、商品编号(itemId)和加密签名(sign)；出参具体包括错误码(errorNo)、错误信息(errorMsg)和商品信息(info)。

虽然待调用接口A和待调用接口B包括的入参参数都包括商家标识、商品编号和加密签名，出参参数都包括错误码、错误信息和商品信息，但是，用于表示相同参数的标识是不同的。例如，商家标识这一入参参数，在接口A中表示商家标识的标识是clientId，在接口B中表示商家标识的标识是partnerId；商品信息这一出参参数，在接口A中表示商品信息的标识是data，在接口B中表示商品信息的标识是info。因此，在调用接口之前，需要明确待调用接口中表示各种信息的标识，以便能够成功调用接口。

当然，其他的待调用接口的入参参数和出参参数可以包括其他的参数。

S103、根据所述接口协议，调用所述待调用接口。

从上述技术方案可知，本申请中获取待调用接口的标识，根据所述标识，获取所述标识对应的接口协议，根据所述接口协议，调用所述待调用接口。当存在多个合作方时，即存在多个待调用接口时，针对不同的待调用接口，通过获取待调用接口的标识而获取到此待调用接口的接口协议，并根据接口协议调用此待调用接口。实现了同时兼容调用多个不同合作方接口的功能，而不用针对不同的合作方重复开发与合作方接口协议相匹配的接口，解决了现有技术中开发人员根据不同的接口协议重复开发接口导致的工作量大的问题。

本实施例公开了另一种调用接口的方法，仍然以应用在网信理财平台为例进行介绍，参见图2，该实施例包括以下步骤：

S201、根据业务请求，从全部接口中确定能够响应所述业务请求的待调用接口；

用户通过在网信理财平台上进行操作，可以生成业务请求。例如，通过点击网信理财平台上显示的优惠券，生成领取优惠券的请求。但由于网信理财平台自身并不具有发放优惠券的功能，即并不具有处理领取优惠券这一请求的功能，因此需要调用与网信理财平台具有合作关系的合作方的接口，以实现将领取优惠券的请求发送至合作方进行处理，进而实现向用户发放优惠券的功能。

而网信理财平台通过合作方可以提供多种业务，不同的业务可由不同的合作方处理完成。例如，用户点击网信理财平台上显示的肯德基优惠券，此时产生了领取肯德基优惠券的业务请求。而这一业务请求并不是每个合作方都可以处理并实现向用户发放肯德基优惠券的，只有肯德基网购平台可以处理领取肯德基优惠券的这一业务请求。因此，当产生一个业务请求后，需要从全部合作方中确定能够处理此业务请求的合作方，进而调用此合作方的接口实现对业务请求的处理。

其中，根据业务请求从全部接口中确定能够响应所述业务请求的待调用接口的具体实现方式可以为：根据业务请求中的关键字，从合作方中查找与之匹配的关键字，将具有匹配关键字的合作方的接口确定为能够响应所述业务请求的待调用接口。

根据业务请求从全部接口中确定能够响应所述业务请求的待调用接口的具体实现方式还可以为：根据产生业务请求时用户在网信理财平台上的操作区域，从预先存储有操作区域与合作方的映射关系中，确定能够响应所述业务请求的合作方，将所述合作方的接口确定为能够响应所述业务请求的待调用接口。

S202、获取待调用接口的标识；

本步骤中待调用接口为根据业务请求，确定的能够处理所述业务请求的合作方的接口。获取能够处理所述业务请求的合作方的标识，作为获取到的待调用接口的标识。

S203、根据所述标识，获取所述标识对应的接口协议；

本实施例中步骤S203的实现方式与上一实施例中步骤S102的实现方式类似，此处不再赘述。

S204、根据所述接口协议，确定待调用接口的入参信息和出参信息；

不同的接口协议，调用接口时的入参信息和出参信息是不同的。

仍然以待调用接口A为例，待调用接口A为获取商品信息的接口，根据与待调用接口A对应的接口协议，确定待调用接口的入参信息为商家标识(clientId)、商品编号(productId)和加密签名(sign)；出参信息为错误码(errorCode)、错误信息(errorMessage)和商品信息(data)。

当然，待调用接口还可以为其他类型的接口，例如，待调用接口为领取某商品优惠券的接口，那么，入参信息包括商品编号，出参信息包括商品编号、图片地址、商品描述等。当然，入参信息和出参信息中还可以包括其他的参数，此处并不限定入参信息和出参信息的具体内容。

在实际应用中，由于对于同一属性参数，不同的网络平台描述方式可能不同。例如，对于商品编号这一属性参数，合作方的商品编号描述为productId,网信理财平台的商品编号描述为itemId。因此，为了避免网信理财平台和合作方对于入参信息和出参信息的描述方式不同，导致不能正确传输入参信息和出参信息的问题产生，本实施例中针对每个合作方都建立与入参信息和出参信息的映射关系。

在根据接口协议确定了入参信息和出参信息后，再根据待调用接口所属的合作方从合作方与入参信息和出参信息的映射关系中确定与合作方对应的入参信息和出参信息的描述方式，并根据合作方的入参信息和出参信息的描述方式对网信理财平台中的入参信息和出参信息进行转换。确保在接口调用时可以采用正确的参数传递。

S205、对所述入参信息和所述出参信息进行加密操作，生成加密后的文件；

对进行转换后的入参信息和出参信息进行加密操作。例如，待调用接口A中加密操作为将入参信息中包括的除加密签名(sign)外的入参参数升序排列，参数名和参数值连接后得到第一文本，利用与待调用接口A所在方约定的加密算法对第一文本进行加密操作，得到加密签名(sign)的参数值。待调用接口B中加密操作为将入参信息中包括的除加密签名(sign)外的入参参数升序排列，参数名和参数值连接后并添加约定文本后得到第二文本，利用与待调用接口B所在方约定的加密算法对第二文本进行加密操作，得到加密签名(sign)的参数值。

其中，可以采用MD5的加密算法对第一文本/第二文本进行加密。当然，还可以采用其他的加密算法。

当采用MD5的加密算法时，在为合作方分配标识的同时，还为合作方分配加密密钥。加密密钥的具体形式可以为标识+随机字符串。

通过对入参信息和出参信息加密，提高了数据传输过程中的安全性。进一步保证了业务处理过程中的安全性。

S206、根据所述加密后的文件，调用所述待调用接口；

例如，根据加密后的商品编号、商品名称、图片地址、商品描述等，调用领取商品优惠券的接口。

S207、接收所述待调用接口返回的所述出参信息；

合作方接收到调用接口的请求后，响应所述调用接口的请求，并返回出参信息。其中，返回的出参信息的格式是符合合作方规范的，但是并不一定符合网信理财平台的规范，因此，在接收到返回的出参信息后，还需要对出参信息进行格式转换。

仍然以待调用接口A为例，接收到调用接口的请求并响应所述调用接口的请求后，出参信息中包括的商品信息(data)中包括商品信息，具体可以为：

出参信息中包括的错误码和错误信息中包括调用接口的状态信息，例如，成功调用了待调用接口A，则出参信息中包括的错误码为0，错误信息为空，表示成功调用了待调用接口A；例如，没有成功调用待调用接口A，根据不同的原因，错误码也不同，当由于参数错误，导致没有成功调用待调用接口A时，错误码为1，错误信息中包括参数错误信息；当由于网络异常，导致没有成功调用待调用接口A时，错误码为2，错误信息中包括网络异常信息。

S208、根据所述出参信息的内容，判断所述待调用接口是否被成功调用；

判断所述待调用接口未被成功调用，则返回执行步骤S206；

判断所述待调用接口被成功调用，则结束流程。

出参信息中包括错误码以及错误信息，通过错误码即可判断所述待调用接口是否被成功调用。

错误码为0，则所述待调用接口被成功调用；

错误码为1或2，则所述待调用接口未被成功调用。

其中，未被成功调用的原因包括参数错误和网络异常，当错误码为1时，表明由于参数错误导致未能成功调用待调用接口，而此时由于参数错误，因此即使再次调用所述待调用接口，仍然会存在由于参数错误导致的不能成功调用待调用接口的问题。针对此，需要提示用户修改参数信息。当错误码为2时，表明由于网络异常导致未能成功调用待调用接口，可以间隔一段时间后，再次调用所述待调用接口。

在本实施例中，若判断所述待调用接口未被成功调用，则再次调用所述待调用接口；其中，为了避免死循环，预先设置调用次数，当失败次数达到预先设置的调用次数后，不再返回执行调用所述待调用接口的步骤，而是直接退出。或者，显示出错信息。

若判断所述待调用接口被成功调用，则等待下一次业务请求的产生，并按照上述方法完成待调用接口的调用。

从上述技术方案可知，本申请中获取待调用接口的标识，根据所述标识，获取所述标识对应的接口协议，根据所述接口协议，调用所述待调用接口。当存在多个合作方时，即存在多个待调用接口时，针对不同的待调用接口，通过获取待调用接口的标识而获取到此待调用接口的接口协议，并根据接口协议调用此待调用接口。实现了同时兼容调用多个不同合作方接口的功能，而不用针对不同的合作方重复开发与合作方接口协议相匹配的接口，解决了现有技术中开发人员根据不同的接口协议重复开发接口导致的工作量大的问题。同时，对传输数据进行加密操作，提高了数据传输过程中的安全性。进一步保证了业务处理过程中的安全性。

对应上述调用接口的方法，本发明还提供了一种调用接口的装置，所述装置集成到网络平台中，所述装置的结构示意图请参阅图3所示，本实施例中装置包括：

第一获取单元301、第二获取单元302和第一调用单元303；

第一获取单元301，用于获取待调用接口的标识；

第二获取单元302，用于根据所述标识，获取所述标识对应的接口协议；

第一调用单元303，用于根据所述接口协议，调用所述待调用接口。

从上述技术方案可知，本实施例中获取待调用接口的标识，根据所述标识，获取所述标识对应的接口协议，根据所述接口协议，调用所述待调用接口。当存在多个合作方时，即存在多个待调用接口时，针对不同的待调用接口，通过获取待调用接口的标识而获取到此待调用接口的接口协议，并根据接口协议调用此待调用接口。实现了同时兼容调用多个不同合作方接口的功能，而不用针对不同的合作方重复开发与合作方接口协议相匹配的接口，解决了现有技术中开发人员根据不同的接口协议重复开发接口导致的工作量大的问题。

在图3所示装置的基础上，本实施例还提供了另一种调用接口的装置，所述装置的结构示意图请参阅图4所示，本实施例中所述装置区别于图3所示装置之处在于：

第一调用单元303包括：

第一确定单元401和第二调用单元402；

第一确定单元401，用于根据所述接口协议，确定待调用接口的入参信息和出参信息；

第二调用单元402，根据所述入参信息和所述出参信息，调用所述待调用接口。

可选地，第二调用单元402还包括：

加密子单元和调用子单元；

加密子单元，用于对所述入参信息和所述出参信息进行加密操作，生成加密后的文件；

调用子单元，用于根据所述加密后的文件，调用所述待调用接口。

此外，本实施例中所述装置还包括：

接收单元403、判断单元404和第二确定单元405；

接收单元403，用于接收返回的所述出参信息的内容；

判断单元404，用于根据所述出参信息的内容，判断所述待调用接口是否被成功调用；

判断所述待调用接口未被成功调用，则调用第一调用单元303；

第二确定单元405，用于根据业务请求，从全部待调用接口中确定能够响应所述业务请求的待调用接口。

从上述技术方案可知，本实施例中获取待调用接口的标识，根据所述标识，获取所述标识对应的接口协议，根据所述接口协议，调用所述待调用接口。当存在多个合作方时，即存在多个待调用接口时，针对不同的待调用接口，通过获取待调用接口的标识而获取到此待调用接口的接口协议，并根据接口协议调用此待调用接口。实现了同时兼容调用多个不同合作方接口的功能，而不用针对不同的合作方重复开发与合作方接口协议相匹配的接口，解决了现有技术中开发人员根据不同的接口协议重复开发接口导致的工作量大的问题。同时，对传输数据进行加密操作，提高了数据传输过程中的安全性。进一步保证了业务处理过程中的安全性。

本说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似部分互相参见即可。对于实施例提供的装置而言，由于其与实施例提供的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

需要说明的是，在本文中，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

对所公开的实施例的上述说明，使本领域技术人员能够实现或使用本发明。对这些实施例的多种修改对本领域技术人员来说将是显而易见的，本文中所定义的一般原理可以在不脱离本发明的精神或范围的情况下，在其它实施例中实现。因此，本发明将不会被限制于本文所示的这些实施例，而是要符合与本文所公开的原理和新颖特点相一致的最宽的范围。

以上所述仅是本发明的优选实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以做出若干改进和润饰，这些改进和润饰也应视为本发明的保护范围。

Claims (8)

1.一种调用接口的方法，其特征在于，应用于网络平台，多个网络平台之间具有合作关系，包括：

获取待调用接口的标识；所述待调用接口为与该网络平台具有合作关系的其他网络平台的接口；

根据所述标识，获取所述标识对应的接口协议；

根据所述接口协议，调用所述待调用接口；

其中，所述根据所述接口协议，调用所述待调用接口包括：

根据所述接口协议，确定待调用接口的入参信息和出参信息；所述入参信息包括商家标识、商品编号和加密签名，出参信息包括错误码、错误信息和商品信息；其中，对于同一参数，不同的网络平台描述方式不同；

根据所述待调用接口所属的网络平台，从网络平台与入参信息和出参信息的映射关系中确定与该网络平台对应的入参信息和出参信息的描述方式，并根据确定出的描述方式对该网络平台的入参信息和出参信息进行转换；

根据转换后的所述入参信息和所述出参信息，调用所述待调用接口。

2.根据权利要求1所述的方法，其特征在于，所述根据所述入参信息和所述出参信息，调用所述待调用接口包括：

对所述入参信息和所述出参信息进行加密操作，生成加密后的文件；

根据所述加密后的文件，调用所述待调用接口。

3.根据权利要求2所述的方法，其特征在于，所述根据所述加密后的文件，调用所述待调用接口之后，还包括：

接收返回的所述出参信息；

根据所述出参信息，判断所述待调用接口是否被成功调用；

判断所述待调用接口未被成功调用，则返回执行根据所述接口协议，调用所述待调用接口的步骤。

4.根据权利要求1-3任意一项所述的方法，其特征在于，所述获取待调用接口的标识之前还包括：

根据业务请求，从全部待调用接口中确定能够响应所述业务请求的待调用接口。

5.一种调用接口的装置，其特征在于，应用于网络平台，多个网络平台之间具有合作关系，包括：

第一获取单元，用于获取待调用接口的标识；所述待调用接口为与该网络平台具有合作关系的其他网络平台的接口；

第二获取单元，用于根据所述标识，获取所述标识对应的接口协议；

第一调用单元，用于根据所述接口协议，调用所述待调用接口；

其中，所述第一调用单元包括：

第一确定单元，用于根据所述接口协议，确定待调用接口的入参信息和出参信息；所述入参信息包括商家标识、商品编号和加密签名，出参信息包括错误码、错误信息和商品信息；其中，对于同一参数，不同的网络平台描述方式不同；根据所述待调用接口所属的网络平台，从网络平台与入参信息和出参信息的映射关系中确定与该网络平台对应的入参信息和出参信息的描述方式，并根据确定出的描述方式对该网络平台的入参信息和出参信息进行转换；

第二调用单元，根据转换后的所述入参信息和所述出参信息，调用所述待调用接口。

6.根据权利要求5所述的装置，其特征在于，所述第二调用单元包括：

加密子单元，用于对所述入参信息和所述出参信息进行加密操作，生成加密后的文件；

调用子单元，用于根据所述加密后的文件，调用所述待调用接口。

7.根据权利要求6所述的装置，其特征在于，还包括：

接收单元，用于接收返回的所述出参信息；

判断单元，用于根据所述出参信息，判断所述待调用接口是否被成功调用；

判断所述待调用接口未被成功调用，则调用所述第一调用单元。

8.根据权利要求5-7任意一项所述的装置，其特征在于，还包括：

第二确定单元，用于根据业务请求，从全部待调用接口中确定能够响应所述业务请求的待调用接口。

Images