Setting up Entry gate

Last modified by Erik Bakker on 2024/08/23 11:31

In this microlearning, we will focus on setting up the entry gate for the API Gateway. We will guide you through the process of configuring the entry gate, which serves as the gateway for external parties to access your backend operations, given proper authorization.

If you have any questions along the way, feel free to reach out to us at academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform

2. Key concepts

This microlearning centers around setting up the entry gate for the API Gateway solution of eMagiz.

  • 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
  • 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

3. Setting up entry gate

When we talk about the API Gateway in eMagiz, the central part where all data traffic is coming in is called the entry gate. This entry gate is responsible for hosting all designed endpoints that have been transferred to Create.

The first time you transfer an API integration to Create, eMagiz will create the entry gate for you without the need to make manual changes to it. This accelerates the building of an API Gateway solution a lot. You, as a user, do not have to do one single thing. Easy right?

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.

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. This can be done without harm as eMagiz has standardized the entry gate for you and you don't have to make changes manually.

4. Key takeaways

  • The entry gate is the central hub for all incoming data traffic in the API Gateway.
  • eMagiz will automatically sets up and updates the entry gate for you, making the process of setting up and managing API operations seamless.
  • Manual adjustments to the entry gate are not required, as eMagiz handles the configuration and updates seamlessly.

5. Suggested Additional Readings

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: