Wiki source code of Setting up entry gate
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 | * Last update: February 11th, 2021 | ||
| 9 | * Required reading time: 3 minutes | ||
| 10 | |||
| 11 | == 1. Prerequisites == | ||
| 12 | |||
| 13 | * Basic knowledge of the eMagiz platform | ||
| 14 | |||
| 15 | == 2. Key concepts == | ||
| 16 | |||
| 17 | This microlearning centers around setting up the entry gate for the API Gateway solution of eMagiz. | ||
| 18 | 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 | ||
| 19 | 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 | ||
| 20 | |||
| 21 | 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. | ||
| 22 | |||
| 23 | == 3. Setting up entry gate == | ||
| 24 | |||
| 25 | The central part where all data traffic is coming in is called the entry gate when we talk about the API Gateway. | ||
| 26 | This entry gate is responsible for hosting all designed endpoints that have been transferred to Create. | ||
| 27 | |||
| 28 | 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. | ||
| 29 | |||
| 30 | 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. | ||
| 31 | |||
| 32 | 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. | ||
| 33 | This can be done without harm as eMagiz has standardized the entry gate for you and you don't have to make changes manually. | ||
| 34 | |||
| 35 | == 4. Assignment == | ||
| 36 | |||
| 37 | Add a new API integration to Create and see how eMagiz (re)creates the all entry flow for you. | ||
| 38 | This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. | ||
| 39 | |||
| 40 | == 5. Key takeaways == | ||
| 41 | |||
| 42 | * The entry gate is the central part where all data traffic is coming in | ||
| 43 | * eMagiz will automatically build the all entry for you | ||
| 44 | * No manual changes are necessary | ||
| 45 | |||
| 46 | == 6. Suggested Additional Readings == | ||
| 47 | |||
| 48 | If you are interested in this topic and want more information on it please read the help text provided by eMagiz. | ||
| 49 | |||
| 50 | == 7. Silent demonstration video == | ||
| 51 | |||
| 52 | 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! | ||
| 53 | |||
| 54 | {{video attachment="crashcourse-api-gateway-setting-up-entry-gate.mp4" reference="Main.Videos.Microlearning.WebHome"/}} | ||
| 55 | |||
| 56 | )))((({{toc/}}))){{/container}}{{/container}} |