CN106105100B

CN106105100B - 处理应用编程接口请求的方法和装置

Info

Publication number: CN106105100B
Application number: CN201580012556.5A
Authority: CN
Inventors: S·K·加迪帕蒂
Original assignee: Twc Patent Trust
Current assignee: Dtn Ltd
Priority date: 2014-03-18
Filing date: 2015-03-18
Publication date: 2019-09-06
Anticipated expiration: 2035-03-18
Also published as: US20150269377A1; EP3120501A1; EP3120501A4; WO2015143003A1; US9846771B2; CN106105100A; EP3120501B1

Abstract

处理应用编程接口请求的方法和装置。API网关设计用于处理对数据和服务的高容量的API请求，其中将相对大的负载返回给请求者。所述API网关包括“在线”组件，所述在线组件针对每个API请求，检查所述请求中的信息以按API ID和产品密钥增加API使用计数。所述使用信息周期性地压入出站消息队列，之后被填充到数据库中。“离线”组件基于所述数据库中的信息确定客户是否已超出其预定配额。这个确定被压入另一消息队列，所述另一消息队列由所述在线组件周期性地读取以更新存储器内API ID、产品密钥和API有效标记值。因此，所述在线组件能够以低延时来服务于对数据的高容量的API请求。

Description

处理应用编程接口请求的方法和装置

技术领域

本发明涉及处理应用编程接口请求的方法和装置。

背景技术

数据和服务提供者越来越多采用应用编程接口(API)来将服务递送通过移动、云和web信道。虽然通过API来暴露和消耗这些服务变得更为容易，但是对暴露API的管理已成问题。例如，通过暴露API，提供者承担的任务包括控制对API的访问、出于货币化的目的计量API、节流API以使客户将不超出他们的配额、监视API延时和可用性、以及确保仅通过认证的用户访问API。另外，许多的提供者希望在线且近乎实时地报告使用分析、服务可用性度量和API延时统计。

通常，为了提供以上内容，常规API网关应用自顶向下方法计量客户的API请求的数量、提供服务认证并且在客户超出预定使用量时节流用量。这注重于通过常规API网关的计量、认证和节流而将延时引入每个请求中。因此，API管理系统内的常规API网关能够针对相对小的负载提供足够的吞吐量，但经证实，它在存在对相对大的负载的高容量的请求的环境下是有缺陷的。

发明内容

API网关设计用于处理对数据和服务的高容量的API请求，其中将相对大的负载返回给请求者。所述API网关包括“在线”组件，所述在线组件针对每个API请求，检查所述请求中的信息以按API ID和产品密钥增加API使用计数。所述使用信息周期性地压入出站消息队列，之后被填充到数据库中。“离线”组件基于所述数据库中的信息确定客户是否已超出其预定配额。这个确定被压入另一消息队列，所述另一消息队列由所述在线组件周期性地读取以更新存储器内API ID、产品密钥和API有效标记值。因此，所述在线组件能够以低延时来服务于对数据的高容量的API请求，因为计量决策和节流决策由所述离线组件执行。

根据本发明，提供一种用于在API网关处接收和处理API请求的方法。所述方法可以包括：在计算设备上执行的第一组件处接收API请求；认证在所述API请求负载中包含的API密钥和密码摘要；更新API使用值；根据所述API密钥提供对API服务的访问；将所述API使用值周期性地压入消息队列中，所述消息队列是由所述计算设备上执行的第二组件处理；以及用所述第二组件提供的信息周期性地更新所述第一组件。

根据本发明的其他方面，提供一种包括处理器和存储器的装置，所述存储器存储由所述处理器执行的指令。所述指令在执行时，将具有在所述存储器中执行的在线组件的应用编程接口(API)网关例示。所述在线组件接收统一资源标识符(URI)请求，并且基本上实时地解析所述URI请求，用以确定所述URI以及相关联的应用编程接口(API)密钥的有效性。所述API网关还可具有离线组件，所述离线组件从所述在线组件处接收信息，以便确定与所述URI请求关联的使用统计。所述在线组件可借助所述API网关来提供对所访问的API服务的访问控制以及认证，而所述离线组件可提供用于所述API服务的用量的计量和节流。

根据本发明的其他方面，提供一种方法，所述方法包括：监视对应用编程接口(API)服务的传入请求；接收来自用户的API请求；使用第一组件基本上实时地认证与所述请求关联的所述用户；根据所述认证，增加所述用户的API使用计数；使用第二组件周期性地确定(使用第二组件)所述用户的所述API使用计数是否高于预定阈值；以及如果所述认证成功，将所述请求传送至所述API服务。

上述内容是概述并因此必然包含细节的简化、概括和省略。本领域的那些技术人员将会了解，概述仅是说明性的，而不旨在以任何方式来限制。

附图说明

附图中的组件不一定相对于彼此成比例绘制。在全部若干视图中，相同元件符号指示对应部分。

图1是API管理系统的高级框图；

图2是示出图1的API管理系统的API网关的另外细节的框图；

图3示出图1的API管理系统提供的功能和特征的相对优先级；

图4是图1的API网关执行的示例操作流程；

图5示出在API网关内通过电晕组件(corona component)202元件推送至核芯组件204的信息；

图6示出用于根据客户用量更新API有效标记的信息和进程；以及

图7示出可实施本发明的各个方面的示例性的计算环境

具体实施方式

综述

以下描述的是一种API管理系统，所述API管理系统包括API网关，所述API网关设计用于处理对数据和服务的高容量的API请求，其中将相对大的负载返回给请求者。如将描述，API网关包括“在线”组件，所述在线组件针对每个API请求，检查API ID、密钥、密码摘要和API有效标记。所述检查例如是在存储器内执行。在线组件根据API ID和产品密钥增加API使用计数。在线组件将API使用计数周期性地压入出站消息队列中，之后被填充到数据库中。

“离线”组件基于所述数据库中的信息确定客户是否已超出其预定配额。离线组件将使用信息以及其他更新放入入站队列中，所述入站队列由在线组件周期性地读取以更新存储器内API ID、产品密钥和API有效标记值。因此，认证以及访问控制的功能与计量和节流的确定是分开的，这使在线组件能够以低延时来服务于对数据的请求。

描述

参考图1，示出根据本发明的示例API管理系统100，所述API管理系统100包括API网关102、API入口104和API服务106。如以下所介绍，API网关102适于以低延时来服务于高容量API通信量以及相对大的API负载。如将从以下所了解，API网关102设计用于根据置于API管理系统100上的需求进行扩展。

图2更详细地示出API网关102的展示组件的框图。API网关102的组件包括电晕组件202、核芯组件204、输入端点206、化身(incarnation)服务208、外部服务210和消息队列212、214和216。电晕组件202是接收统一资源标识符(URI)请求并解析URI以执行对URI以及API密钥的有效性的检查的“在线组件”。“在线组件”用来表示电晕组件202基本上实时地操作，以便执行本文描述的功能和特征。电晕组件202维持有效API密钥，将它们与标记关联，并使用标记来施行配额分配，如图5所示以及在下文中更详细地论述。电晕组件202从URI中检索所述API密钥以及密码摘要，并且如果计算出的密码摘要等于所述URI中提供的密码摘要(即，API请求通过认证)，那么将所述URI传送至API服务106。随后，电晕组件202按其存储器内的API密钥来增加API使用计数。根据以上内容，可使用基于存储器的处理最小化用户认证。

作为非限制性示例，API密钥可限定为<产品>/<组件>/<版本>。因此，客户可以发送URI中的产品密钥以及HTTP请求标头中的摘要/令牌。产品可以用单独API密钥或API ID组来识别。产品密钥针对账户或针对给定产品和客户选择的方案而生成。一个账户可以具有一个或多个产品密钥；然而，对于给定账户、产品ID和配额，可仅存在一个产品密钥。令牌可针对每个请求来计算。令牌生成算法的示例是：

sha256(共享_密码+x-摘要日期标头+URI从/直至但不包括)。令牌可在HTTP请求的x-令牌标头中发送至电晕组件202，这在下文描述。根据本发明的各个方面，每个产品密钥可映射至共享密码。

