Skip to Content
Last modified by Waria on 2026/07/23 10:14
From version 37.1
edited by Waria
on 2026/07/23 10:14
Change comment: There is no comment for this version
To version 28.20
edited by dfirdausy
on 2024/08/07 10:13
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.waria
1 +XWiki.dfirdausy
Content
... ... @@ -1,7 +1,7 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -Welcome to this microlearning module, where we will explore the fundamental concepts of the API Gateway as implemented within the eMagiz platform. This module will provide you with a clear understanding of how the API Gateway functions and its role in managing API integrations effectively.
2 +In this microlearning, we will introduce the key concepts of the API Gateway as eMagiz provides this capability.
3 3  
4 -If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]].
4 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 6  == 1. Prerequisites ==
7 7  
... ... @@ -46,7 +46,7 @@
46 46  * Design an API Gateway
47 47  This is the central phase in the configuration of the API Gateway. The main idea is that the entire Gateway should be configured from the Design phase The front-end Gateway is the part where the external application user(s) can access the specific operation published and where the application user is authorized for. Specific operations can be configured and documented including parameters and response types. In the backend operation provider (an eMagiz system), the actual link to the backend operations can be registered including parameters. Frontend and backend operations can be connected at the moment an operation is exposed in the eMagiz API Gateway. Integrations or message types connected to a backend operation providing system are now able to have operations as child objects to get a better overview of what operations are available. Operations are still the integrations reported in the various parts of eMagiz * the message type becomes more of a group object.
48 48  ** In case the backend service provider has an OpenAPI 3.0 specification available, this can be imported to have everything directly configured. Documentation of what OpenAPI statements are supported can be found in the help texts.
49 -** The authentication methods for the API Gateway can be set - You can determine if your API Gateway can handle OAuth 2.0, Basic Auth and/or API Key. OAuth 2.0 is enabled by default.
49 +** The security method for the entire Gateway can be set - at this moment the eMagiz API Gateway works with API keys that be handed out to application users. Users can be provided with such an API key, and users are assigned certain roles. These roles have in turn access to certain backend operations.
50 50  ** For transformations, the request & reply system messages can be created visually like in the platform. The same goes for the gateway model that can be created visually as well. There is no concept of a CDM message as in the Messaging pattern. The transformation & Enrichment can take place in the standard mapping tooling available. So the concepts of a Request message, Response message, Mapping are available via right-click options in the platform.
51 51  ** Other transformations to reach SOAP/XML-based backend operations are also possible by selecting what format the operation has in the backend operation. This will then automatically ensure the transformation considers the JSON to XML transformation. For other protocol transformations, the XML variant can be used and custom influenced in the Create phase.
52 52   * Create phase for the API gateway
... ... @@ -68,11 +68,11 @@
68 68  
69 69  If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links:
70 70  
71 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
72 -** [[eMagiz API Gateway (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-api-gateway-introduction||target="blank"]]
71 +* [[REST API Tutorial>>https://www.restapitutorial.com/||target="blank"]]
72 +* [[HTTP Standards>>https://www.rfc-editor.org/rfc/rfc9110.html||target="blank"]]
73 +* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
74 +*** [[eMagiz API Gateway (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-api-gateway-introduction||target="blank"]]
73 73  * [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
74 -** [[Discover your integration landscape (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Discover your integration landscape.WebHome||target="blank"]]
75 -*** [[Determining Integration Pattern (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Discover your integration landscape.intermediate-discover-your-integration-landscape-determining-integration-pattern||target="blank"]]
76 76  ** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.API Management.WebHome||target="blank"]]
77 77  ** [[Configuring the API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Configuring the API Gateway.WebHome||target="blank"]]
78 78  ** [[Testing API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.WebHome||target="blank"]]
... ... @@ -82,9 +82,9 @@
82 82  *** [[API Gateway Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-apigw-architecture.WebHome||target="blank"]]
83 83  ** [[Key Concepts API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Key Concepts API Gateway.WebHome||target="blank"]]
84 84  *** [[Considerations for API Gateway or Messaging (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Key Concepts API Gateway.advanced-keyconcepts-apigateway-message-vs-apigateway||target="blank"]]
85 -* [[REST API Tutorial (External)>>https://www.restapitutorial.com/||target="blank"]]
86 -* [[HTTP Standards (External)>>https://www.rfc-editor.org/rfc/rfc9110.html||target="blank"]]
87 -* [[API Gateway Explained (External)>>https://www.youtube.com/embed/8TBXq9SVdL8]]
85 +* [[Expert Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
86 +** [[Securing Data Traffic (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Securing Data Traffic.WebHome||target="blank"]]
87 +*** [[API Gateway Security - External IDP (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Securing Data Traffic.expert-securing-data-traffic-api-gw-security-external-idp||target="blank"]]
88 88  * [[API Gateway (Search Results)>>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"]]
89 89  
90 90  )))((({{toc/}}))){{/container}}{{/container}}