Application programming interface bridge for transporting a local request from a local client system to a target server system, and method thereof

• US 10,528,759 B2
• Filed: 10/17/2017
• Issued: 01/07/2020
• Est. Priority Date: 10/17/2017
• Status: Active Grant

• Current Assignee: Aagey Holding, LLC
• Original Assignee: Aagey Holding, LLC
• Inventors: Kujawski, Edward T.
• Primary Examiner(s): Hirl, Joseph P
• Assistant Examiner(s): Truvan, Leynna
• Application Number:
  US15/786,544
• Publication Number:
  US 20190114442A1
• Time in Patent Office: 812 Days
• CPC Class Codes: G06F 21/6245 Protecting personal data, e.g. for financial or medical purposes
• CPC Class Codes: G06F 9/5038 considering the execution order of a plurality of tasks, e.g. taking priority or time dependency constraints into consideration scheduling strategies G06F9/4881 and subgroups
• CPC Class Codes: G06F 9/545 where tasks reside in different layers, e.g. user- and kernel-space
• CPC Class Codes: G06F 9/547 Remote procedure calls [RPC]; Web services

Abstract

An API bridge is for transporting a local API request from a local client system to a target server system. The API bridge includes a local API bridge in communication with the local client system, and a remote API bridge in communication with the target server system. The local API bridge is configured to receive the local API request from the local client system and create a first message to be sent to the remote API bridge. The remote API bridge is configured to receive the first message created by the local API bridge and call the target server system with a target API request.

Claims

1. An API bridge device for transporting a local API request from a local client system to a target server system, said API bridge comprising:

a local API bridge in communication with the local client system; and

a remote API bridge in communication with the target server system;

wherein, the local API bridge is configured to receive the local API request from the local client system and create a first message to be sent to the remote API bridge; and

wherein, the remote API bridge is configured to receive the first message created by the local API bridge and call the target server system with a target API request wherein, when the target server system responds to the target API request from the remote API bridge with a target API response, the remote API bridge is configured to create a second message with the target API response;

wherein, the local API bridge is configured to receive the second message created by the remote API bridge and respond to the local client system with a local API response;

wherein the first message created by the local API bridge and the second message created by the remote API bridge are packaged and sent via a messaging system;

wherein the local client system does not receive a response from the target server system until the local API bridge receives the second message from the remote API bridge;

wherein the API bridge device is configured to change authentication methods of the local API request;

wherein the local API bridge is configured to use a first authentication for the local client system, while the remote API bridge is configured to use a second authentication for the target server system;

wherein the API bridge device is configured for support of the local client system and the target server system without any code changes, wherein the API bridge device is configured with an ability to utilize existing API and protocols of both the local client system and the target server system;

wherein the API bridge device is configured to support all future requests over HTTP or HTTPS;

wherein the API bridge device is configured to not interpret content of the HTTP body, and pass the HTTP body without change to the target server system, whereby all future API protocols that use HTTP or HTTPS are supported;

wherein connectivity between the local API bridge and the remote API bridge is encrypted for security; and

wherein the API bridge device is configured for allowing the local client system and the server system to use an insecure version of HTTP.

2. The API bridge device according to claim 1, wherein the API bridge device may be installed on the same hardware as the local client system or the target server system.

3. The API bridge device according to claim 1, wherein the API bridge device is configured to cross the internet.

4. The API bridge device according to claim 1, wherein the API bridge device is configured for use with an existing local client system and an existing target server system without any change to code on the existing local client system and the existing target server system.

5. The API bridge device according to claim 1, wherein the API bridge device is configured to permit access to only the target server system with a secure configuration.

6. The API bridge device according to claim 1, wherein the API bridge device is configured to transmit information between different enterprise LANs while offering an ability to change authentication methods;

wherein the API bridge is configured to deploy the local API bridge and the remote API bridge in different enterprises; and

wherein the different enterprises share API resources without using a VPN or exporting the API resource to the internet.

7. The API bridge device according to claim 1, wherein the API bridge device is configured to monitor API calls between the local client system and the target server system to identify when the local client system and the target server system are operating properly, or to identify when there is unwanted activity.

8. The API bridge device according to claim 1, wherein the API bridge device is configured to forward the local API request when both the local API bridge and the remote API bridge are behind at least one firewall without any available open ports.

9. An API bridge device for transporting a local API request from a local client system to a target server system, said API bridge comprising:

a local API bridge in communication with the local client system; and

a remote API bridge in communication with the target server system;

wherein, the local API bridge is configured to receive the local API request from the local client system and create a first message to be sent to the remote API bridge;

wherein, the remote API bridge is configured to receive the first message created by the local API bridge and call the target server system with a target API request;

