Setting up exit gate

{{container}}{{container layoutStyle="columns"}}(((

In this microlearning, we will focus on setting up the exit gate for the API Gateway.

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.

4

5

Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].

6

7

== 1. Prerequisites ==

8

9

* Basic knowledge of the eMagiz platform

10

11

== 2. Key concepts ==

12

13

This microlearning centers around setting up the exit gate for the API Gateway solution of eMagiz.

14

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

15

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

16

17

The exit gate is created by eMagiz based on the configuration in Design. In passthrough cases, you only need to add authentication.

18

In cases of transformation, you need to specify the outbound component (i.e. HTTP, Web service, JDBC, SFTP, etc.) and the authentication.

19

20

== 3. Setting up exit gate ==

21

22

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.

23

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.

24

25

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.

26

27

eMagiz will generate almost everything for you when you transfer an API integration to Create.

28

There are however some things you need to change depending on the choices made in Design and based on the required authentication method.

29

30

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.

31

32

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.

33

34

In case you have a transformation case you need to configure the outbound component + the accompanying authentication.

35

36

In the most standard case, eMagiz will auto-generate the following flow for you

37

38

[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-exit-gate--auto-generated-flow.png]]