Last modified by Erik Bakker on 2024/09/02 16:11
From version 27.2
edited by Erik Bakker
on 2024/02/01 08:47
Change comment: Update document after refactoring.
To version 16.1
edited by Erik Bakker
on 2022/06/13 13:31
Change comment: Renamed from xwiki:Migrated Pages fundamentals.eMagiz API Gateway

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -fundamental-emagiz-docs-introduction
Parent
... ... @@ -1,1 +1,0 @@
1 -Main.eMagiz Academy.Fundamentals.WebHome
Content
... ... @@ -1,78 +1,90 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will introduce the eMagiz platform. The focus will be to address the fundamental concepts of the platform. Please refer to other Fundamentals to learn more about related items and look at the relevant microlearnings available to learn how to work in eMagiz.
2 +
3 3  
4 +
5 += eMagiz API Gateway =
6 +
7 +In this microlearning, we will introduce the essential concepts of the eMagiz API Gateway. The focus will be to address the fundamental concepts of this pattern. Please refer to other Fundamentals to learn more about related items and look at the relevant microlearnings available to learn how to configure an API Gateway in eMagiz.
8 +
4 4  Should you have any questions, please get in touch with academy@emagiz.com.
5 5  
6 6  == 1. Prerequisites ==
7 -* Some context on integration platforms will be helpful.
12 +* Some context on API Management will be helpful.
8 8  
14 +
9 9  == 2. Key concepts ==
10 10  All concepts are discussed in the section below.
11 11  
12 -== 3. Introducing eMagiz ==
13 13  
14 -eMagiz is an integration platform as a service (iPaaS) designed to streamline and enhance enterprise integration processes. It provides a comprehensive set of tools and features to connect various applications, systems, and data sources within an organization. The platform facilitates seamless communication and data exchange, enabling businesses to optimize workflows, improve efficiency, and adapt to evolving technological landscapes.
19 +
20 +== 3. Introducing API Gateway ==
15 15  
16 -=== 3.1 What does eMagiz offer ===
22 +The eMagiz API Gateway is the pattern in which a specific entry point is made available for external applications (users). These external applications can connect to this entry point via a series of operations. These operations are listed in a manner that allows this application user to retrieve data or provide data. Users & Roles are managed on a central level to control access to the various data sources.
17 17  
18 -==== 3.1.1 Integration Capabilities ====
19 -eMagiz bridges disparate systems, applications, and databases, allowing for smooth data transfer and communication. It supports cloud-based and on-premises integrations, ensuring flexibility in connecting diverse environments.
24 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-1.png]]
20 20  
21 -==== 3.1.2 Scalability and Flexibility ====
22 -The platform is designed to scale alongside the growing needs of an enterprise. It accommodates a variety of integration scenarios, from simple point-to-point connections to complex, multi-system interactions.
26 +=== 3.1 Entry point for application users ===
27 +The entry point is a REST/JSON-based web service publicly accessible via the eMagiz Cloud for external application users. There is no other type of web service possible, and all the operations inside this web service are all REST/JSON based. In eMagiz, this concept translates into an All Entry flow type.
23 23  
24 -==== 3.1.3 Store Library ====
25 -eMagiz offers a wide array of pre-built connectors for popular applications, databases, and services. These connectors simplify the integration process, reducing development time and effort. Additionally, it allows for easy customization to meet specific business requirements.
29 +=== 3.2 Operations ===
30 +An operation is defined as an entry point in the API Gateway that allows a specific type of interaction with the data exposed. For instance, a user wants to get the data for a particular order or create an order via this entry point. In this example, there will be a GET Order and a POST Order operation. The traditional HTTP operations, such as GET, POST, and PUT, are possible * see the below figure for the complete list.
26 26  
27 -==== 3.1.4 Real-time Monitoring and Analytics ====
28 -The platform provides real-time monitoring tools, allowing enterprises to track the performance of their integrations. Detailed analytics and reporting features enable users to gain insights into system behavior, troubleshoot issues, and optimize processes.
32 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-2.png]]
33 +
34 +=== 3.3 API Providers & Transformation ===
35 +There is a specific system connected to the operation for every operation, which gets the data or processes the data. That system, application, or service is geared towards that specific piece of data and may have its connectivity requirements, security requirement, or data structure. eMagiz will create a particular Exit Gate Flow type so that all these requirements can be appropriately handled. The figure below the Control Tower, Exact, AFAS, and Address validator are the API providers.
29 29  
30 -==== 3.1.5 Best of suite ====
31 -eMagiz leverages three patterns that can be used in unison through a uniform and standardized method. Firstly, it provides an event-driven architecture, enabling organizations to respond rapidly to changes in data or system states. This approach enhances agility and supports the development of responsive, real-time applications. Secondly, the platform provides tools for managing APIs, allowing enterprises to expose and consume APIs securely. This helps the creation of API ecosystems within and outside the organization. Thirdly, it provides the standard functionality of a messaging platform for the seamless exchange of real-time data and events across applications, systems, and services, facilitating efficient communication and coordination to enhance enterprise integration processes.
37 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-4.png]]
32 32  
33 -==== 3.1.6 Security and Compliance ====
34 -Security is a top priority for eMagiz. The platform includes robust security measures, such as encryption and authentication protocols, to safeguard data during transit and at rest. It also assists enterprises in meeting compliance requirements by providing features for auditing and governance.
39 +Each operation can have a Gateway Message and a System message for the specific API. In this way, standard eMagiz transformation tooling is made available to handle content and format transformations in the API Gateway.
35 35  
36 -==== 3.1.7 Collaboration Tools ====
37 -eMagiz offers collaborative features that enable development teams to work together seamlessly. Version control, role-based access, and collaborative workflows enhance integration development and maintenance efficiency.
41 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-5.png]]
38 38  
39 -=== 3.2 What can eMagiz do for you ===
43 +=== 3.4 Interaction type & error handling ===
44 +The API Gateway follows a synchronous pattern which means there is always a request being made to the web service, and that same web service will always provide you with a response. The web service will wait until the backend system delivering the response is ready to send that response.
40 40  
41 -==== 3.1.1 Streamlined Business Processes ====
42 -eMagiz enables enterprises to streamline business processes by connecting various systems and automating data flows. This results in improved operational efficiency and reduced manual intervention.
46 +In all cases, the web service provides a specific response using HTTP response codes (the standard definition used). If a particular HTTP response code is returned that includes a specific error, then the requestor/application user is responsible for handling the returned error. That is by design as the synchronous nature of these request imply that the calling application needs to decide to continue to the next functional step or alike. In any case, it is different and specific for each application user.
43 43  
44 -==== 3.1.2 Accelerated Time-to-Market ====
45 -With a library of pre-built connectors and a visual development environment, eMagiz accelerates the integration development process. This allows enterprises to bring new products and services to market faster.
48 +eMagiz does allow to influence some of these response codes by specific information per HTTP responses codes. Or provide custom responses.
46 46  
47 -==== 3.1.3 Enhanced Data Accuracy ====
48 -By ensuring consistent and timely data exchange between systems, eMagiz contributes to improved data accuracy. This is critical for decision-making processes and maintaining a single source of truth across the organization.
50 +=== 3.5 Centralized User Management ===
51 +In the context of an API Gateway, user management means the mechanism whereby users are granted access to a specific set of operations. User Management in eMagiz can define users and roles. The user will have the access credentials to access the API Gateway in the first place. Options are OAuth2.0 or API Key. Users are assigned a role that defines to what operations access has been given. In this way, the access to the gateway is handled centrally, and the data exposed is adequately protected. Credentials are to be submitted to application users on a separate note.
49 49  
50 -==== 3.1.4 Adaptability to Change ====
51 -eMagiz's event-driven architecture and flexibility in integration scenarios enable enterprises to adapt quickly to changes in business requirements or technology landscapes. This agility is crucial in today's rapidly evolving business environment.
53 +=== 3.6 API Disovery ===
54 +External application users can discover the operations via an online Portal * the SwaggerUI technology is used for that purpose. In that online section, the user can see all the published operations. For operation, all the required information is displayed to understand how to connect to the API correctly. That includes the request and response definitions, parameters, naming, response codes, and many more. Once the credentials have been provided, the application user can try out the operation.
52 52  
53 -==== 3.1.5 Improved Collaboration ====
54 -The collaboration tools provided by eMagiz facilitate better communication and coordination among development teams. This mainly benefits large enterprises with distributed teams working on integration projects.
56 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-3.png]]
55 55  
56 -==== 3.1.6 Enhanced Visibility and Control ====
57 -Real-time monitoring and analytics features empower enterprises to have better visibility into their integration landscape. This leads to proactive issue resolution, improved system performance, and better decision-making.
58 58  
59 -==== 3.1.7 Compliance and Security ====
60 -eMagiz's robust security measures and compliance features help enterprises meet regulatory requirements. This is essential in industries where data privacy and security are paramount concerns.
59 +=== 3.6 Architectural components ===
61 61  
62 -==== 3.1.8 Cost Efficiency ====
63 -The platform's ability to streamline integration processes, reduce development time, and minimize manual efforts contributes to enterprise cost efficiency. It optimizes resource utilization and lowers the total cost of ownership.
61 +A simplified picture below illustrates the overall architecture of API Gateway in the eMagiz Cloud.
64 64  
65 -In conclusion, eMagiz is a versatile and powerful integration platform that empowers enterprises to overcome the challenges of connecting diverse systems and applications. Its comprehensive feature set, collaboration tools, and focus on security make it a valuable asset for organizations aiming to enhance their integration capabilities, drive efficiency, and stay competitive in a dynamic business landscape.
63 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-6.png]]
66 66  
65 +
66 +
67 67  == 4. Key takeaways ==
68 68  
69 -* eMagiz is an integration platform as a service (iPaaS) designed to streamline and enhance enterprise integration processes.
70 -* eMagiz's comprehensive feature set, collaboration tools, and focus on security make it a valuable asset for organizations.
71 -* eMagiz provides a wide array of pre-built components and connectors that accelerate the development of integrations.
72 -* eMagiz leverages a visual development environment that follows a similar workflow regardless of the chosen integration pattern, focusing on clarity, consistency, and reliability.
69 +* API Gateway can serve as a single entry point for all external or intern application users
70 +* API Gateway can simplify the IT landscape by offering a reusable entry point
71 +* API Gateway is a synchronous pattern by default
72 +* API Gateway leverages the standard capability of eMagiz around deployment, transformation, and business owner interaction
73 73  
74 +
75 +
74 74  == 5. Suggested Additional Readings ==
75 75  
76 -* [[eMagiz website>>https://emagiz.com/en/||target="blank"]]
78 +* [API Gateway Introduction](https://www.emagiz.com/en/api-gateway-en/)
79 +* [Crashcourse API Gateway](../microlearning/crashcourse-api-gateway-index.md)
80 +* [API Management](../microlearning/intermediate-api-management-index.md)
81 +* [Transformations in API Gateway](../microlearning/intermediate-configuring-the-api-gateway-index.md)
82 +* [Testing the API Gateway](../microlearning/intermediate-testing-emagiz-api-gateway-index.md)
83 +* [Advanced config API Gateway](../microlearning/advanced-api-management-index.md)
77 77  
85 +
86 +== 6. Silent demonstration video ==
87 +
88 +{{video attachment="fundamental-api-gateway-introduction.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
89 +
78 78  )))((({{toc/}}))){{/container}}{{/container}}
fundamental-api-gateway-introduction-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +131.4 KB
Content
fundamental-api-gateway-introduction-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +21.2 KB
Content
fundamental-api-gateway-introduction-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +125.9 KB
Content
fundamental-api-gateway-introduction-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +13.3 KB
Content
fundamental-api-gateway-introduction-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +191.0 KB
Content
fundamental-api-gateway-introduction-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.ebakker
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content