根据本发明的各个方面，多于一个电晕组件202可以在API网关102内被例示。因此，API网关102可通过按需要例示另外电晕组件202来扩展，以便满足需求。当新的电晕组件202被例示时，化身服务208将信息从输入端点206提供到新例示电晕组件202。

核芯组件204作为“离线”组件操作，以便调用内部服务来从每个电晕组件出站队列216按照API-密钥检索API-密钥使用统计，并且周期性地(例如，每5-10分钟)或按其他时间间隔按照API密钥聚集使用统计。如本文所使用，“离线组件”表示核芯组件204周期性地(即，并非基本上实时地)操作，以便执行本文所述功能。因此，计量和节流以低于电晕组件202所执行的认证以及访问控制的优先级执行，以提供低延时。

核芯组件204还存储了有效且活动的API ID、API密钥和属性，并且将停用且无效的API ID和密钥移动至历史数据。核芯组件204可按API、产品和用户ID提供历史使用分析以及趋势。核芯组件204可按用户、API和产品以几乎实时的方式提供使用统计，例如，在过去24小时内按每10分钟的频率提供使用统计。

核芯组件204还可使用外部服务210以增加的方式(基于时间增量或以事件为基础)读取用户数据。外部服务210会从门户API和/或其他访问机制读取这个数据，并且将数据更新/插入核芯组件204数据库中。此类数据的非限制性示例是：

o用户信息(用户ID、名称、联系信息和其他资料数据)

o所列出的API(API ID、名称等等)

o产品信息(产品ID、名称、API ID、API名称等等)

o用户API配额(用户ID、用户名称、API ID、API名称、配额单位(s)、配额的量(S))

o用户产品配额(用户ID、用户名称、产品ID、产品名称、配额单位(s)、配额的量(S))

外部服务210可以包括密钥和密码生成服务(未示出)。这个服务生成API密钥和密码，并且由API门户104访问以获得API密钥(API门户104仅存储API密钥)。外部服务210还可包括API使用统计服务。这个服务提供针对给定API/产品、用户并在给定时段内的使用统计。这个服务还提供用于时序分析的数据。例如，就给定API和用户而言，所述服务可按10分钟的间隔提供24小时使用数据。另一示例是就给定用户按天提供月度API数据。外部服务210还可包括数据提取服务，以从API门户104提取数据。这个服务能够从平面文件、API门户104所暴露的API或通向API门户104的直接数据库连接读取数据。这种提取可以基于事件，或基于增加时间或完成刷新。

输入端点206针对给定API密钥提供密码。还可采用其他参数生成密码。输入端点206提供用于外部服务请求和内部服务请求的密码。输入端点206被限制来经由外部服务提供来自API门户104的请求的密码，输入端点206存储API密钥、以及呈加密形式的密码。例如，共享密码可为十六进制的文本串。

API网关102可以计量URI用量，基于API门户104中限定的配额来对URI进行节流。API网关102还可计量API延时、计量API正常运行时间，并且按用户和产品提供API使用分析、API可用性度量，提供API延时度量以及有关于使用情况的其他信息。这个信息可通过例如web服务暴露于API门户104以及其他协作系统。

API门户104用于提供API文档、说明API使用示例、公布API最佳实践、公布暴露API列表、公布产品以及用量计费模型、用户登记以及用户资料管理、包括API/产品的密钥和密码的服务的API自助服务、存储并且显示客户协议、API核准工作流程、以及与社交媒体(例如，推特(Twitter)))集成以实现客户交互。API门户104可增加地(例如，基于事件或时间)将这个信息向API网关100推送和/或按需要来推送完整副本。API密钥和密码通过API门户104存储。

API门户104还可维持用户、API ID-配额和用户-产品密钥-配额信息的关系。配额是基于为不同客户、产品和API关系分配的计费方案以及产品内的API的允许用量的作用针对给定API ID和产品密钥的导出信息。配额可为最大请求/分钟或最大请求/天或最大请求/月。API门户104维持配额信息。

