Versioning and cataloging application programming interface (api) specifications
US-2023093370-A1 · Mar 23, 2023 · US
US11748686B1 · US · B1
| Field | Value |
|---|---|
| Publication number | US-11748686-B1 |
| Application number | US-202117364467-A |
| Country | US |
| Kind code | B1 |
| Filing date | Jun 30, 2021 |
| Priority date | Jun 30, 2021 |
| Publication date | Sep 5, 2023 |
| Grant date | Sep 5, 2023 |
A practical reading order for non-experts. Skip the full description unless you need deep technical detail.
What the patent document calls the invention.
A short plain-language summary of the technical disclosure.
Who owns or filed the patent and who is credited as inventor.
Filing, priority, publication, and grant dates set the timeline.
The legal scope of protection — read this for what is actually claimed.
Technology tags used to group this patent with similar filings.
Prior art links and similar publications in this corpus.
Official abstract text for this publication.
A system can be configured to receive an onboarding request for a service and an API associated with the service. An API configuration defining access permissions, API call structures, and available operations can be determined for the service by an onboarding service. The API configuration can be utilized by the onboarding service to register the API with a proxy server such that incoming API calls are redirected to an access endpoint associated with the service. The proxy server enables the service and the API to be updated via the onboarding requests as service modification and API modification can be submitted, validated, and integrated into a service environment due to the proxy server decoupling the API from the service.
Opening claim text (preview).
What is claimed is: 1. A system comprising: one or more processors; and a memory storing one or more instructions that are executable by the one or more processors to perform operations comprising: receiving an onboarding request for a service and an application programming interface (API) associated with the service, the onboarding request including one or more modifications to the service and the API; determining, based on the one or more modifications, an API configuration that enables one or more operations of the service to be accessed by users, wherein the API configuration includes: a service configuration that identifies a server configured to execute the one or more operations of the service, the one or more operations executed based on an API call received by the server; a dimensional configuration that describes permissions for one or more categories of users to generate the API call, cause the one or more operations to executed based on the API call, and cause a proxy server to route the API call to an access endpoint of the service; an operational configuration that includes an API call structure for the API call, wherein the API call structure indicates that the API call includes at least an operation of the one or more operations to be executed and one or more input variables for the operation; registering, based on the API configuration, the service with the server via the proxy server such that the proxy server receives the API call from a user associated with the one or more categories of users and routes the API call to the server based on the API configuration; and validating the one or more modifications to the service and the API via a test case, the test case configured to determine whether the API activates the service and whether the one or more operations generate a report that is based on the one or more input variables provided by the test case. 2. The system as recited in claim 1 , wherein the API is configured to enable the one or more operations of the service to: be accessed by the user based on the permissions granted to the one or more categories of users by the dimensional configuration; be accessed by one or more additional services associated with the service; and access one or more additional operations associated with the one or more additional services. 3. The system as recited in claim 2 , the operations further comprising: determining, based on the test case, whether the one or more operations transmitted an additional API call to the one or more additional operations via the proxy server; and determining whether the one or more additional operations generated an additional API call response transmitted to the one or more operations via the proxy server. 4. The system as recited in claim 2 , the operations further comprising executing the test case by: transmitting, via the proxy server, an additional API call to the one or more additional services; determining that the one or more additional services transmitted the API call to the one or more operations; and determining that the report was generated by the one or more operations and transmitted to the one or more additional services via an API call response. 5. The system as recited in claim 1 , wherein determining the API configuration further comprises: determining, based on the service and the API, whether the service is an existing service and whether the API is an existing API; determining, based on a determination that the service is the existing service, that the one or more modifications are to replace one or more API structures within the existing API; and generating, based on the one or more modifications, an updated API that is registered with the proxy server to replace the existing API. 6. A system comprising: one or more processors; and a memory storing one or more instructions that are executable by the one or more processors to perform operations comprising: receiving a request that is associated with a service, within a service environment, and an application programming interface (API) of the service, the request including one or more modifications; determining, based at least in part on the one or more modifications, an API configuration associated with the service, wherein the API configuration includes: an access endpoint within the service environment that is associated with the service; one or more permissions for the API to transmit an API call from a plurality of service environments and one or more user categories to the access endpoint; and an API call structure for the API call that causes an operation of the service to be executed at the access endpoint; registering, based at least in part on the API configuration, the access endpoint, the one or more permissions, and the API call structure with a proxy server, the proxy server configured to route one or more API calls associated the service to the access endpoint; and validating the one or more modifications and the API based at least in part on a test case configured to transmit the one or more API calls and execution of the operation. 7. The system as recited in claim 6 , wherein the API is configured to: enable a user associated the one or more user categories and one or more additional services to access the operation via proxy server; and enable the operation to transmit an additional API call to one or more additional operations associated with the one or more additional services via the proxy server. 8. The system as recited in claim 6 , wherein validating the one or more modifications further comprises: transmitting, via the proxy server, the one or more API calls configured to submit permission requests for the one or more user categories from the plurality of service environments; determining, based at least in part on one or more API call responses, that the service executed the operation for one or more permitted API calls and blocked one or more denied API calls; and determining that the one or more permitted API calls: caused the operation to generate an output variable; and caused the service to transmit the one or more API call responses associated with the one or more permitted API calls to the test case. 9. The system as recited in claim 6 , wherein validating the one or more modifications further comprises: receiving, at the proxy server, a set of API calls configured to access the operation from one or more additional services associated with one or more additional service environments; determining, based at least in part on the one or more permissions, whether the set of API calls is permitted to be routed to the access endpoint; and causing the proxy server to transmit one or more permitted API calls to the access endpoint. 10. The system as recited in claim 6 , wherein registering the API further comprises: generating, based at least in part on the API configuration, API access information and API operations information, the API access information configured to identify one or more API calls associated with the service and the API operations information configured to identify one or more API call structures and one or more input variables associated with the operation. 11. The system as recited in claim 10 , wherein the API access information and the API operations information are stored within a service lookup database that enables the service and one or more additional services associated with the service environment to be identified. 12. The system as recited in claim 6 , wherein the proxy server is configured to separate the API from the service, the proxy server further configured to enable: the one or more modific
Office automation; Time management · CPC title
Enterprise or organisation modelling · CPC title
Tools and structures for managing or administering access control systems · CPC title
Workflow analysis · CPC title
for test design, e.g. generating new test cases · CPC title
Related publications grouped by family.
Answers are generated from the same data shown on this page.