Skip to Content
Last modified by Erik Bakker on 2024/09/03 08:20
From version 2.2
edited by Erik Bakker
on 2022/06/13 10:01
Change comment: Update document after refactoring.
To version 15.1
edited by Carlijn Kokkeler
on 2024/08/29 11:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -advanced-keyconcepts-apigateway-message-vs-apigateway
1 +Considerations for API Gateway or Messaging
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.CarlijnKokkeler
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,13 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -= Considerations for API Gateway or Messaging =
2 +In this guide, we’ll explore key considerations for choosing between eMagiz API Gateway and eMagiz Messaging. Both patterns offer synchronous data handling, but they differ in aspects such as error management, contract requirements, and user management. We'll review these differences to help you decide which pattern best fits your integration needs. For a deeper understanding, refer to the eMagiz Fundamentals on API Gateway and Messaging.
3 3  
4 -In this microlearning we'll take a moment to discuss several considerations for making the right choice between the two patterns
5 -
6 6  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 7  
8 -* Last update: December 2021
9 -* Required reading time: 10 minutes
10 -
11 11  == 1. Prerequisites ==
12 12  
13 13  * Advanced knowledge of the eMagiz platform
... ... @@ -18,55 +18,45 @@
18 18  
19 19  Please refer to the following Fundamentals to learn the key concepts of both patterns
20 20  
21 -* [eMagiz API Gateway](../../docs/fundamental/fundamental-api-gateway-introduction)
22 -* [eMagiz Messaging](../../docs/fundamental/fundamental-event-streaming-introduction)
16 +* [[eMagiz API Gateway>>doc:Main.eMagiz Academy.Fundamentals.fundamental-api-gateway-introduction||target="blank"]]
17 +* [[eMagiz Messaging>>doc:Main.eMagiz Academy.Fundamentals.fundamental-messaging-introduction||target="blank"]]
23 23  
19 +== 3. Considerations for API Gateway or Messaging ==
24 24  
25 -
26 -== 3. Considerations for selecting Messaging or Event Streaming ==
27 -
28 28  The following sections are helpful to understand what things to consider in selecting the right pattern.
29 29  
30 30  * **Synchronous**
31 - * Both patterns in this discussion are synchronous in nature. In case a asynchronous message is the right choice, pelase refer to the relevant microlearning that compares Messaging and Event Streaming
24 + ** Both patterns in this discussion are synchronous in nature. In case a asynchronous message is the right choice, pelase refer to the relevant microlearning that compares Messaging and Event Streaming
32 32  * **Data**
33 - * Both patterns can handle similar type data - usually record based
26 + ** Both patterns can handle similar type data - usually record based
34 34  * **Online vs. offline**
28 + ** For Messaging, the delivering and receiving system need to be online with high availability ratio's in order to process the messages. The same is true for a backend API provider which needs to be online to provide or consume data from API operations
35 35  
36 - * For Messaging, the delivering and receiving system need to be online with high availability ratio's in order to process the messages. The same is true for a backend API provider which needs to be online to provide or consume data from API operations
37 -
38 38  * **Error handling**
39 - * In the case of an API Gateway, the requesting application needs to be handle the error messages that are returned by the API gateway in case there are any. The API Gateway provides the errors from the backend API directly back to the requestor who can then decide how to process the request.
40 - * For Messagaging, the errors that are generated are pushed inside the general error process of eMagiz and displayed in the Error Dashboard in the Manage phase. However, the requestor also gets the error messages back from the Messaging system in order to handle these properly
31 + ** In the case of an API Gateway, the requesting application needs to be handle the error messages that are returned by the API gateway in case there are any. The API Gateway provides the errors from the backend API directly back to the requestor who can then decide how to process the request.
32 + ** For Messagaging, the errors that are generated are pushed inside the general error process of eMagiz and displayed in the Error Dashboard in the Manage phase. However, the requestor also gets the error messages back from the Messaging system in order to handle these properly
41 41  * **Contract & communication**
42 - * Messaging required a fixed contract between the message definitions that are exchanged. A change of definition would result in validation issues and therefore more communication is required
43 - * For an API Gateway solution, the contract is published via the API Gateway outwards. The basic idea is that the data definition is fixed and standardized, and that requesting application will adapt their request to this definition. In that sense the API Gateway offers standardization in the landscape
34 + ** Messaging required a fixed contract between the message definitions that are exchanged. A change of definition would result in validation issues and therefore more communication is required
35 + ** For an API Gateway solution, the contract is published via the API Gateway outwards. The basic idea is that the data definition is fixed and standardized, and that requesting application will adapt their request to this definition. In that sense the API Gateway offers standardization in the landscape
44 44  * **Technical disqualifiers**
45 -
46 - * For an API Gateway, the requestor needs to be able to call a REST based webservice using JSON formatted messages.
47 - * Messaging allows other web services such as SOAP, but can also handle XML for instance
48 -
37 + ** For an API Gateway, the requestor needs to be able to call a REST based webservice using a supported messaging format
38 + ** Messaging allows other web services such as SOAP, but can also handle XML for instance
49 49  * **Centralized User Management**
50 - * API gateway offers a easy to configure user management capability to protect operations. Users and roles can be designed in the Design phase, and various authentication methods are allowed such as OAuth2.0 and API Keys. eMagiz offers easy to use configurations for that
51 - * For Messaging, no such user management options exit and all needs to be created inside the flows that handle the requests & replies.
40 + ** API gateway offers a easy to configure user management capability to protect operations. Users and roles can be designed in the Design phase, and various authentication methods are allowed such as OAuth2.0 and API Keys. eMagiz offers easy to use configurations for that
41 + ** For Messaging, no such user management options exit and all needs to be created inside the flows that handle the requests & replies.
52 52  
43 +== 4. Key takeaways ==
53 53  
54 -
55 -== 4. Assignment ==
56 -
57 -There is no assignment for now in this microlearning
58 -
59 -== 5. Key takeaways ==
60 -
61 61  * There are a set of considerations to make decisions for API gateway vs. messaging
62 62  * Make sure to read the eMagiz Fundamentals properly before taking this section into account in your project
63 63  
48 +== 5. Suggested Additional Readings ==
64 64  
50 +Take a moment to read the following [[Use Case>>doc:Main.eMagiz Academy.Use Cases.Pattern Determination.WebHome||target="blank"]]. 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:
51 +* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
52 +** [[Crash Course Messaging (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.WebHome||target="blank"]]
53 +*** [[Introduction (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Messaging.crashcourse-messaging-introduction||target="blank"]]
54 +** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
55 +*** [[Introduction (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-introduction||target="blank"]]
65 65  
66 -== 6. Suggested Additional Readings ==
67 -
68 -Take a moment to read the following link https://emagiz.github.io/docs/usecase/index_academy_usecase_pattern_discovery
69 -
70 -== 7. Silent demonstration video ==
71 -
72 -As this is a more theoretical microlearning, we have no video that accompanies this microlearning.)))((({{toc/}}))){{/container}}{{/container}}
57 +)))((({{toc/}}))){{/container}}{{/container}}