Wiki source code of Setting up exit gate
Last modified by Danniar Firdausy on 2024/09/04 16:15
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{container}}{{container layoutStyle="columns"}}((( | ||
| 2 | In this microlearning, we will walk you through how to configure the exit gate, which ensures seamless message delivery between the API Gateway and your backend operations. We will cover the essential parts from basic concepts to practical steps, so you will know exactly how to configure an exit gate to deliver incoming requests and give back responses to the client calling the API. | ||
| 3 | |||
| 4 | If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]]. | ||
| 5 | |||
| 6 | == 1. Prerequisites == | ||
| 7 | |||
| 8 | * Basic knowledge of the eMagiz platform | ||
| 9 | |||
| 10 | == 2. Key concepts == | ||
| 11 | |||
| 12 | This microlearning centers around setting up the exit gate for the API Gateway solution of eMagiz. | ||
| 13 | |||
| 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 (e.g., 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]] | ||
| 39 | |||
| 40 | Just as with the entry gate we try to auto-generate as much as possible to make your life easier the moment you start in the Create phase. | ||
| 41 | |||
| 42 | == 4. Key takeaways == | ||
| 43 | |||
| 44 | * Each backend operation has a specific exit gate that: | ||
| 45 | ** Handles all incoming traffic destined for that backend operation | ||
| 46 | ** Connects to the backend operation to execute the requested action | ||
| 47 | ** Sends response back to the client that made the API call | ||
| 48 | * eMagiz will automatically handle most of the setup for you, including the generation of the exit gate configuration. | ||
| 49 | * Depending on your use cases, some manual changes might be necessary | ||
| 50 | |||
| 51 | == 5. Suggested Additional Readings == | ||
| 52 | |||
| 53 | 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: | ||
| 54 | * [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] | ||
| 55 | ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]] | ||
| 56 | *** [[Flow Editor - Basics (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-flow-editor-basics||target="blank"]] | ||
| 57 | *** [[Promote flows to deploy (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]] | ||
| 58 | ** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] | ||
| 59 | *** [[Configure A Backend Operation (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-configure-backend-operation||target="blank"]] | ||
| 60 | *** [[Setting up Entry gate (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-setting-up-entry-gate||target="blank"]] | ||
| 61 | * [[Novice Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]] | ||
| 62 | ** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]] | ||
| 63 | *** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]] | ||
| 64 | * [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] | ||
| 65 | ** [[Testing API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.WebHome||target="blank"]] | ||
| 66 | *** [[Testing API Gateway (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.intermediate-testing-emagiz-api-gateway-testing-api-gateway||target="blank"]] | ||
| 67 | * [[Advanced Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]] | ||
| 68 | ** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]] | ||
| 69 | *** [[API Gateway Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-apigw-architecture.WebHome||target="blank"]] | ||
| 70 | *** [[Key differences Design & Deploy Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-diffs-design-deploy.WebHome||target="blank"]] | ||
| 71 | ** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.WebHome||target="blank"]] | ||
| 72 | *** [[Running part of your API Gateway solution on-premise (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.advanced-api-management-running-part-of-your-api-gateway-solution-on-premise||target="blank"]] | ||
| 73 | * [[Exit Gate (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22Exit+gate%22||target="blank"]] | ||
| 74 | )))((({{toc/}}))){{/container}}{{/container}} |