Changes for page API Gateway - Introduction

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.ebakker
	1	+XWiki.eMagiz

Default language

...	...	@@ -1,1 +1,0 @@
1		-en

Content

...	...	@@ -3,6 +3,9 @@
3	3
4	4	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
	6	+* Last update: February 21st, 2021
	7	+* Required reading time: 5 minutes
	8	+
6	6	== 1. Prerequisites ==
7	7
8	8	* Basic knowledge of the eMagiz platform
...	...	@@ -15,7 +15,7 @@
15	15	A typical landscape could look like this.
16	16	The API Gateway is located in the secured eMagiz Cloud and provides the ability to access it from external application users. A client of ACME Ltd. could be sending in Sales Orders directly from their systems (incoming integration 1). The incoming Sales order is then delivered back to the back office system of ACME and could send a response back with successful delivery. Inside the ACME Ltd. organization, various development teams are processing the sales order further. One of the things that need to take place is to perform an external credit check of that specific client (integration 2). Service C might be responsible for that and is processing the request/response synchronously.
17	17
18		-[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-introduction--conceptual-overview.png]]
	21	+[[image:Main.Images.Microlearning.WebHome@releasenote-apigw-1.png]]
19	19
20	20	Key considerations when to use the API Gateway integration pattern
21	21
...	...	@@ -34,16 +34,18 @@
34	34	* Dependency between developments should be reduced - less coupled services
35	35	* Access to the same data can come in from many different systems
36	36
	40	+
	41	+
37	37	== 3. Managing your API Gateway in the ILM ==
38	38
39	39	The API Gateway is fully embedded into the eMagiz Low-code Enterprise iPaaS so that users have a similar user experience when configuring the API Gateway, a Messaging integration, or an Event Stream. All the platform features in the different ILM phases can take into account the API Gateway configuration. What is important to realize is that the primary focus of the API Gateway configuration is to allow all configuration work to take place in the Design phase. You will find out that most or often all the Create models are automatically generated. Only in specific cases where specific customization is required, the created objects can be modified. Newly created Designs could result in the rework of the customization in the Create object.
40	40
41		-[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-introduction--phases-of-emagiz.png]]
	46	+[[image:Main.Images.Microlearning.WebHome@releasenote-apigw-2.png]]
42	42
43	43	(% style="list-style-type: lower-roman" %)
44		-* Capture your API Gateway
	49	+1. Capture your API Gateway
45	45	In this phase, the regular operations or message types can be captured with all the necessary information of that specific operation. At the system level, you can indicate that the system acts as a backend service provider that has certain API's available.
46		-* Design an API Gateway
	51	+2. 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	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.
...	...	@@ -68,17 +68,19 @@
68	68
69	69	eMagiz provides an integrated API Gateway in the platform that holds all the required features and is integrated into the overall way of work and cloud architectures of the platform.
70	70
	76	+
	77	+
71	71	== 6. Suggested Additional Readings ==
72	72
73	73	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:
74	74
75		-* [[REST API Tutorial>>https://www.restapitutorial.com/||target="blank"]]
76		-* [[Features of the eMagiz platform>>https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html||target="blank"]]
	82	+* https://www.restapitutorial.com/lessons/httpOperations.html#:~:text=The%20primary%20or%20most%2Dcommonly,but%20are%20utilized%20less%20frequently.
	83	+* https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
77	77
78	78	== 7. Silent demonstration video ==
79	79
80	80	This video provides an introduction to the API Gateway of eMagiz
81	81
82		-[[Link to platform feature API Gateway>>https://www.youtube.com/embed/8TBXq9SVdL8]]
	89	+<iframe width="1907" height="1073" src="https://www.youtube.com/embed/8TBXq9SVdL8" reference="Main.Videos.Microlearning.WebHome"/}}
83	83
84	84	)))((({{toc/}}))){{/container}}{{/container}}