DESC:
FORM 2

THE PATENTS ACT, 1970
(39 of 1970)
&
THE PATENTS RULES, 2003

COMPLETE SPECIFICATION
(See section 10 and rule 13)
1. TITLE OF THE INVENTION
SYSTEM AND METHOD FOR MANAGING ONE OR MORE APPLICATION PROGRAMMING INTERFACES (APIs)

2. APPLICANT(S)
NAME NATIONALITY ADDRESS
JIO PLATFORMS LIMITED INDIAN OFFICE-101, SAFFRON, NR. CENTRE POINT, PANCHWATI 5 RASTA, AMBAWADI, AHMEDABAD 380006, GUJARAT, INDIA
3.PREAMBLE TO THE DESCRIPTION

THE FOLLOWING SPECIFICATION PARTICULARLY DESCRIBES THE NATURE OF THIS INVENTION AND THE MANNER IN WHICH IT IS TO BE PERFORMED.

FIELD OF THE INVENTION
[0001] The present invention relates generally to Application Programming Interface (API) management, and in particular, the present invention provides a system and method for dynamically managing APIs.
BACKGROUND OF THE INVENTION
[0002] In general, a communication system may comprise of multiple versions of APIs (Application Programming Interface). API versioning and backward compatibility are the crucial part of an API design. The API versioning is the practice of managing changes to the API and ensuring that these changes are made without disrupting clients. Backward compatibility is the ability of the API to work with older versions of the API or with previous versions of the clients or applications that use it. The backward compatibility ensures that existing clients can continue to access the API and its services without disruption or degradation.
[0003] In some scenarios, whenever new updates or versions of APIs are introduced in the communication system, clients may wish to utilize the new versions, or a new version of the API may be integrated in a common API gateway. For doing this, there is a need to configure an API template and the configuration is done by changing a code or logic in the communication system. This may lead to disconnection of API call and may cause degradation in the performance of the API as the task of changing the code or logic every time may be cumbersome and time consuming.
[0004] In view of the above, there is a dire need for a system and method for dynamically managing API, which ensures that degradation in the performance of the APIs and disconnection of the API calls are avoided.
SUMMARY OF THE INVENTION
[0005] One or more embodiments of the present disclosure provide a system and a method for managing one or more Application Programming Interfaces (APIs).
[0006] In one aspect of the present invention, the method of managing one or more APIs is disclosed. The method includes provisioning, by one or more processors, one or more templates corresponding to the one or more APIs. Further, the method includes configuring, by the one or more processors, each of the one or more API templates with an at least one version. Each of the at least one version includes one or more of structural parameters and one or more behavioral parameters. Further, the method includes storing, by the one or more processors, the one or more API templates of the one or more APIs in an API repository. Further, the method includes selecting, by the one or more processors, at least one of the one or more API templates of the one or more APIs from an API repository upon receipt of an API call. Further, the method includes transmitting, by the one or more processors, a request to an API service providing unit upon selection of the at least one of the one or more API templates of the one or more APIs. Further, the method includes receiving, by the one or more processors, a response from the API service providing unit indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user.
[0007] In an embodiment, each of the one or more provisioned API templates includes data pertaining to each of the one or more APIs. The data includes at least one of protocol types and ports.
[0008] In an embodiment, each of the at least one version includes a corresponding set of parameters. The set of parameters includes at least a request protocol, Uniform Resource Locator (URL), request type, header, query parameter, communication type, and database related information, the one or more structural parameters and the one or more behavioral parameters. In an embodiment, the one or more structural parameters includes at least one of an endpoint configuration, resource limits and authentication method and wherein the one or more behavioral parameters include at least one of caching policies and error handling.
[0009] In an embodiment, upon the configuration of the one or more API templates with the at least one version, the method includes configuring, by the one or more processors, the one or more API templates with a corresponding end point.
[0010] In an embodiment, the API call is initiated by the user via a user equipment (UE).
[0011] In an embodiment, the request includes information pertaining to the at least one version of the one or more selected API templates required to be retrieved from the API repository.
[0012] In one aspect of the present invention, the system for managing one or more APIs is disclosed. The system includes a provisioning unit, a configuration unit, a storing unit, a selection unit, a transceiver and API service providing unit. The provisioning unit is configured to provision templates corresponding to the one or more APIs. The configuration unit is configured to configure each of the one or more API templates with an at least one version. Each of the at least one version includes one or more of a structural parameters and one or more of behavioural parameters. The storing unit is configured to store the one or more API templates of the one or more APIs in an API repository. The selection unit is configured to select at least one of the one or more API templates of the one or more APIs from the API repository upon receipt of an API call. The transceiver is configured to transmit a request to an API service providing unit upon selection of the at least one of the one or more API templates of the one or more APIs. The transceiver is configured to receive a response from the API service provider indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user.
[0013] In one aspect of the present invention, a non-transitory computer-readable medium having stored thereon computer-readable instructions is provided. The computer-readable instructions cause a processor to provision one or more templates corresponding to the one or more APIs. Further, the processor configures each of the one or more API templates with an at least one version. Each of the at least one version includes one or more of structural parameters and one or more of behavioral parameters. Further, the processor stores the one or more API templates of the one or more APIs in an API repository. Further, the processor selects at least one of the one or more API templates of the one or more APIs from the API repository upon receipt of an API call. Further, the processor transmits a request to an API service providing unit upon selection of the at least one of the one or more API templates of the one or more APIs. Further, the processor receives a response from the API service providing unit indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user.
[0014] Other features and aspects of this invention will be apparent from the following description and the accompanying drawings. The features and advantages described in this summary and in the following detailed description are not all-inclusive, and particularly, many additional features and advantages will be apparent to one of ordinary skill in the relevant art, in view of the drawings, specification, and claims hereof. Moreover, it should be noted that the language used in the specification has been principally selected for readability and instructional purposes and may not have been selected to delineate or circumscribe the inventive subject matter, resort to the claims being necessary to determine such inventive subject matter.

BRIEF DESCRIPTION OF THE DRAWINGS
[0015] The accompanying drawings, which are incorporated herein, and constitute a part of this disclosure, illustrate exemplary embodiments of the disclosed methods and systems in which like reference numerals refer to the same parts throughout the different drawings. Components in the drawings are not necessarily to scale, emphasis instead being placed upon clearly illustrating the principles of the present disclosure. Some drawings may indicate the components using block diagrams and may not represent the internal circuitry of each component. It will be appreciated by those skilled in the art that disclosure of such drawings includes disclosure of electrical components, electronic components or circuitry commonly used to implement such components.
[0016] FIG. 1 is an exemplary block diagram of an environment for managing one or more APIs, according to various embodiments of the present disclosure.
[0017] FIG. 2 is a block diagram of a system of FIG. 1, according to various embodiments of the present disclosure.
[0018] FIG. 3 is an example schematic representation of the system of FIG. 1 in which various entities operations are explained, according to various embodiments of the present system.
[0019] FIG. 4 is an exemplary flow diagram illustrating a method for managing the one or more APIs, according to various embodiments of the present disclosure.
[0020] FIG. 5 is an example flow diagram illustrating an internal call flow for managing the one or more APIs, in accordance with some embodiments.
[0021] FIG. 6 illustrates an example system architecture for managing the one or more APIs, in accordance with some embodiments.
[0022] Further, skilled artisans will appreciate that elements in the drawings are illustrated for simplicity and may not have necessarily been drawn to scale. For example, the flow charts illustrate the method in terms of the most prominent steps involved to help to improve understanding of aspects of the present invention. Furthermore, in terms of the construction of the device, one or more components of the device may have been represented in the drawings by conventional symbols, and the drawings may show only those specific details that are pertinent to understanding the embodiments of the present invention so as not to obscure the drawings with details that will be readily apparent to those of ordinary skill in the art having benefit of the description herein.
[0023] The foregoing shall be more apparent from the following detailed description of the invention.

DETAILED DESCRIPTION OF THE INVENTION
[0024] Some embodiments of the present disclosure, illustrating all its features, will now be discussed in detail. It must also be noted that as used herein and in the appended claims, the singular forms "a", "an" and "the" include plural references unless the context clearly dictates otherwise.
[0025] Various modifications to the embodiment will be readily apparent to those skilled in the art and the generic principles herein may be applied to other embodiments. However, one of ordinary skill in the art will readily recognize that the present disclosure including the definitions listed here below are not intended to be limited to the embodiments illustrated but is to be accorded the widest scope consistent with the principles and features described herein.
[0026] A person of ordinary skill in the art will readily ascertain that the illustrated steps detailed in the figures and here below are set out to explain the exemplary embodiments shown, and it should be anticipated that ongoing technological development will change the manner in which particular functions are performed. These examples are presented herein for purposes of illustration, and not limitation. Further, the boundaries of the functional building blocks have been arbitrarily defined herein for the convenience of the description. Alternative boundaries can be defined so long as the specified functions and relationships thereof are appropriately performed. Alternatives (including equivalents, extensions, variations, deviations, etc., of those described herein) will be apparent to persons skilled in the relevant art(s) based on the teachings contained herein. Such alternatives fall within the scope and spirit of the disclosed embodiments.
[0027] Before discussing example, embodiments in more detail, it is to be noted that the drawings are to be regarded as being schematic representations and elements that are not necessarily shown to scale. Rather, the various elements are represented such that their function and general purpose becomes apparent to a person skilled in the art. Any connection or coupling between functional blocks, devices, components, or other physical or functional units shown in the drawings or described herein may also be implemented by an indirect connection or coupling. A coupling between components may also be established over a wireless connection. Functional blocks may be implemented in hardware, firmware, software or a combination thereof.
[0028] Further, the flowcharts provided herein, describe the operations as sequential processes. Many of the operations may be performed in parallel, concurrently or simultaneously. In addition, the order of operations maybe re-arranged. The processes may be terminated when their operations are completed, but may also have additional steps not included in the figured. It should be noted, that in some alternative implementations, the functions/acts/ steps noted may occur out of the order noted in the figured. For example, two figures shown in succession may, in fact, be executed substantially concurrently, or may sometimes be executed in the reverse order, depending upon the functionality/acts involved.
[0029] Further, the terms first, second etc… may be used herein to describe various elements, components, regions, layers and/or sections, it should be understood that these elements, components, regions, layers and/or sections should not be limited by these terms. These terms are used only to distinguish one element, component, region, layer or section from another region, layer, or a section. Thus, a first element, component, region layer, or section discussed below could be termed a second element, component, region, layer, or section without departing form the scope of the example embodiments.
[0030] Spatial and functional relationships between elements (for example, between modules) are described using various terms, including “connected,” “engaged,” “interfaced,” and “coupled.” Unless explicitly described as being “direct,” when a relationship between first and second elements is described in the description below, that relationship encompasses a direct relationship where no other intervening elements are present between the first and second elements, and also an indirect relationship where one or more intervening elements are present (either spatially or functionally) between the first and second elements. In contrast, when an element is referred to as being "directly” connected, engaged, interfaced, or coupled to another element, there are no intervening elements present. Other words used to describe the relationship between elements should be interpreted in a like fashion (e.g., "between," versus "directly between," "adjacent," versus "directly adjacent," etc.).
[0031] The terminology used herein is for the purpose of describing particular example embodiments only and is not intended to be limiting. Unless otherwise defined, all terms (including technical and scientific terms) used herein have the same meaning as commonly understood by one of ordinary skill in the art to which example embodiments belong. It will be further understood that terms, e.g., those defined in commonly used dictionaries, should be interpreted as having a meaning that is consistent with their meaning in the context of the relevant art and will not be interpreted in an idealized or overly formal sense unless expressly so defined herein.
[0032] As used herein, the singular forms “a,” “an,” and “the,” are intended to include the plural forms as well, unless the context clearly indicates otherwise. As used herein, the terms “and/or” and “at least one of” include any and all combinations of one or more of the associated listed items. It will be further understood that the terms “comprises,” “comprising,” “includes,” and/or “including,” when used herein, specify the presence of stated features, integers, steps, operations, elements, and/or components, but do not preclude the presence or addition of one or more other features, integers, steps, operations, elements, components, and/or groups thereof.
[0033] Unless specifically stated otherwise, or as is apparent from the description, terms such as “processing” or “computing” or “calculating” or “determining” of “displaying” or the like, refer to the action and processes of a computer system, or similar electronic computing device/hardware, that manipulates and transforms data represented as physical, electronic quantities within the computer system's registers and memories into other data similarly represented as physical quantities within the computer system memories or registers or other such information storage, transmission or display devices. Various embodiments of the present invention provide a system and method for dynamically managing API. The present invention is able to ensure that breakage of API calls are avoided, and performance of the APIs are not degraded. The disclosed system and method aim at enhancing API backward compatibility and API versioning. In other words, the present invention provides a unique approach of dynamically managing APIs. Whenever new versions of APIs are introduced to the clients, the clients may improve or may use new versions of APIs without breaking the existing API call. Every service API is configured using configuration template where the API versions are defined along with all service API parameters.
[0034] During API provisioning using the template, the APIs are defined with their versions and pre-defined parameters are configured in real time. The pre-defined parameters may be the one of but not limited to Template File, like Request Protocol, URI, Request Type(Get, POST etc.), Header, Query Param, Communication Type(Rest, Kafka), Database related Information if any(Single, Multiple DB interaction) (like what to get or save in/from DB), Request and Response transformation and manipulation related information, internal third party API Call related information if any(single, Multiple API call), Source Callback related Data, URL Encoding and HTTPS Security related Information, Header and Query Param Transformation and Manipulation Related Data, custom header and Query param related data from Request Body, in case of multiple API Call Sync and Async related information. All the information can be added at runtime.
[0035] FIG. 1 illustrates an exemplary block diagram of an environment (100) for managing one or more APIs, according to various embodiments of the present disclosure. The environment (100) comprises a plurality of user equipment’s (UEs) (102-1, 102-2, ……,102-n). The at least one UE (102-n) from the plurality of the UEs (102-1, 102-2, ……102-n) is configured to connect to a system (108) via a communication network (106). Hereafter, label for the plurality of UEs or one or more UEs is 102.
[0036] In accordance with yet another aspect of the exemplary embodiment, the plurality of UEs (102) may be a wireless device or a communication device that may be a part of the system (108). The wireless device or the UE (102) may include, but are not limited to, a handheld wireless communication device (e.g., a mobile phone, a smart phone, a phablet device, and so on), a wearable computer device (e.g., a head-mounted display computer device, a head-mounted camera device, a wristwatch, a computer device, and so on), a laptop computer, a tablet computer, or another type of portable computer, a media playing device, a portable gaming system, and/or any other type of computer device with wireless communication or Voice Over Internet Protocol (VoIP) capabilities. In an embodiment, the UEs (102) may include, but are not limited to, any electrical, electronic, electro-mechanical or an equipment or a combination of one or more of the above devices such as virtual reality (VR) devices, augmented reality (AR) devices, laptop, a general-purpose computer, desktop, personal digital assistant, tablet computer, mainframe computer, or any other computing device, where the computing device may include one or more in-built or externally coupled accessories including, but not limited to, a visual aid device such as camera, audio aid, a microphone, a keyboard, input devices for receiving input from a user such as touch pad, touch enabled screen, electronic pen and the like. It may be appreciated that the UEs (102) may not be restricted to the mentioned devices and various other devices may be used. A person skilled in the art will appreciate that the plurality of UEs (102) may include a fixed landline, and a landline with assigned extension within the communication network (106).
[0037] The communication network (106), may use one or more communication interfaces/protocols such as, for example, Voice Over Internet Protocol (VoIP), 802.11 (Wi-Fi), 802.15 (including Bluetooth™), 802.16 (Wi-Max), 802.22, Cellular standards such as Code Division Multiple Access (CDMA), CDMA2000, Wideband CDMA (WCDMA), Radio Frequency Identification (e.g., RFID), Infrared, laser, Near Field Magnetics, etc.
[0038] The communication network (106) includes, by way of example but not limitation, one or more of a wireless network, a wired network, an internet, an intranet, a public network, a private network, a packet-switched network, a circuit-switched network, an ad hoc network, an infrastructure network, a Public-Switched Telephone Network (PSTN), a cable network, a cellular network, a satellite network, a fiber optic network, or some combination thereof. The communication network (106) may include, but is not limited to, a Third Generation (3G) network, a Fourth Generation (4G) network, a Fifth Generation (5G) network, a Sixth Generation (6G) network, a New Radio (NR) network, a Narrow Band Internet of Things (NB-IoT) network, an Open Radio Access Network (O-RAN), and the like.
[0039] The communication network (106) may also include, by way of example but not limitation, at least a portion of one or more networks having one or more nodes that transmit, receive, forward, generate, buffer, store, route, switch, process, or a combination thereof, etc. one or more messages, packets, signals, waves, voltage or current levels, some combination thereof, or so forth. The communication network (106) may also include, by way of example but not limitation, one or more of a wireless network, a wired network, an internet, an intranet, a public network, a private network, a packet-switched network, a circuit-switched network, an ad hoc network, an infrastructure network, a Public-Switched Telephone Network (PSTN), a cable network, a cellular network, a satellite network, a fiber optic network, a VOIP or some combination thereof.
[0040] One or more network elements can be, for example, but not limited to a base station that is located in the fixed or stationary part of the communication network (106). The base station may correspond to a remote radio head, a transmission point, an access point or access node, a macro cell, a small cell, a micro cell, a femto cell, a metro cell. The base station enables transmission of radio signals to the UE (102) or a mobile transceiver. Such a radio signal may comply with radio signals as, for example, standardized by a 3rd Generation Partnership Project (3GPP) or, generally, in line with one or more of the above listed systems. Thus, a base station may correspond to a NodeB, an eNodeB, a Base Transceiver Station (BTS), an access point, a remote radio head, a transmission point, which may be further divided into a remote unit and a central unit. The 3GPP specifications cover cellular telecommunications technologies, including radio access, core network, and service capabilities, which provide a complete system description for mobile telecommunications.
[0041] The system (108) is communicatively coupled to a server (104) via the communication network (106). The server (104) can be, for example, but not limited to a standalone server, a server blade, a server rack, an application server, a bank of servers, a business telephony application server (BTAS), a server farm, a cloud server, an edge server, home server, a virtualized server, one or more processors executing code to function as a server, or the like. In an implementation, the server (104) may operate at various entities or a single entity (include, but is not limited to, a vendor side, a service provider side, a network operator side, a company side, an organization side, a university side, a lab facility side, a business enterprise side, a defense facility side, or any other facility) that provides service.
[0042] The environment (100) further includes the system (108) communicably coupled to the server (e.g., remote server or the like) (104) and each UE of the plurality of UEs (102) via the communication network (106). The remote server (104) is configured to execute the requests in the communication network (106).
[0043] The system (108) is adapted to be embedded within the remote server (104) or is embedded as an individual entity. The system (108) is designed to provide a centralized and unified view of data and facilitate efficient business operations. The system (108) is authorized to access to update/create/delete one or more parameters of their relationship between the requests for the API service, which gets reflected in real-time independent of the complexity of network.
[0044] In another embodiment, the system (108) may include an enterprise provisioning server (for example), which may connect with the remote server (104). The enterprise provisioning server provides flexibility for enterprises, ecommerce, finance to update/create/delete information related to the requests for the API service in real time as per their business needs. A user with administrator rights can access and retrieve the requests for the API service and perform real-time analysis in the system (108).
[0045] The system (108) may include, by way of example but not limitation, one or more of a standalone server, a server blade, a server rack, a bank of servers, a business telephony application server (BTAS), a server farm, hardware supporting a part of a cloud service or system, a home server, hardware running a virtualized server, one or more processors executing code to function as a server, one or more machines performing server-side functionality as described herein, at least a portion of any of the above, some combination thereof. In an implementation, system (108) may operate at various entities or single entity (for example include, but is not limited to, a vendor side, service provider side, a network operator side, a company side, an organization side, a university side, a lab facility side, a business enterprise side, ecommerce side, finance side, a defense facility side, or any other facility) that provides service.
[0046] However, for the purpose of description, the system (108) is described as an integral part of the remote server (104), without deviating from the scope of the present disclosure. Operational and construction features of the system (108) will be explained in detail with respect to the following figures.
[0047] FIG. 2 illustrates a block diagram of the system (108) provided for managing the one or more APIs, according to one or more embodiments of the present invention. As per the illustrated embodiment, the system (108) includes the one or more processors (202), the memory (204), an input/output interface unit (206), a display (208), an input device (210), and the database (214). Further the system (108) may comprise one or more processors (202). The one or more processors (202), hereinafter referred to as the processor (202) may be implemented as one or more microprocessors, microcomputers, microcontrollers, digital signal processors, central processing units, state machines, logic circuitries, single board computers, and/or any devices that manipulate signals based on operational instructions. As per the illustrated embodiment, the system (108) includes one processor. However, it is to be noted that the system (108) may include multiple processors as per the requirement and without deviating from the scope of the present disclosure.
[0048] An information related to the request related to the API service may be provided or stored in the memory (204) of the system (108). Among other capabilities, the processor (202) is configured to fetch and execute computer-readable instructions stored in the memory (204). The memory (204) may be configured to store one or more computer-readable instructions or routines in a non-transitory computer-readable storage medium, which may be fetched and executed to create or share data packets over a network service. The memory (204) may include any non-transitory storage device including, for example, volatile memory such as RAM, or non-volatile memory such as disk memory, EPROMs, FLASH memory, unalterable memory, and the like.
[0049] The memory (204) may comprise any non-transitory storage device including, for example, volatile memory such as Random-Access Memory (RAM), or non-volatile memory such as Electrically Erasable Programmable Read-only Memory (EPROM), flash memory, and the like. In an embodiment, the system (108) may include an interface(s). The interface(s) may comprise a variety of interfaces, for example, interfaces for data input and output devices, referred to as input/output (I/O) devices, storage devices, and the like. The interface(s) may facilitate communication for the system. The interface(s) may also provide a communication pathway for one or more components of the system. Examples of such components include, but are not limited to, processing unit/engine(s) and the database (214). The processing unit/engine(s) may be implemented as a combination of hardware and programming (for example, programmable instructions) to implement one or more functionalities of the processing engine(s).
[0050] The information related to the requests related to the API service may further be configured to render on the user interface (206). The user interface (206) may include functionality similar to at least a portion of functionality implemented by one or more computer system interfaces such as those described herein and/or generally known to one having ordinary skill in the art. The user interface (206) may be rendered on the display (208), implemented using Liquid Crystal Display (LCD) display technology, Organic Light-Emitting Diode (OLED) display technology, and/or other types of conventional display technology. The display (208) may be integrated within the system (108) or connected externally. Further the input device(s) (210) may include, but not limited to, keyboard, buttons, scroll wheels, cursors, touchscreen sensors, audio command interfaces, magnetic strip reader, optical scanner, etc.
[0051] The database (214) may be communicably connected to the processor (202) and the memory (204). The database (214) may be configured to store and retrieve the request pertaining to features, or services or workflow of the system (108), access rights, attributes, approved list, and authentication data provided by an administrator. In another embodiment, the database (214) may be outside the system (108) and communicated through a wired medium and a wireless medium.
[0052] Further, the processor (202), in an embodiment, may be implemented as a combination of hardware and programming (for example, programmable instructions) to implement one or more functionalities of the processor (202). In the examples described herein, such combinations of hardware and programming may be implemented in several different ways. For example, the programming for the processor (202) may be processor-executable instructions stored on a non-transitory machine-readable storage medium and the hardware for the processor (202) may comprise a processing resource (for example, one or more processors), to execute such instructions. In the present examples, the memory (204) may store instructions that, when executed by the processing resource, implement the processor (202). In such examples, the system (108) may comprise the memory (204) storing the instructions and the processing resource to execute the instructions, or the memory (204) may be separate but accessible to the system (108) and the processing resource. In other examples, the processor (202) may be implemented by an electronic circuitry.
[0053] In order for the system (108) to manage the one or more APIs, the processor (202) includes a provisioning unit (216), a configuration unit (218), a storing unit (220), a selection unit (222), the transceiver (224) and an API service providing unit (226). The provisioning unit (216), the configuration unit (218), the storing unit (220), the selection unit (222), the transceiver (224) and the API service providing unit (226) may be implemented as a combination of hardware and programming (for example, programmable instructions) to implement one or more functionalities of the processor (202). In the examples described herein, such combinations of hardware and programming may be implemented in several different ways. For example, the programming for the processor (202) may be processor-executable instructions stored on a non-transitory machine-readable storage medium and the hardware for the processor (202) may comprise a processing resource (for example, one or more processors), to execute such instructions. In the present examples, the memory (204) may store instructions that, when executed by the processing resource, implement the processor. In such examples, the system (108) may comprise the memory (204) storing the instructions and the processing resource to execute the instructions, or the memory (204) may be separate but accessible to the system (108) and the processing resource. In other examples, the processor (202) may be implemented by the electronic circuitry.
[0054] In order for the system (108) to manage the one or more APIs, the provisioning unit (216), the configuration unit (218), the storing unit (220), the selection unit (222), the transceiver (224) and the API service providing unit (226) are communicably coupled to each other. The provisioning unit (216) provisions templates corresponding to the one or more APIs. In an embodiment, the provisioning unit (216) is responsible for creating, configuring, and managing API instances based on predefined templates. The templates define the configuration, resources, and settings needed for the APIs to function correctly. Let's consider a scenario where a company is deploying multiple APIs for a new application. These APIs include a user management API, a payment processing API, and a reporting API. Each API has specific configuration requirements such as authentication methods, rate limits, and endpoint settings that are handled by the provisioning unit (216).
[0055] The configuration unit (218) configures each of the one or more API templates with an at least one version. Each of the at least one version includes one or more of a structural parameter and one or more of behavioral parameters. The structural parameters and behavioral parameters are configurations associated with API templates. The structural parameters and behavioral parameters help define how the API behaves and operates within the communication network (106).
[0056] The structural parameters are settings related to the structural aspects of the API, including its architecture and resource allocation. The structural parameters dictate how the API is configured in terms of infrastructure and technical setup.
[0057] The structural parameters includes an endpoint configuration, resource limits and authentication method. The endpoint configuration specifies a base URL and endpoints of the API. The resource limits defines limits on resource usage such as maximum requests per minute or maximum data payload size. The authentication method indicates details the type of authentication used (e.g., OAuth2, API key or the like).
[0058] The behavioural parameters control the operational behavior of the API, including its interactions, response handling, and operational rules. The behavioral parameters includes caching policies and error handling. The caching policies determines how responses are cached to improve performance. The error handling defines how different types of errors are handled and communicated to the client. For example, returning a 404 status code for unknown endpoints or a 500 status code for internal server errors.
[0059] In an example, the configuration unit (218) sets up the API instances with the settings from version 1.0. This includes configuring the endpoints, applying the rate limits, and setting the caching policies as defined. For the updated Version 2.0, the configuration unit (218) applies new settings, such as the updated base URL, enhanced rate limits, and changed authentication methods.
[0060] In an embodiment, upon the configuration of the one or more API templates with the at least one version, the configuration unit (218) configures the one or more API templates with a corresponding end point. Each of the one or more provisioned API templates includes data pertaining to each of the one or more APIs, the data comprises at least one of, protocol types and ports. Each of the at least one version includes a corresponding set of parameters. The set of parameters includes at least a request protocol, a Uniform Resource Locator (URL), a request type, a header, a query parameter, a communication type, and a database related information.
[0061] The storing unit (220) stores the one or more API templates of the one or more APIs in an API repository. The selection unit (222) selects at least one of the one or more API templates of the one or more APIs from the API repository upon receipt of the API call. The API call is initiated by the user via the UE (102). In an example, The selection unit (222) is crucial for ensuring that the correct API version and configuration are used to handle the request. The API repository stores various API templates, which define different configurations and versions of APIs.
In an example, the selection unit (222) finds multiple versions of the current weather API template in the repository. For example: current weather API v1.0 includes basic weather data and current weather API v2.0 includes additional data fields like UV index and air quality. The selection unit (222) selects the appropriate version based on additional criteria such as the API version specified in the request, the user’s subscription level, or the latest available version.
[0062] The transceiver transmits a request to an API service providing unit (224) upon selection of the at least one of the one or more API templates of the one or more APIs. The request includes information pertaining to the at least one version of the one or more selected API templates required to be retrieved from the API repository. The API service providing unit (224) is included in the system (108) or is operated from an external system (not shown).
[0063] The transceiver (224) receives a response from the API service providing unit indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user. In an example, a user application sends a request to access a specific API template for fetching current weather data. The transceiver (224) forwards the request to the API service providing unit (226). The API service providing unit (226) checks its repository and determines the availability of the requested API template. For instance, it might find that the requested API template for "Current Weather API v2.0" is not available. Further, The API service providing unit (226) sends a response back to the transceiver (224) indicating the status of the API template availability. The example for managing one or more APIs is explained in FIG. 4 to FIG. 6.
[0064] FIG. 3 is an example schematic representation of the system (300) of FIG. 1 in which various entities operations are explained, according to various embodiments of the present system. It is to be noted that the embodiment with respect to FIG. 3 will be explained with respect to the first UE (102-1) and the system (108) for the purpose of description and illustration and should nowhere be construed as limited to the scope of the present disclosure.
[0065] As mentioned earlier, the first UE (102-1) includes one or more primary processors (305) communicably coupled to the one or more processors (202) of the system (108). The one or more primary processors (305) are coupled with a memory (310) storing instructions which are executed by the one or more primary processors (305). Execution of the stored instructions by the one or more primary processors (305) enables the UE (102-1). The execution of the stored instructions by the one or more primary processors (305) further enables the UE (102-1) to execute the requests in the communication network (106).
[0066] As mentioned earlier, the one or more processors (202) is configured to transmit a response content related to the API call request to the UE (102-1). More specifically, the one or more processors (202) of the system (108) is configured to transmit the response content to at least one of the UE (102-1). A kernel (315) is a core component serving as the primary interface between hardware components of the UE (102-1) and the system (108). The kernel (315) is configured to provide the plurality of response contents hosted on the system (108) to access resources available in the communication network (106). The resources include one of a Central Processing Unit (CPU), memory components such as Random Access Memory (RAM) and Read Only Memory (ROM).
[0067] As per the illustrated embodiment, the system (108) includes the one or more processors (202), the memory (204), the input/output interface unit (206), the display (208), and the input device (210). The operations and functions of the one or more processors (202), the memory (204), the input/output interface unit (206), the display (208), and the input device (210) are already explained in FIG. 2. For the sake of brevity, we are not explaining the same operations (or repeated information) in the patent disclosure. Further, the processor (202) includes provisioning unit (216), the configuration unit (218), the storing unit (220), the selection unit (222), the transceiver (224) and the API service providing unit (226). The operations and functions of the provisioning unit (216), the configuration unit (218), the storing unit (220), the selection unit (222), the transceiver (224) and the API service providing unit (226) are already explained in FIG. 2. For the sake of brevity, we are not explaining the same operations (or repeated information) in the patent disclosure.
[0068] FIG. 4 is an exemplary flow diagram (400) illustrating the method for managing one or more APIs, according to various embodiments of the present disclosure.
[0069] At step 402, the method includes provisioning one or more templates corresponding to the one or more APIs. In an embodiment, the method allows the provisioning unit (216) provision the templates corresponding to the one or more APIs.
[0070] At step 404, the method includes configuring each of the one or more API templates with an at least one version. Each of the at least one version includes one or more of structural parameters and one or more behavioral parameters. In an embodiment, the method allows the configuration unit (218) to configure each of the one or more API templates with an at least one version.
[0071] At step 406, the method includes storing the one or more API templates of the one or more APIs in an API repository. In an embodiment, the method allows the storing unit (220) to store the one or more API templates of the one or more APIs in an API repository.
[0072] At step 408, the method includes selecting at least one of the one or more API templates of the one or more APIs from the API repository upon receipt of an API call. In an embodiment, the method allows the selection unit (222) to select at least one of the one or more API templates of the one or more APIs from the API repository upon receipt of an API call.
[0073] At step 410, the method includes transmitting a request to an API service providing unit upon selection of the at least one of the one or more API templates of the one or more APIs. In an embodiment, the method allows the transceiver (224) to transmit the request to an API service providing unit upon selection of the at least one of the one or more API templates of the one or more APIs.
[0074] At step 412, the method includes receiving a response from the API service providing unit indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user. In an embodiment, the method allows the transceiver (224) to receive a response from the API service provider indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user.
[0075] FIG. 5 is an example flow diagram (500) illustrating an internal call flow for managing the one or more APIs, in accordance with some embodiments.
[0076] At 502, the method includes adding the new API and configuring the newly added API with all required interface details. For example, the new API may be added by the developer and the newly added API is configured with a Common Application Programming Interface Framework (CAPIF) (628) with all the interface details. The interface details may include all the parameters that are defined in the API template such as but not limited to, protocol versions, ports etc.
[0077] At step 504, the method includes configuring newly added API with at least one of the available versions in the marketplace platform (606). In an embodiment, there may be multiple versions of API, and each version having different parameters available in the marketplace platform (606). These parameters of at least one of the available versions of the API are configured in the API template. For example, the parameters required for utilizing version V1 of the API are configured in the API template.
[0078] At step 506, the method includes configuring API provider endpoint details to the newly added API. For example, an API endpoint is a specific location within an API that accepts requests and sends back responses. If the API provider (636a-636n) includes FQDN (fully qualified domain name) then FQDN is configured, or IP ports are configured to the newly added API.
[0079] At step 508, the method includes storing newly added API at an API repository. For explanation sake, after all the configurations in the API template are completed for the newly added API, the newly added API is stored at the API repository so that the consumer can explore the newly added API. This newly added API is also stored in Market place 124.
[0080] At step 510, the method includes initiating API service call. For example, a consumer may initiate an API call after purchasing the API from the Market place 124.
[0081] At step 512, the method includes selecting an appropriate version of the newly added API from the marketplace. For example, the system may select the appropriate API version depending on the consumer’s call. The appropriate API version and the respective API template is extracted from the API repository.
[0082] At step 514, the method includes calling the appropriate API service provider to request the appropriate version of the newly added API from the marketplace.
[0083] At step 516, the method includes output/transmitting the response provided by the API service provider in relation to the appropriate version of the newly added API. In an embodiment, based on the requested API version by the consumer. The API provider (636a-636n) transmits an output to the consumer. The output may be the response for the consumer that now the consumer may use selected version of the API.
[0084] FIG. 6 illustrates an example system architecture (600) for managing the one or more APIs, in accordance with some embodiments. In the example system architecture (600), the API consumer (602a, 602b) is any application that developers or enterprise want to use this API for their use cases. The CAPIF (628) is included in a common API gateway (626) for the API consumer (602a, 602b), API repository for API providers (636a-636n) and also deals with security and authorization. The common API gateway (626) typically performs request processing based on defined policies, including authentication, authorization, access control, Secure Sockets Layer (SSL)/ Transport Layer Security (TLS) offloading, routing, and load balancing.
[0085] An Access Management System (AMS) (630) performs plan check, access control policy check, and enrichment of the API call request. An Elastic Load Balancer (ELB) (632) provides functionality to route the API call request to a destination application based on rules like round robin, context-based routing, header-based routing, or TCP based routing. An Identity and Access Management (IAM) (634) is responsible for identity and access management related to the API call request.
[0086] A persistent database (620) is a database for all persistent records. The persistent database (620) is scalable, documents oriented, and a schema free database. A cache database (622) is an in-memory data structure store, used as a database, cache, and message broker. The cache database (622) supports almost all types of data structure to store data.
[0087] A UI API Dashboard (624) is an UI of the CAPIF (628) where rich user interface is available to visualize the data and perform configuration. The API providers (636a-636n) is an application that hosts the APIs and use the CAPIF (628) to expose their APIs. A troubleshooting platform (e.g., ATOM or the like) (610) is responsible for Artificial Intelligence/Machine Learning (AI/ML) decisions.
[0088] A marketplace platform (606) is a platform which is available in public domain. Here, the API consumer (602a, 602b) can create account and login with credentials. After login, the user can explore API repository and purchase the APIs. A subscription engine (604) is a backend application of the marketplace platform (606) where all user related data along with their subscription details are stored. An Element Management System (EMS) (612) is responsible for FCAPS management.
[0089] One cache is a unified data cache/data store that temporarily stores historical data, intermediate results, or patterns related to the API's performance and usage and connected with a Subscriber Identity Module (SIM) SWAP API (614). The common API gateway (626) hosts the SIM swap API (614). The SIM swap API (614) refers to an interface that allows an application to interact with services related to the process of swapping or updating SIM cards for the UEs (102). The SIM SWAP API (614) is often used to detect and manage anomalies associated with SIM card swaps, which can be a security risk and a sign of potential fraud.
[0090] The system includes the Common API gateway (626) having the CAPIF (628). At the consumer end, the API consumers (e.g. a developer, a playground, an enterprise, etc.) (602a, 602b) can onboard themselves to the CAPIF (628) and the CAPIF (628) may manage the onboarding process. Separate API providers may exist (such as API provider 1, API provider 2, API provider 3). Further, services like SIM SWAP and all other offline services may be made available to the consumer. This section communicates with the common API gateway (626) in order to expose its APIs, and is connected with an Element Management System (EMS) (612) for backup and for restoring all details. The EMS (612) is communicably connected with the CAPIF (628) for backup and restore. The EMS (612) enhances the operational efficiency of the API services by providing comprehensive management capabilities, ensuring that the APIs are performant, secure, and reliable. This complete platform is a marketplace or subscription engine (604) from where the consumer can purchase the API if they want 5G related API, 4G related API, or any other kind of API. Therefore, the consumer may register with the marketplace platform (606), which is publicly available via on the internet. The consumers can register and onboard themselves, and explore the available APIs which are available in the API gateway. Further, the consumer can purchase those APIs and choose the plan, and then use those APIs in their application.
[0091] The troubleshooting platform (610) is a separate system which analyzes all the Call Detail Record (CDR) or all these status code. The CDR provides detailed records of call activities for various purposes such as billing, fraud detection, network management, and customer service. As such, the troubleshooting platform (610) is a tool that provides analysis to the API analyzer, which is a part of the common API gateway (626), and can be used for performing early prediction of any exceptions. The UI API dashboard (624) is an angular based dashboard from where all the available data can be seen from where all APIs can be managed. The common API gateway (626) performs operations (like CAPIF (628), AMS (630), elastic load balance (ELB) (632), IAM (634)) in combination with the troubleshooting platform (610). The common API gateway (626) is connected with the API analytics unit (608) and the UI API dashboard (624). The CAPIF (628) is connected with a SSA Exposure function (614), a SIM swap API data collector microservice (SSA DC MS) (616) and a streaming platform (618). The SSA DC MS (616) refers to a specialized microservice designed to gather, process, and manage data related to SIM swap events through API interactions. The microservice acts as a crucial part of a broader system for detecting, monitoring, and responding to potential SIM swap incidents. The SIM Swap API is the core interface that the microservice interacts with. The SIM Swap API communicates with mobile network operators or third-party databases to query information about SIM cards, such as whether a SIM has been recently swapped.
[0092] For example, let us consider that a consumer may request or API call for a specific service and a consumer is using a particular API for that API call. If any new version which is better than the current API version of that API is available, then the consumer may switch to that new version of API without breaking the existing API call. This switching to the new version of API without breaking the existing API call may be done by the CAPIF (628) using the AI/ML model. In order to use the new version of the APIs the parameters in the API template can be configured in real time.
[0093] Below is the technical advancement of the present invention:
[0094] The method can be used to support for all API versioning. The method enables the forward/backward compatibility of service APIs. The method enables runtime configuration that leads to zero down time. Based on the proposed method, the consumer can switch between API version with no impact on the CAPIF. Request and response data format can be transformed as per API version. The API providers and the API version mapping can be maintained at the CAPIF and the same can be informed to the consumer. The present invention is able to ensure that breakage of API calls are avoided, and performance of the APIs are not degraded. The disclosed system and method aim at enhancing API backward compatibility and API versioning. The present invention provides a unique approach to dynamically managing APIs. Whenever new versions of APIs are introduced to the clients, the clients may improve or may use new versions of APIs without breaking the existing API call.
[0095] A person of ordinary skill in the art will readily ascertain that the illustrated embodiments and steps in description and drawings (FIGS. 1-6) are set out to explain the exemplary embodiments shown, and it should be anticipated that ongoing technological development will change the manner in which particular functions are performed. These examples are presented herein for purposes of illustration, and not limitation. Further, the boundaries of the functional building blocks have been arbitrarily defined herein for the convenience of the description. Alternative boundaries can be defined so long as the specified functions and relationships thereof are appropriately performed. Alternatives (including equivalents, extensions, variations, deviations, etc., of those described herein) will be apparent to persons skilled in the relevant art(s) based on the teachings contained herein. Such alternatives fall within the scope and spirit of the disclosed embodiments.
[0096] Method steps: A person of ordinary skill in the art will readily ascertain that the illustrated steps are set out to explain the exemplary embodiments shown, and it should be anticipated that ongoing technological development will change the manner in which particular functions are performed. These examples are presented herein for purposes of illustration, and not limitation. Further, the boundaries of the functional building blocks have been arbitrarily defined herein for the convenience of the description. Alternative boundaries can be defined so long as the specified functions and relationships thereof are appropriately performed. Alternatives (including equivalents, extensions, variations, deviations, etc., of those described herein) will be apparent to persons skilled in the relevant art(s) based on the teachings contained herein. Such alternatives fall within the scope and spirit of the disclosed embodiments.
[0097] The present invention offers multiple advantages over the prior art and the above listed are a few examples to emphasize on some of the advantageous features. The listed advantages are to be read in a non-limiting manner.

REFERENCE NUMERALS
[0098] Environment - 100
[0099] UEs– 102, 102-1-102-n
[00100] Server - 104
[00101] Communication network – 106
[00102] System – 108
[00103] Processor – 202
[00104] Memory – 204
[00105] User Interface – 206
[00106] Display – 208
[00107] Input device – 210
[00108] Database – 214
[00109] Provisioning unit – 216
[00110] Configuration unit – 218
[00111] Storing unit – 220
[00112] Selection unit – 222
[00113] Transceiver – 224
[00114] API service providing unit - 226
[00115] System - 300
[00116] Primary processors -305
[00117] Memory– 310
[00118] Kernel– 315
[00119] Example system architecture - 600
[00120] API consumer – 602a, 602b
[00121] Subscription engine – 604
[00122] Market place platform – 606
[00123] API analytics unit – 608
[00124] Troubleshooting platform – 610
[00125] EMS – 612
[00126] SSA Exposure function – 614
[00127] SSA DC MS – 616
[00128] Streaming platform – 618
[00129] Persistent database - 620
[00130] Cache database - 622
[00131] UI API dashboard - 624
[00132] Common API Gateway – 626
[00133] CAPIF – 628
[00134] AMS – 630
[00135] ELB – 632
[00136] IAM – 634
[00137] API provider - 636a-636n
,CLAIMS:CLAIMS
We Claim:
1. A method of managing one or more Application Programming Interfaces (APIs), the method comprising the steps of:
provisioning, by one or more processors (202), one or more templates corresponding to the one or more APIs;
configuring, by the one or more processors (202), each of the one or more API templates with an at least one version, wherein each of the at least one version includes one or more structural parameters and one or more behavioural parameters;
storing, by the one or more processors (202), the one or more API templates of the one or more APIs in an API repository;
selecting, by the one or more processors (202), at least one of the one or more API templates of the one or more APIs from a API repository upon receipt of an API call;
transmitting, by the one or more processors (202), a request to an API service providing unit (226) upon selection of the at least one of the one or more API templates of the one or more APIs; and
receiving, by the one or more processors (202), a response from the API service providing unit (226) indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user.

2. The method as claimed in claim 1, wherein each of the one or more provisioned API templates includes data pertaining to each of the one or more APIs, the data comprises at least one of, protocol types and ports.

3. The method as claimed in claim 1, wherein each of the at least one version includes a corresponding set of parameters, and wherein the set of parameters comprises at least a request protocol, Uniform Resource Locator (URL), request type, header, query parameter, communication type, database related information, the one or more structural parameters and the one or more behavioural parameters.

4. The method as claimed in claim 3, wherein the one or more structural parameters includes at least one of an endpoint configuration, resource limits and authentication method and wherein the one or more behavioural parameters include at least one of caching policies and error handling.

5. The method as claimed in claim 1, wherein upon the configuration of the one or more API templates with the at least one version, the method comprises the steps of:
configuring, by the one or more processors (202), the one or more API templates with a corresponding end point.

6. The method as claimed in claim 1, wherein the API call is initiated by the user via a user equipment (102).

7. The method as claimed in claim 1, wherein the request includes information pertaining to the at least one version of the one or more selected API templates required to be retrieved from the API repository.

8. A system (108) for managing one or more Application Programming Interfaces (APIs), the system (108) comprising:
a provisioning unit (216) configured to provision, templates corresponding to the one or more APIs;
a configuration unit (218) configured to configure, each of the one or more API templates with an at least one version, wherein each of the at least one version includes one or more structural parameters and one or more of behavioural parameters;
a storing unit (220) configured to store, the one or more API templates of the one or more APIs in an API repository;
a selection unit (222) configured to select, at least one of the one or more API templates of the one or more APIs from an API repository upon receipt of an API call;
a transceiver (224) configured to transmit, a request to an API service providing unit (226) upon selection of the at least one of the one or more API templates of the one or more APIs; and
the transceiver (224) configured to receive a response from the API service providing unit (226) indicating one of availability and non-availability of the one or more API templates for the one or more APIs for a user.

9. The system (108) as claimed in claim 8, wherein each of the one or more provisioned API templates includes data pertaining to each of the one or more APIs, the data comprises at least one of, protocol types and ports.

10. The system (108) as claimed in claim 8, wherein each of the at least one version includes a corresponding set of parameters, and wherein the set of parameters comprises at least a request protocol, Uniform Resource Locator (URL), request type, header, query parameter, communication type, database related information, the one or more structural parameters and the one or more behavioural parameters.

11. The system (108) as claimed in claim 10, wherein the one or more structural parameters includes at least one of an endpoint configuration, resource limits and authentication method and wherein the one or more behavioural parameters include at least one of caching policies and error handling.

12. The system (108) as claimed in claim 8, wherein the configuration unit is configured to configure, the one or more API templates with a corresponding end point.

13. The system (108) as claimed in claim 8, wherein the API call is initiated by the user via a user equipment.

14. The system (108) as claimed in claim 8, wherein the request includes information pertaining to the at least one version of the one or more selected API templates required to be retrieved from the API repository.