Skip to Content
Version 15.2 by Erik Bakker on 2022/06/13 09:42
Hide last authors
Erik Bakker 14.1 1 {{container}}{{container layoutStyle="columns"}}(((
eMagiz 1.1 2 = Setting up exit gate =
3
4 In this microlearning, we will focus on setting up the exit gate for the API Gateway.
5 This exit gate ensures that the message is delivered to the backend operation and that the response of the backend operation is given back to the client calling the API.
6
Erik Bakker 14.1 7 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
eMagiz 1.1 8
9 * Last update: February 11th, 2021
10 * Required reading time: 3 minutes
11
12 == 1. Prerequisites ==
13
14 * Basic knowledge of the eMagiz platform
15
16 == 2. Key concepts ==
17
18 This microlearning centers around setting up the exit gate for the API Gateway solution of eMagiz.
19 With exit gate, we mean: The piece of functionality that connects to the backend operation to execute the action on behalf of the client that is calling the API
20 With API Gateway we mean: A collection of RESTful API operations that can be published to the outside world to give them access to applications that are linked to your business process
21
22 The exit gate is created by eMagiz based on the configuration in Design. In passthrough cases, you only need to add authentication.
23 In cases of transformation, you need to specify the outbound component (i.e. HTTP, Web service, JDBC, SFTP, etc.) and the authentication.
24
25
26
27 == 3. Setting up exit gate ==
28
29 Each backend operation has a specific exit gate that will handle all incoming traffic, connect to the backend operation and send the response back to the client that is calling the API.
30 The exit gate can process up to five calls at the same time. The moment the response is delivered to client 1, the exit gate will continue with the message of client 6.
31
32 With this setting, we already scale the API Gateway in such a way that it can handle concurrency and peaks in traffic. For most use cases these settings will suffice.
33
34 eMagiz will generate almost everything for you when you transfer an API integration to Create.
35 There are however some things you need to change depending on the choices made in Design and based on the required authentication method.
36
37 In case you have a passthrough case and the authentication method can be handled via a REST template (i.e. basic, OAuth, azure) you only need to configure this specific authentication mechanism.
38
39 In case you have a passthrough case and the authentication cannot be handled via a REST template you need to set up the authentication yourself.
40
41 In case you have a transformation case you need to configure the outbound component + the accompanying authentication.
42
43 In the most standard case, eMagiz will auto-generate the following flow for you
44
Erik Bakker 14.1 45 [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-exit-gate--auto-generated-flow.png]]
eMagiz 1.1 46
47 Just as with the entry gate we try to auto-generate as much as possible to make your life easier the moment you start in the Create phase.
48
49
Erik Bakker 14.1 50
eMagiz 1.1 51 == 4. Assignment ==
52
53 Open the exit flow, add basic authentication as an authentication method, and press Stop Editing.
54 This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
55
56 == 5. Key takeaways ==
57
58 * Each backend operation has a specific exit gate that will
59 * Handle all incoming traffic destined for that backend operation
60 * Connect to the backend operation
61 * Send response back to the client that is calling the API
62 * eMagiz will automatically build the biggest portion of the exit gate for you
63 * Some manual changes are necessary
64
65
66
67 == 6. Suggested Additional Readings ==
68
69 If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
70
71 == 7. Silent demonstration video ==
72
73 This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. Disclaimer, you only see the eMagiz part but if you follow the above steps you are good to go!
74
Erik Bakker 14.1 75 {{video attachment="crashcourse-api-gateway-setting-up-exit-gate.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
eMagiz 1.1 76
Erik Bakker 14.1 77 )))((({{toc/}}))){{/container}}{{/container}}