An IAM-based API integration and management method
By adopting an IAM-based API integration and management approach, compatibility issues during service integration are resolved, the platform's scalability and compatibility are improved, no-code access is achieved, and rapid business system integration is supported.
Patent Information
- Application Number
- CN202311224430.7
- Authority / Receiving Office
- CN · China
- Patent Type
- Patents(China)
- Current Assignee / Owner
- Filing Date
- 2023-09-21
- Publication Date
- 2026-11-17
- Estimated Expiration
- 2043-09-21
AI Technical Summary
Existing technologies have poor scalability during service integration, requiring frequent modifications to the platform framework, resulting in high development and maintenance costs, and significant compatibility issues.
The IAM-based API integration and management approach is adopted. Web services are entered through the IAM platform, interface data is imported using API tools, backend services are created, and plugin groups are associated according to business needs to realize the release and functional enhancement of frontend product services.
It enables no-code integration, reduces the time spent on service integration, improves the platform's scalability and compatibility, supports rapid business system integration, and avoids modifications to the original framework.
Smart Images

Figure CN117240837B_ABST
Abstract
Description
Technical Field
[0001] This invention belongs to the field of Internet service integration management technology, and in particular relates to an API integration and management method based on IAM. Background Technology
[0002] As industrial internet platforms develop their business, the number of subdivided business systems is increasing. With the emergence of new businesses, when the platform needs to take on new business, a separate web application needs to be developed.
[0003] Currently, the common approach to service integration involves merging with the platform's service framework to ensure compatibility with subsystems in terms of authentication, access control, and service management. However, this integration method suffers from poor scalability and may require modifications to the platform's original framework. Most existing service integration methods necessitate hard-coding modifications; each modification to extend business logic requires development and testing time, and the impact on the original system must be considered from an operations and maintenance perspective.
[0004] Therefore, how to solve compatibility issues during service integration and improve the scalability of the platform has become an urgent problem to be solved. Summary of the Invention
[0005] To address the shortcomings of the existing technologies, this invention provides an IAM-based API integration and management method that can solve compatibility issues during service integration and improve platform scalability.
[0006] To solve the above-mentioned technical problems, the present invention adopts the following technical solution: An IAM-based API integration and management method includes the following steps: S1. Enter the developed web services into IAM and fill in the service information; S2. Create a backend service and import the API interface data of the Web service into the backend service using an API tool; S3. Create front-end product services in IAM according to business needs. The product services include at least one product operation. S4. Based on business needs, associate the corresponding backend service APIs with each product operation; based on business needs, select plugin groups for the associated APIs, the plugin groups being used to enhance the functionality of accessing the corresponding APIs. S5. Release products and services through IAM; S6. When a user performs a product operation to use a product service through the front end, a front end request is sent to IAM. IAM parses the product operation corresponding to the front end request, calls the API associated with the product operation, and uses the corresponding plugin group to obtain the request data required by the front end. S7 returns the requested data obtained in S6.
[0007] The principle and beneficial effects of this invention: 1. Using this method, you only need to input the existing web service into the IAM platform and import the API interface data of the web service into the backend service through the API tool to complete the creation of the backend service. This backend service can be viewed as a collection of web service APIs. Afterwards, you can create frontend product services in IAM according to business needs. Specifically, associate each product operation of the product service with the corresponding backend service API according to business needs, and select plugin groups for the associated APIs. This ensures the completeness and effectiveness of the functionality of each product operation. After completing the above operations, you can publish the frontend product service. When using the product service, i.e., when a user performs a product operation through the frontend, they send a frontend request to IAM; then, the IAM platform will parse the product operation corresponding to the frontend request, call the API associated with the product operation, and use the corresponding plugin group. In this way, the required functional operations of the product operation can be realized, and the request data required by the frontend can be obtained.
[0008] This method integrates and manages existing web service APIs through IAM, allowing for the selection of corresponding APIs and plugins to create relevant product services based on the actual needs of new businesses. This enables business expansion on existing platform services. Assuming the APIs are accessible, no-code integration is possible, significantly reducing the time spent on service integration. Compared to existing technologies, it requires no modifications to the platform's original framework and no hard-coding changes. This invention supports the rapid integration of business systems into a unified service framework.
[0009] In summary, this method can solve compatibility issues during service integration and improve the scalability of the platform.
[0010] 2. Using this method, Web service APIs can be used flexibly. Multiple Web service APIs, either all or part of them, can be associated with a single product operation simultaneously, or a single Web service API can be associated with multiple product operations. Web service APIs offer high flexibility and can be associated and used multiple times.
[0011] Preferably, in S1, the service information includes the request address, port, data request parameters, and service forwarding method; the service forwarding method includes the display address and the mapped real service API address; in S4, when associating the API of the corresponding backend service, the associated address is the display address filled in in S1.
[0012] This facilitates centralized management of web services, ensures consistency in the format displayed externally through service forwarding, and also serves to protect the real address.
[0013] Preferably, in S3, when creating a front-end product service, the information filled in includes the front-end address shown to the user and the mapped real front-end web address.
[0014] This method ensures the consistency of the format of the front-end address displayed to users, while also keeping the actual front-end web address confidential.
[0015] Preferably, in S6, when parsing the product operation corresponding to the front-end request according to IAM, the viewer is redirected to the real front-end WEB address it maps to, and then the API associated with the product operation and the plugin group added to the API are parsed; in S6, when calling the API associated with the product operation, the real service API address is found based on the service forwarding method filled in in S1, and then the corresponding API is called.
[0016] In this way, by parsing the product operation, the real service API address of its associated API can be fully invoked, and the plugin group added to its associated API can be used to ensure the validity of the requested data.
[0017] Preferably, the plugin group includes a plugin group for identity recognition and / or traffic control.
[0018] This allows for the reasonable enhancement of the functionality of APIs associated with product operations.
[0019] Preferably, in S2, the API tool is Swagger.
[0020] Compared to other API tools, Swagger supports a visual interface, multiple programming languages, and is feature-rich, providing not only API documentation management but also automatic generation of API test code and mock data. Attached Figure Description
[0021] To make the objectives, technical solutions, and advantages of the invention clearer, the invention will now be described in further detail with reference to the accompanying drawings, wherein: Figure 1 This is a flowchart of the present invention. Detailed Implementation
[0022] The following detailed explanation illustrates the specific implementation methods: Example: like Figure 1 As shown, this embodiment discloses an API integration and management method based on IAM, including the following steps: S1. Enter the developed Web service into IAM and fill in the service information. In specific implementation, the service information filled in includes the request address, port, data request parameters, and service forwarding method; the service forwarding method includes the display address and the mapped real service API address.
[0023] IAM, or Identity and Access Management, is an identity and access management framework based on OAuth2. It features single sign-on, robust authentication management, policy-based centralized authorization and auditing, dynamic authorization, and enterprise manageability. IAM allows you to control which users are authenticated (login) and authorized (have permissions) to use resources. In other words, besides managing web service APIs, this method can also perform user authentication, permission management, and other management operations.
[0024] S2. Create a backend service and import the API interface data of the Web service into the backend service using an API tool.
[0025] This backend service, including service coding and service forwarding methods, serves as the provider of the actual business logic. It is accessed via APIs and added to the platform service through specified service forwarding methods. The API interface, or service interface, includes the API name, request path, method, parameters, and publishing status. For ease of understanding, the backend service can be viewed as a collection of multiple APIs.
[0026] In practice, Swagger is used as the API tool. Compared to other API tools, Swagger supports a visual interface, multiple programming languages, and is feature-rich, providing not only API documentation management but also automatic generation of API test code and mock data.
[0027] S3. Create front-end product services in IAM according to business needs. Each product service includes at least one product operation. Specifically, when creating a front-end product service, the information filled in includes the front-end address displayed to the user and the mapped real front-end web address. This method ensures the consistency of the format of the front-end address displayed to the user while also protecting the confidentiality of the real front-end web address.
[0028] Product operation refers to the specific operational functions displayed to the user. These functions are implemented primarily by referencing their associated APIs and using the selected plugin groups.
[0029] S4. Based on business needs, associate the corresponding backend service APIs for each product operation; based on business needs, select plugin groups for the associated APIs. These plugin groups are used to enhance the functionality of accessing the corresponding APIs. The plugin groups include those for identity recognition and / or traffic control. In practice, the plugin groups can be pre-set by the IAM platform or custom-developed plugin groups. When associating the corresponding backend service API, the associated address is the display address filled in S1.
[0030] This approach allows for the flexible use of Web service APIs. Multiple Web service APIs, in whole or in part, can be associated with a single product operation, or a single Web service API can be associated with multiple product operations. Web service APIs offer excellent flexibility and can be used repeatedly.
[0031] S5. Publish products and services through IAM.
[0032] S6. When a user performs a product operation to access a product service through the front end, a front end request is sent to IAM. IAM parses the product operation corresponding to the front end request, calls the API associated with the product operation, and uses the corresponding plugin group to obtain the request data required by the front end.
[0033] Specifically, when parsing the product operation corresponding to the front-end request according to IAM, it redirects to the real front-end WEB address it maps to based on the viewed front-end address, and then parses the API associated with the corresponding product operation and the plugin group added to the API; when calling the API associated with the product operation, it finds the real service API address based on the service forwarding method filled in S1, and then calls the corresponding API.
[0034] Essentially, when performing operations on the front end (such as using a specific product operation within a front-end application), IAM parses the product operation corresponding to the front-end request, thereby obtaining the API of the back-end service associated with that product operation and a group of plugins used to enhance the functionality of the API. Then, the API can be called and processed using the plugin group to obtain the request data needed for the user's front-end operation.
[0035] S7 returns the requested data obtained in S6.
[0036] Most existing service integration methods require hard-coding modifications. Each modification to expand business functionality necessitates development and testing time, and the impact on existing systems must be considered for operations and maintenance. This method, however, only requires inputting the existing web service into the IAM platform and importing its API interface data into the backend service via API tools. This backend service can be viewed as a collection of web service APIs. Subsequently, frontend product services can be created in IAM according to business needs. Specifically, each product operation of the product service is associated with the corresponding backend service API, and plugin groups are selected for the associated APIs. This ensures the completeness and effectiveness of each product operation's functionality. After completing these steps, the frontend product service can be published. When using the product service, i.e., when a user performs a product operation through the frontend, a frontend request is sent to IAM. The IAM platform then parses the frontend request to the corresponding product operation, calls the associated API, and uses the corresponding plugin group. In this way, the required functionalities of the product operation are achieved, and the necessary request data is obtained from the frontend. This method integrates and manages the APIs of existing web services through IAM (Integrated Access Management). Based on the actual needs of new businesses, it allows for the selection of corresponding APIs and plugins to form corresponding product services, thus enabling business expansion on existing platform services. This allows for code-free integration, significantly reducing the time spent on service integration, provided the APIs are accessible. Compared to existing technologies, it requires no modification to the platform's original framework or any hard-coded changes. This invention supports the rapid integration of business systems into a unified service framework. This method solves compatibility issues during service integration and improves the platform's scalability.
[0037] Finally, it should be noted that the above embodiments are only used to illustrate the technical solutions of the present invention and not to limit the technical solutions. Those skilled in the art should understand that any modifications or equivalent substitutions to the technical solutions of the present invention without departing from the spirit and scope of the present invention should be covered within the scope of the claims of the present invention.
Claims
1. An IAM-based API integration and management method, characterized in that, Includes the following steps: S1. Enter the developed web services into IAM and fill in the service information; S2. Create a backend service and import the API interface data of the Web service into the backend service using an API tool; S3. Create front-end product services in IAM according to business needs. The product services include at least one product operation. S4. Based on business needs, associate the corresponding backend service APIs with the operations of each product; Based on business needs, select plugin groups for the associated APIs. These plugin groups are used to enhance the functionality of accessing the corresponding APIs. S5. Release products and services through IAM; S6. When a user performs product operations by using the product service through the front end, a front end request is sent to IAM. IAM parses the product operation corresponding to the front-end request, calls the API associated with the product operation and uses the corresponding plugin group to obtain the request data required by the front-end. S7 returns the requested data obtained in S6.
2. The API integration and management method based on IAM as described in claim 1, characterized in that: In S1, the service information includes the request address, port, data request parameters, and service forwarding method; the service forwarding method includes the display address and the mapped real service API address; in S4, when associating the API of the corresponding backend service, the associated address is the display address filled in in S1.
3. The API integration and management method based on IAM as described in claim 2, characterized in that: In S3, when creating a front-end product service, the information you fill in includes the front-end address that users will see, as well as the actual front-end web address that it maps to.
4. The API integration and management method based on IAM as described in claim 3, characterized in that: In S6, when parsing the product operation corresponding to the front-end request based on IAM, the viewer is redirected to the real front-end WEB address it maps to, and then the API associated with the product operation and the plugin group added to the API are parsed. When calling the API associated with a product operation, the actual service API address is found based on the service forwarding method filled in S1, and then the corresponding API is called.
5. The API integration and management method based on IAM as described in claim 1, characterized in that: The plugin group includes plugins for identity recognition and / or traffic control.
6. The API integration and management method based on IAM as described in claim 1, characterized in that: In S2, the API tool is Swagger.
Citation Information
Patent Citations
Micro-service system for task scheduling and task scheduling method
CN115357403A
Graph processing service component in a catalog service platform
US10089676B1