API服务106表示通过API管理系统100管理的API暴露的数据服务。例如，API服务106可以包括但不限于广播天气数据、历史天气数据、广告宣传数据、通信量数据等。

因此，API管理系统100中的API网关102设计用于以离线的方式周期性地执行计量和节流使低延时优先于如实时节流等的特征。因此，API网关102能够处理高API通信量(例如，每天超出10亿请求)和较大负载(例如，大于30kB的负载)。优先化的示例在图3中示出。比起实时节流，在设计中的最高的优先级是提供低API延时。为实现低延时，认证和访问是通过电晕组件202来在线执行的，而聚集的计量和节流是使用核芯组件204周期性地离线执行。

参考图4，示出API网关102执行的功能的示例操作流程。在400处，API网关102开始它的处理。所述开始可以启动一个或多个同时执行进程。第一示例进程开始监视并且处理对API服务106的传入请求。在这个进程内，在402处，从例如客户处接收对服务的请求作为API请求。例如，API请求可由客户使用在HTTP请求中包含适当API密钥和令牌的URI做出。在404处，检查API请求中包含的信息以认证和验证与请求关联的客户。这个信息可由电晕组件202进行存储器内处理，以便确定是否应服务于API请求。如果在404处，API请求通过检查，那么在406处，针对做请求的特定客户增加API使用计数。此操作的结果存储在数据库中。随后，在408处，将请求传到API服务。API服务106可将响应以负载(例如，较大负载)的形式提供至请求者。然而，如果在404处，请求并未通过检查，那么在410处，节流请求。图4中示出的操作流程基本上连续地操作，以服务于电晕组件202所接收的请求。

如图5所示，电晕组件202可以调用内部API服务，以便周期性地将信息推送至核芯组件204。这个信息可以包括API密钥、密码、标记、配额信息/用量等等，以便周期性地更新电晕组件的配额标记。

如图6所示，电晕组件202可以调用内部API服务并且周期性地更新电晕组件的配额标记。另外，电晕组件202可基于API-密钥聚集的用量对比分配配额来决定更新标记。周期性地，核芯组件204就给定API密钥来检查聚集用量。如果聚集用量超出分配配额，那么基于业务规则将API有效标记设定为“T”或“S”。例如，API有效标记的值可为O：确认；T：暂时禁止；或S：中止。如果API请求/分钟超出就给定API密钥设定的容量，那么电晕组件202还可中止API请求。

可以使用许多其他通用或专用计算系统环境或配置。可适合于使用的熟知计算系统、环境和/或配置的示例包括但不限于PC、服务器计算机、手持设备或膝上型设备、多处理器系统、基于微处理器系统、网络PC、小型计算机、大型计算机、埋置式系统、包括以上系统或设备的任一者的分布计算环境等等。

可以使用将由计算机执行的计算机可执行指令(诸如程序模块)。一般而言，程序模块包括执行特定任务或实施特定抽象数据类型的例程、程序、对象、组件、数据结构等等。分布计算环境可以在任务由通过通信网络或其他数据传输介质链接的远程处理设备执行的情况下使用。在分布计算环境中，程序模块和其他数据可以位于包括存储器存储设备的本地和远程计算机存储介质两者中。

参考图7，用于实施本文描述的各个方面的示例性的系统包括计算设备，诸如计算设备700。在它的最基本的配置中，计算设备700通常包括至少一个处理单元702和系统存储器704。根据计算设备的提取配置和提取类型，系统存储器704可为易失性(诸如随机存取存储器(RAM))、非易失性(诸如只读存储器(ROM)、闪存等等)或这两者的一些组合。在图7中，这个最基本的配置是以虚线706示出。

计算设备700可以具有另外特征和/或功能。例如，计算设备700可以包括另外存储装置(可移动和/或不可移动)，包括但不限于磁盘或光盘或磁带。在图7中，此类另外存储装置以可移动存储装置708和不可移动存储装置710示出。

计算设备700通常包括多种计算机可读的介质。计算机可读的介质可为能够由计算设备700访问的任何可用介质，并且包括易失性和非易失性介质、以及可移动和不可移动介质两者。举例来说，但非限制，计算机可读的介质可以包括计算机存储介质和通信介质。

