Dynamic application programming interface builder

• US 9,860,346 B2
• Filed: 10/14/2015
• Issued: 01/02/2018
• Est. Priority Date: 10/14/2015
• Status: Active Grant

• Current Assignee: ADP, Inc.
• Original Assignee: ADP LLC (ADP, Inc.)
• Inventors: Saheba, Jigesh, Masiero, Roberto A., Espina Carvajal, Isabel
• Primary Examiner(s): DONAGHUE, LARRY D
• Application Number:
  US14/882,952
• Publication Number:
  US 20170111476A1
• Time in Patent Office: 811 Days
• CPC Class Codes: H04L 65/102 Gateways arrangements for connecting between networks having differing types of switching systems, e.g. gateways, H04L12/66
• CPC Class Codes: H04L 67/01 Protocols
• CPC Class Codes: H04L 67/02 based on web technology, e.g. hypertext transfer protocol [HTTP]
• CPC Class Codes: H04L 67/306 User profiles
• CPC Class Codes: H04L 67/56 Provisioning of proxy services store-and-forward switching systems in data switching networks H04L12/54
• CPC Class Codes: H04L 67/561 Adding application-functional data or data for application control, e.g. adding metadata
• CPC Class Codes: H04L 67/562 Brokering proxy services
• CPC Class Codes: H04L 69/22 Parsing or analysis of headers

Abstract

A method beginning with adding new resource to an enterprise system. Responsive to adding, an API builder executed by the computer automatically builds a new API exclusively for the new resource. The new API is configured to manage communications between the new resource and the proxy server based on a context resource identifier provided by the API builder and stored in an identifier data structure. The context resource identifier is to be provided to the gateway in response to a request from the client to access the new resource using a uniform resource identifier that identifies to the new resource. The context resource identifier is static over time within the enterprise. A proxy server uses the context resource identifier to call the new API in order to access the new resource, whereby a speed of communication between the client and the new API is increased.

Claims

1. A method for increasing a speed of access to a new resource in an enterprise system comprising a plurality of existing resources each having a corresponding plurality of existing application programming interfaces (APIs) each configured to communicate with a single proxy server within the enterprise system, the enterprise system further including a gateway in communication with the proxy server, the gateway in communication with a network through which a client accesses the gateway, wherein a client request for a service provided by a resource in the plurality of existing resources is controlled via the gateway, to the proxy server, to one of the plurality of existing APIs, and to the resource, the method comprising:

adding, using a computer, the new resource to the enterprise system;

responsive to adding, automatically building, using an API builder executed by the computer, a new API exclusively for the new resource, the new API configured to manage communications between the new resource and the proxy server based on a context resource identifier provided by the API builder and stored in an identifier data structure, the context resource identifier to be provided to the gateway in response to a request from the client to access the new resource using a uniform resource identifier that identifies to the new resource, wherein the context resource identifier is static over time within the enterprise; and

using, by the proxy server, the context resource identifier to call the new API in order to access the new resource, whereby a speed of communication between the client and the new API is increased.

2. The method of claim 1 further comprising:

requesting, from the new API in response to being called by the proxy server, a response from the new resource.

3. The method of claim 2, wherein requesting is performed using the context resource identifier.

4. The method of claim 2 further comprising:

transmitting the response from the new API to the proxy server.

5. The method of claim 3 further comprising:

transmitting the response from the proxy server to the gateway.

6. The method of claim 4 further comprising:

transmitting the response from the gateway to the client via the network.

7. The method of claim 1 further comprising:

receiving, by the new API, a call for authorization from an authorization manager that is part of the enterprise system;

sending, by the new API, a response to the authorization manager, the response including an authorization indicator and a set of endpoint references that identify an endpoint for the new resource and allow the new resource to be addressed.

8. A computer system configured to increase a speed of access to a new resource in an enterprise system comprising at least one server that is programmed with a plurality of existing resources each having a corresponding plurality of existing application programming interfaces (APIs) each configured to communicate with a single proxy server within the enterprise system, the enterprise system further including a gateway in communication with the proxy server, the gateway in communication with a network through which a client accesses the gateway, wherein a client request for a service provided by a resource in the plurality of existing resources is controlled via the gateway, to the proxy server, to one of the plurality of existing APIs, and to the resource, the computer system comprising:

