Wiki source code of Setting up Entry gate
Version 10.1 by Danniar Firdausy on 2024/08/07 12:29
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{container}}{{container layoutStyle="columns"}}((( | ||
| 2 | |||
| 3 | In this microlearning, we will focus on setting up the entry gate for the API Gateway. | ||
| 4 | This entry gate will host the endpoints that will be made available to external parties so they can call these endpoints to obtain access to certain backend operations (if authorized) | ||
| 5 | |||
| 6 | Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. | ||
| 7 | |||
| 8 | == 1. Prerequisites == | ||
| 9 | |||
| 10 | * Basic knowledge of the eMagiz platform | ||
| 11 | |||
| 12 | == 2. Key concepts == | ||
| 13 | |||
| 14 | This microlearning centers around setting up the entry gate for the API Gateway solution of eMagiz. | ||
| 15 | With entry gate, we mean: The piece of functionality that hosts all endpoints and is responsible for checking the authentication and routing messages to the correct backend operation | ||
| 16 | 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 | ||
| 17 | |||
| 18 | The entry gate is created by eMagiz without the need of any user making manual changes to the entry gate. This accelerates the building of an API Gateway solution a lot. | ||
| 19 | |||
| 20 | == 3. Setting up entry gate == | ||
| 21 | |||
| 22 | The central part where all data traffic is coming in is called the entry gate when we talk about the API Gateway. | ||
| 23 | This entry gate is responsible for hosting all designed endpoints that have been transferred to Create. | ||
| 24 | |||
| 25 | The first time you transfer an API integration to Create eMagiz will create the entry gate for you. You as a user do not have to do one single thing. Easy right. | ||
| 26 | |||
| 27 | Furthermore, every time you add a new API integration to Create eMagiz will automatically update all entry gate to ensure that this newest operation can be accessed by external parties. | ||
| 28 | |||
| 29 | In case you have made changes to existing operations you will have to use the Reset flow option to ensure that the latest changes are indeed actualized in the entry gate. | ||
| 30 | This can be done without harm as eMagiz has standardized the entry gate for you and you don't have to make changes manually. | ||
| 31 | |||
| 32 | == 4. Key takeaways == | ||
| 33 | |||
| 34 | * The entry gate is the central part where all data traffic is coming in | ||
| 35 | * eMagiz will automatically build the all entry for you | ||
| 36 | * No manual changes are necessary | ||
| 37 | |||
| 38 | == 5. Suggested Additional Readings == | ||
| 39 | |||
| 40 | 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 link: | ||
| 41 | * [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] | ||
| 42 | ** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] | ||
| 43 | *** [[Configure A Backend Operation (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-configure-backend-operation||target="blank"]] | ||
| 44 | )))((({{toc/}}))){{/container}}{{/container}} |