计算机存储介质包括以任何用于存储信息(诸如计算机可读的指令、数据结构、程序模块或其他数据)的方法或技术实施的易失性和非易失性介质、以及可移动和不可移动介质。系统存储器704、可移动存储装置708和不可移动存储装置710都是计算机存储介质的示例。计算机存储介质包括但不限于RAM、ROM、电可擦除可编程只读存储器(EEPROM)、闪存或其他存储器技术、CD-ROM、数字通用光盘(DVD)或其他光学存储装置、磁带盒、磁带、磁盘存储装置或其他磁性存储设备、或可用于存储期望信息并能够由计算设备700访问的任何其他介质。任何此类计算机存储介质可为计算设备700的一部分。

计算设备700还可包含允许计算设备700与其他设备通信的通信连接712。通信连接712是通信介质的示例。通信介质通常以诸如载波或其他传输机制的调制数据信号体现计算机可读的指令、数据结构、程序模块或其他数据，并且包括任何信息递送介质。术语“调制数据信号”表示使其特性的一个或多个以编码信号中信息的方式设置或改变的信号。举例来说，但非限制，通信介质包括诸如有线网络或直连连接的有线介质，以及诸如声学、射频(RF)、红外和其他无线介质的无线介质。如本文使用的术语计算机可读的介质包括存储介质和通信介质两者。

计算设备700还可具有输入设备714，诸如键盘、鼠标、触笔、语音输入设备、触摸输入设备等等。还可包括输出设备716，诸如显示器、扬声器、打印机等等。所有这些设备在本领域中众所周知，并且无需在此详细论述。

计算设备700可为通过网络来互连的多个计算设备700之一。如可了解，网络可为任何适当网络，每个计算设备700可以任何适当方式借助通信连接712来连接至其上，并且每个计算设备700可以任何适当方式来与网络中的其他计算设备700的一个或多个通信。例如，网络可为组织或家庭等等内的有线网络或无线网络，并且可以包括通向外部网络(诸如互联网等)的直接耦接或间接耦接。

应当理解，本文中描述的各种技术可结合硬件或软件或这两者的组合(在适当时)来实施。因此，当前公开的主题的方法和装置或其某些方法或部分可以采用体现在有形介质(诸如软盘、CD-ROM、硬盘驱动器或任何其他机器可读存储介质)中的程序代码(即，指令)的形式，其中当程序代码加载到诸如计算机的机器中并由机器执行时，所述机器成为用于实践当前公开的主题的装置。在程序代码执行在可编程计算机上的情况下，计算设备一般来说包括处理器、可由处理器读取的存储介质(包括易失性和非易失性存储器和/或存储元件)、至少一个输入设备和至少一个输出设备。一个或多个程序可以例如通过使用应用编程接口(API)、可重复使用的控件等等来实施或利用结合当前公开的主题描述的进程。此类程序可以用高级程序语言或面向对象编程语言实施，以与计算机系统通信。然而，在需要时，程序可以汇编语言或机器语言实施。在任何情况下，语言可以是编译或解释语言，并且可与硬件实施方式组合。

虽然示例性的实施方式可涉及到在一个或多个独立计算机系统的上下文中利用当前公开的主题的方面，但是本发明的主题不受这样限制，而是可结合诸如网络或分布计算环境的任何计算环境来实施。另外，当前公开的主题的方面可以在多个处理芯片或设备中或跨多个处理芯片或设备实施，并且存储可类似跨多个设备实现。例如，此类设备可以包括个人计算机、网络服务器以及手持设备。

虽然已用特定于结构特征和/或方法动作的语言描述本发明的主题，但应理解，随附的权利要求书中定义的主题不一定限制于上述具体的特征或动作。相反，上述具体的特征和动作公开为实施权利要求的示例形式。

Claims

1.一种用于在应用编程接口API网关处接收和处理API请求的方法，所述方法包括以下步骤：

在计算设备上执行的第一组件处接收API请求，所述第一组件作为存储器内组件被提供，并且以第一优先级执行以检查API ID、API密钥、密码摘要和API有效标记中的至少一者，以便执行对所述API请求的认证；