a processor;

a bus connected to the processor;

a memory connected to the bus, the memory storing program code which, when executed by the processor, is configured to perform a computer implemented method, the program code comprising;

program code for adding, using a computer, the new resource to the enterprise system;

program code for, responsive to adding, automatically building, using an API builder executed by the computer, a new API exclusively for the new resource, the new API configured to manage communications between the new resource and the proxy server based on a context resource identifier provided by the API builder and stored in an identifier data structure, the context resource identifier to be provided to the gateway in response to a request from the client to access the new resource using a uniform resource identifier that identifies to the new resource, wherein the context resource identifier is static over time within the enterprise; and

program code for using, by the proxy server, the context resource identifier to call the new API in order to access the new resource, whereby a speed of communication between the client and the new API is increased.

9. The computer system of claim 8, wherein the program code further comprises:

program code for requesting, from the new API in response to being called by the proxy server, a response from the new resource.

10. The computer system of claim 9, wherein the program code for requesting is uses the context resource identifier.

11. The computer system of claim 9, wherein the program code further comprises:

program code for transmitting the response from the new API to the proxy server.

12. The computer system of claim 10, wherein the program code further comprises:

program code for transmitting the response from the proxy server to the gateway.

13. The computer system of claim 11, wherein the program code further comprises:

program code for transmitting the response from the gateway to the client via the network.

14. The computer system of claim 8, wherein the program code further comprises:

program code for receiving, by the new API, a call for authorization from an authorization manager that is part of the enterprise system;

program code for sending, by the new API, a response to the authorization manager, the response including an authorization indicator and a set of endpoint references that identify an endpoint for the new resource and allow the new resource to be addressed.

15. The computer system of claim 8, wherein adding is performed by a third party provider other than an entity operating the enterprise system.

16. A non-transitory computer readable storage medium storing program code, which when executed by a processor, performs a computer implemented method to increase a speed of access to a new resource in an enterprise system comprising at least one server that is programmed with a plurality of existing resources each having a corresponding plurality of existing application programming interfaces (APIs) each configured to communicate with a single proxy server within the enterprise system, the enterprise system further including a gateway in communication with the proxy server, the gateway in communication with a network through which a client accesses the gateway, wherein a client request for a service provided by a resource in the plurality of existing resources is controlled via the gateway, to the proxy server, to one of the plurality of existing APIs, and to the resource, the program code comprising:

program code for adding, using a computer, the new resource to the enterprise system;

program code for adding, using a computer, the new resource to the enterprise system;

program code for, responsive to adding, automatically building, using an API builder executed by the computer, a new API exclusively for the new resource, the new API configured to manage communications between the new resource and the proxy server based on a context resource identifier provided by the API builder and stored in an identifier data structure, the context resource identifier to be provided to the gateway in response to a request from the client to access the new resource using a uniform resource identifier that identifies to the new resource, wherein the context resource identifier is static over time within the enterprise; and

program code for using, by the proxy server, the context resource identifier to call the new API in order to access the new resource, whereby a speed of communication between the client and the new API is increased.

17. The non-transitory computer readable storage medium of claim 16, wherein the program code further comprises:

program code for requesting, from the new API in response to being called by the proxy server, a response from the new resource.

18. The non-transitory computer readable storage medium of claim 17, wherein the program code for requesting uses the context resource identifier.

19. The non-transitory computer readable storage medium of claim 18, wherein the program code further comprises:

program code for transmitting the response from the new API to the proxy server; and

program code for transmitting the response from the proxy server to the gateway.

20. The non-transitory computer readable storage medium of claim 16, wherein the program code further comprises:

program code for receiving, by the new API, a call for authorization from an authorization manager that is part of the enterprise system; and

program code for sending, by the new API, a response to the authorization manager, the response including an authorization indicator and a set of endpoint references that identify an endpoint for the new resource and allow the new resource to be addressed.