wherein, when the target server system responds to the target API request from the remote API bridge with a target API response, the remote API bridge is configured to create a second message with the target API response;

wherein, the local API bridge is configured to receive the second message created by the remote API bridge and respond to the local client system with a local API response having content of the target API response;

wherein the first message created by the local API bridge and the second message created by the remote API bridge are packaged and sent via a messaging system;

wherein the local client system does not receive a response from the target server system until the local API bridge receives the second message from the remote API bridge;

wherein the API bridge device is configured to cross the internet;

wherein the API bridge device is configured to change authentication methods of the local API request, wherein the local API bridge is configured to use a first authentication for the local client system, while the remote API bridge is configured to use a second authentication for the target server system;

wherein the API bridge device is configured for support of the local client system and the target server system without any code changes, wherein the API bridge device is configured with an ability to use existing API and protocols of the local client system and the target server system;

wherein the API bridge device is configured to support all future requests over HTTP or HTTPS, wherein the API bridge is configured to not interpret content of the HTTP body, and pass the HTTP body without change to the target server system, whereby all future API protocols that use HTTP or HTTPS are supported;

wherein the API bridge device is configured for use with an existing local client system and an existing target server system without any change to code on the local client system and target server system;

wherein the API bridge device is configured to permit access to only the target server system with a secure configuration;

wherein the API bridge device is configured to transmit information between different enterprise LANs while offering an ability to change authentication methods, wherein the API bridge device is configured to deploy the local API bridge and the remote API bridge in different enterprises, wherein the different enterprises share API resources without using a VPN or exporting the API resource to the internet;

wherein the connectivity between the local API bridge and the remote API bridge is encrypted for security, wherein the API bridge device is configured for allowing the local client system and the server system to use an insecure version of HTTP when the local client system connects to the API bridge device, or when the API bridge device connects to the target server system;

wherein the API bridge device is configured to monitor the API calls between the local client system and the target server system to identify if the local client system and the target server system are operating properly, or to identify if there is unwanted activity; and

wherein the API bridge device is configured to forward the local API request when both the local API bridge and the remote API bridge are behind at least one firewall without any available open ports.

10. A method for transporting a local API request from a local client system to a target server system comprising:

providing an API bridge device comprising;

a local API bridge in communication with the local client system; and

a remote API bridge in communication with the target server system;

receiving the local API request from the local client system via the local API bridge;

creating a first message to be sent to the remote API bridge via the API bridge device;

receiving the first message created by the local API bridge via the remote API bridge; and

calling the target server system with a target API request via the remote API bridge;

wherein the API bridge is configured to change authentication methods of the local API request, wherein the local API bridge is configured to use a first authentication for the local client system, while the remote API bridge is configured to use a second authentication for the target server system;

wherein the API bridge is configured for support of the local client system and the target server system without any code changes, wherein the API bridge is configured with an ability to use existing API and protocols of the local client system and the target server system;

wherein the API bridge is configured to support all future requests over HTTP or HTTPS, wherein the API bridge is configured to not interpret content of the HTTP body, and pass the HTTP body without change to the target server system, whereby all future API protocols that use HTTP or HTTPS are supported; and

wherein the connectivity between the local API bridge and the remote API bridge is encrypted for security, wherein the API bridge is configured for allowing the local client system and the target server system to use an insecure version of HTTP when the local client system connects to the API bridge, or when the API bridge connects to the target server system.

11. The method according to claim 10, wherein:

the target server system responding to the target API request from the remote API bridge with a target API response;

creating a second message with the target API response via the remote API bridge;

receiving the second message created by the remote API bridge via the local API bridge; and

responding to the local client system with a local API response having content of the target API response via the local API bridge;

wherein, the first message created by the local API bridge and the second message created by the remote API bridge are packaged and sent via a messaging system.

12. The method according to claim 11, wherein the local client system does not receive a response from the target server system until the local API bridge receives the second message from the remote API bridge.

13. The method according to claim 10:

wherein the API bridge is configured to cross the internet;

wherein the API bridge is configured for use with existing local client systems and target server systems without any change to code on the local client system and target server system;

wherein the API bridge is configured to permit access to only the target server system with a secure configuration;

wherein the API bridge is configured to transmit information between different enterprise LANs while offering an ability to change authentication methods, wherein the API bridge is configured to deploy the local API bridge and the remote API bridge in different enterprises, wherein the different enterprises share API resources without using a VPN or exporting the API resource to the internet;

wherein the API bridge is configured to monitor the API calls between the local client system and the target server system to identify when the local client system and the target server system are operating properly, or to identify when there is unwanted activity; and

wherein the API bridge is configured to forward the API request when both the local API bridge and the remote API bridge are behind at least one firewall without any available open ports.