认证在认证的API请求中包含的API密钥和密码摘要；

增加API使用值；

由第二组件基于数据库中的API使用值来确定进行所述API请求的用户是否已超出预定配额，其中，所述第二组件作为以低于所述第一优先级的第二优先级执行的离线组件被提供；

根据所述API密钥和所述API有效标记提供对API服务的访问；

将所述API使用值周期性地压入消息队列中，所述消息队列是由所述计算设备上执行的所述第二组件处理；以及

用所述第二组件提供的使用信息周期性地更新由所述第一组件使用的API有效标记。

2.如权利要求1所述的方法，所述方法还包括以下步骤：

根据所述API ID和产品密钥增加所述API使用值；

将所述API使用值放入出站消息队列中；以及

将所述API使用值填充到所述数据库中。

3.如权利要求2所述的方法，所述方法还包括以下步骤：通过所述离线组件将使用信息放入入站队列中，所述入站队列由所述存储器内组件周期性地读取以更新存储器内APIID、所述产品密钥和所述API有效标记。

4.如权利要求1所述的方法，所述方法还包括以下步骤：根据所述使用信息确定是否应对所述API请求进行节流。

5.如权利要求1所述的方法，用所述第二组件提供的使用信息周期性地更新由所述第一组件使用的API有效标记的步骤还包括：由所述第一组件读取所述消息队列，以更新所述API ID、所述API密钥和所述API有效标记的值。

6.如权利要求1所述的方法，所述方法还包括以下步骤：对所述API请求和所述API密钥执行有效性检查。

7.如权利要求1所述的方法，所述方法还包括以下步骤：如果来自所述API请求的密码摘要等于计算出的密码摘要，则认证所述API请求。

8.如权利要求1所述的方法，所述方法还包括以下步骤：

在所述计算设备上执行的第一组件处接收第二API请求；

对所述第二API请求中包含的第二API密钥和第二密码摘要进行认证；

增加第二API使用值；

由所述第二组件基于数据库中的第二API使用值来确定进行所述第二API请求的用户是否已超出第二预定配额；

根据所述第二API密钥和第二API有效性标记来提供对所述API服务的访问；

周期性地将所述第二API使用值压入由在所述计算设备上执行的所述第二组件处理的消息队列；以及

用由所述第二组件提供的使用信息来周期性地更新由所述第一组件使用的第二API有效性标记。

9.如权利要求1所述的方法，所述方法还包括以下步骤：

根据由所述第二组件提供的使用信息来对所述API请求进行节流。

10.一种用于处理应用编程接口API请求的装置，所述装置包括：

处理器；以及

存储器，所述存储器存储由所述处理器执行的指令，所述指令在被执行时，实例化具有在所述存储器中执行的在线组件的API网关，所述在线组件接收统一资源标识符URI请求，并且实时地解析所述URI请求，用以确定所述URI以及相关联的API密钥的有效性，所述API网关还具有离线组件，所述离线组件从所述在线组件接收信息，以便确定与所述URI请求关联的使用统计，

其中所述在线组件通过以下方式借助所述API网关提供对所访问的API服务的访问控制以及认证：从URI请求中检索API密钥以及密码摘要；以及如果计算出的密码摘要等于所述URI请求中提供的密码摘要，那么将所述URI请求传送至所述API服务，

其中所述离线组件提供用于所述API服务的用量的计量和节流，并且

其中，计量和节流以比所述访问控制和认证低的优先级执行。

11.如权利要求10所述的装置，其中所述离线组件通过向所述在线组件周期性地提供使用统计来执行所述计量和节流。

12.如权利要求11所述的装置，其中所述计量和节流是基于配额来进行的。

13.如权利要求12所述的装置，其中所述配额基于最大请求/分钟、最大请求/天、或最大请求/月中的一者。

14.如权利要求10所述的装置，其中多于一个在线组件在所述API网关内被例示，以便提供扩展。

15.如权利要求10所述的装置，其中所述API密钥被限定为<产品>/<组件>/<版本>。