Skip to Content
Last modified by Erik Bakker on 2024/08/23 11:32
From version 32.1
edited by Danniar Firdausy
on 2024/08/07 12:57
Change comment: There is no comment for this version
To version 34.1
edited by Danniar Firdausy
on 2024/08/21 11:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,8 +1,7 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on learning about how you can correctly configure the backend operations.
3 -A crucial part of setting up your (API) Gateway with the help of RESTful services is knowing which backend operations you want to expose with the help of the API Gateway.
2 +In this microlearning, we will explore how to correctly configure backend operations within your API Gateway. Understanding how to properly set up these operations is crucial for effectively utilizing RESTful services and making these backend operations accessible through your API Gateway.
4 4  
5 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
4 +If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
7 7  == 1. Prerequisites ==
8 8  
... ... @@ -11,15 +11,15 @@
11 11  == 2. Key concepts ==
12 12  
13 13  This microlearning centers around configuring a backend operation with the API Gateway solution of eMagiz.
14 -With backend operation we mean: Any action that is available to be executed on an internal system that you want to make publicly available via the API Gateway.
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 16  
14 +* With backend operation we mean: Any action that is available to be executed on an internal system that you want to make publicly available via the API Gateway.
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 17  When setting up your API Gateway integration the process of doing things is to start at the backend operation and based on that expose an operation in the API Gateway.
18 18  
19 19  == 3. Configure a backend operation ==
20 20  
21 -When you look at the conceptual idea of the API Gateway, exposing backend operations via a centralized location to the outside world.
22 -It stands to reason that when you set up your API Gateway (i.e. the front-end facing part) you start with the backend operation you want to expose.
21 +The core concept of an API Gateway is to serve as an interface that centralizes and exposes backend operations to the outside world. It is then logical that, when you set up your API Gateway (i.e., the frontend facing part), you first start with the backend operation you want to expose.
23 23  
24 24  Configuring backend operations is done in the Design phase of eMagiz. When you are in the Design overview you can double click on the backend system that holds the operation(s). This action will show you the following pop-up:
25 25  
... ... @@ -27,7 +27,7 @@
27 27  
28 28  In here you need to fill in the technical name, just as with any other system. Furthermore, you have two decisions to make:
29 29  
30 -* Does the system talk JSON or XML (i.e. which message format)
29 +* Does the system talk JSON or XML (i.e., which message format)
31 31  * Can you specify the backend operations either via an import of the OpenAPI 3.0 spec or via a manual action
32 32  
33 33  If the answer to the above decisions is JSON and yes the default settings are correct you should continue to either import the OpenAPI 3.0 spec or manually configure at least one backend operation.