Skip to Content

Changes for page eMagiz API Gateway

Last modified by Waria on 2026/07/23 10:26
From version 18.1
edited by Erik Bakker
on 2022/06/13 13:35
Change comment: There is no comment for this version
To version 53.1
edited by Waria
on 2026/07/23 10:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.waria
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -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.
2 +The API Gateway serves as the entry point for external applications to interact with specific data sources. It utilizes REST-based web services and provides various operations such as GET and POST for interacting with the data. The Gateway also handles user management and security, ensuring centralized control over access to data sources. Additionally, it features an API discovery portal using SwaggerUI technology, allowing users to explore and test the available operations.
3 3  
4 4  Should you have any questions, please get in touch with academy@emagiz.com.
5 5  
... ... @@ -7,26 +7,26 @@
7 7  * Some context on API Management will be helpful.
8 8  
9 9  == 2. Key concepts ==
10 -All concepts are discussed in the section below.
10 +* Explain API Management within eMagiz
11 11  
12 12  == 3. Introducing API Gateway ==
13 13  
14 -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.
14 +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 are managed on a central level to control access to the various data sources.
15 15  
16 16  [[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-1.png]]
17 17  
18 18  === 3.1 Entry point for application users ===
19 -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.
19 +The entry point is a REST-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 based. In eMagiz, this concept translates into an All Entry flow type.
20 20  
21 21  === 3.2 Operations ===
22 22  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.
23 23  
24 -[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-2.png]]
24 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-2-gen3.png]]
25 25  
26 26  === 3.3 API Providers & Transformation ===
27 -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.
27 +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. In the figure below the Control Tower, Exact, AFAS, and Address validator are the API providers.
28 28  
29 -[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-4.png]]
29 +[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-4-gen3.png]]
30 30  
31 31  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.
32 32  
... ... @@ -40,9 +40,9 @@
40 40  eMagiz does allow to influence some of these response codes by specific information per HTTP responses codes. Or provide custom responses.
41 41  
42 42  === 3.5 Centralized User Management ===
43 -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.
43 +In the context of an API Gateway, user management is the mechanism whereby users (i.e. external systems) are granted permissions to a specific set of operations on your API Gateway. The user gets credentials from eMagiz to access the API Gateway. Whenever a user calls your API Gateway, eMagiz evaluates if the user is allowed to access your API Gateway (authentication) and if the user has the rights to the specific operation they are calling (authorization). In this way, the access to the gateway is handled centrally.
44 44  
45 -=== 3.6 API Disovery ===
45 +=== 3.6 API Discovery ===
46 46  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.
47 47  
48 48  [[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-3.png]]
... ... @@ -62,15 +62,27 @@
62 62  
63 63  == 5. Suggested Additional Readings ==
64 64  
65 -* [[API Gateway Introduction>>https://www.emagiz.com/en/api-gateway-en/||target="blank"]]
66 -* [[Crashcourse API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
67 -* [[API Management>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.API Management.WebHome||target="blank"]]
68 -* [[Transformations in API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Configuring the API Gateway.WebHome||target="blank"]]
69 -* [[Testing the API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.WebHome||target="blank"]]
70 -* [[Advanced config API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.WebHome||target="blank"]]
65 +* [[API Gateway Introduction (External)>>https://www.emagiz.com/en/api-gateway-en/||target="blank"]]
66 +* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
67 +** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
68 +* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
69 +** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.API Management.WebHome||target="blank"]]
70 +** [[Transformations in API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Configuring the API Gateway.WebHome||target="blank"]]
71 +** [[Testing the API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.WebHome||target="blank"]]
72 +* [[Advanced Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
73 +** [[Advanced API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.WebHome||target="blank"]]
74 +** [[Key Concepts API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Key Concepts API Gateway.WebHome||target="blank"]]
75 +* [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
76 +** [[Migration Paths (Navigation)>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]]
77 +*** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Support.Migration Paths.migration-path-emagiz-runtime-generation-3||target="blank"]]
78 +** [[RCA Knowledge Base (Navigation)>>doc:Main.eMagiz Support.RCA Knowledge Base.WebHome||target="blank"]]
79 +* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
80 +** [[Release Notes (Navigation)>>doc:Main.Release Information.Portal.WebHome||target="blank"]]
81 +** [[Release Blogs (Navigation)>>doc:Main.Release Information.Release Blogs.WebHome||target="blank"]]
82 +* [[API Gateway (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22api+gateway%22||target="blank"]]
71 71  
72 72  == 6. Silent demonstration video ==
73 73  
74 -{{video attachment="fundamental-api-gateway-introduction.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
86 +{{video attachment="fundamental-api-gateway-introduction-gen3.mp4" reference="Main.Videos.Fundamental.WebHome"/}}
75 75  
76 76  )))((({{toc/}}))){{/container}}{{/container}}
fundamental-api-gateway-introduction-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -131.4 KB
Content
fundamental-api-gateway-introduction-2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -21.2 KB
Content
fundamental-api-gateway-introduction-3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -125.9 KB
Content
fundamental-api-gateway-introduction-4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -13.3 KB
Content
fundamental-api-gateway-introduction-5.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -191.0 KB
Content
fundamental-api-gateway-introduction-6.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.ebakker
Size
... ... @@ -1,1 +1,0 @@
1 -70.3 KB
Content