Skip to Content

Changes for page eMagiz API Gateway

Last modified by Waria on 2026/07/23 10:26
From version 46.1
edited by Erik Bakker
on 2024/08/05 13:53
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
... ... @@ -11,7 +11,7 @@
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  
... ... @@ -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]]
... ... @@ -63,7 +63,8 @@
63 63  == 5. Suggested Additional Readings ==
64 64  
65 65  * [[API Gateway Introduction (External)>>https://www.emagiz.com/en/api-gateway-en/||target="blank"]]
66 -* [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||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"]]
67 67  * [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
68 68  ** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.API Management.WebHome||target="blank"]]
69 69  ** [[Transformations in API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Configuring the API Gateway.WebHome||target="blank"]]
... ... @@ -71,16 +71,14 @@
71 71  * [[Advanced Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
72 72  ** [[Advanced API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.WebHome||target="blank"]]
73 73  ** [[Key Concepts API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Key Concepts API Gateway.WebHome||target="blank"]]
74 -* [[Expert Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
75 -** [[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"]]
76 76  * [[Support (Menu)>>doc:Main.eMagiz Support.WebHome||target="blank"]]
77 77  ** [[Migration Paths (Navigation)>>doc:Main.eMagiz Support.Migration Paths.WebHome||target="blank"]]
78 -*** [[Hosting a custom REST web service (Explanation)>>doc:Main.eMagiz Support.Migration Paths.migration-path-hosting-a-custom-rest-webservice||target="blank"]]
79 79  *** [[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"]]
80 80  * [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
81 81  ** [[Release Notes (Navigation)>>doc:Main.Release Information.Portal.WebHome||target="blank"]]
82 82  ** [[Release Blogs (Navigation)>>doc:Main.Release Information.Release Blogs.WebHome||target="blank"]]
83 -* [[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"]]
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"]]
84 84  
85 85  == 6. Silent demonstration video ==
86 86