Search: api gateway

eMagiz API Gateway

Introducing API Gateway == The eMagiz API Gateway is the pattern in which a specific entry point is made available for external applications (users).

The user will have the access credentials to access the API Gateway in the first place. Options are OAuth2.0 or API Key.

[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-6.png]] == 4. Key takeaways == * API Gateway can serve as a single entry point for all external or intern application users * API Gateway can simplify the IT landscape by offering a reusable entry point * API Gateway is a synchronous pattern by default * API Gateway leverages the standard capability of eMagiz around deployment, transformation, and business owner interaction == 5.

fundamental-api-gateway-introduction

Testing API Gateway

intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--feedback-inswagger-ui.png

intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--flow-test-configuration.png

intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--swagger-ui-execute-try-it-out.png

intermediate-testing-emagiz-api-gateway-testing-api-gateway

Testing API Gateway

Testing API Gateway == In this microlearning, we will focus on testing your API Gateway (operations) with the help of two functionalities that the platform offers.

By pressing this button you will test the API Gateway functionality of a specific operation as if you were the client. [[image:Main.Images.Microlearning.WebHome@intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--swagger-ui-execute-try-it-out.png]] The Swagger UI will give feedback based on what happened after you have pressed the button to execute [[image:Main.Images.Microlearning.WebHome@intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--feedback-inswagger-ui.png]] == 4.

API Gateway - Introduction

crashcourse-api-gateway-introduction

Crash Course API Gateway

[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-introduction--conceptual-overview.png]] Key considerations when to use the API Gateway integration pattern Below is the list of considerations when to use the API Gateway

Managing your API Gateway in the ILM == The API Gateway is fully embedded into the eMagiz Low-code Enterprise iPaaS so that users have a similar user experience when configuring the API Gateway, a Messaging integration, or an Event Stream.

At the system level, you can indicate that the system acts as a backend service provider that has certain API's available. * Design an API Gateway This is the central phase in the configuration of the API Gateway.

API Gateway Architecture

Architecture considerations == === 3.1 Architecture components API Gateway === The following picture displays a general architecture of the API Gateway.

The eMagiz Cloud handles the proper and secure routing to the API gateway. * Gateway only runtime ** These are system that act as application user of 1 or more operations made available in the API Gateway.

For the API Gateway, this means that you have the following machines available.

API Gateway Data Model

crashcourse-api-gateway-api-data-model--access-data-model-in-design.png

crashcourse-api-gateway-api-data-model--create-new-version-pop-up.png

crashcourse-api-gateway-api-data-model--data-model-in-design-empty.png

crashcourse-api-gateway-api-data-model

Crash Course API Gateway

[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-api-data-model--access-data-model-in-design.png]] When you select this option eMagiz will take you to the Gateway (API) Data Model.

You can view who made what (temporary) version when you navigate to the History option on the API Gateway Data Model level. [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-api-data-model--history-of-data-model.png]] This history of the changes on the API Gateway Data Model is not only useful for auditing purposes, but also helps you identify who you should ask about the latest changes.

[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-api-data-model--edit-description-auto-saved-version-result.png]] == 4.

Transforming messages in API Gateways

intermediate-configuring-the-api-gateway-transforming-messages--operation-options-transformation.png

intermediate-configuring-the-api-gateway-transforming-messages

Configuring the API Gateway

Prerequisites == * Intermediate knowledge of the eMagiz platform * Basic knowledge of the API Gateway pattern == 2. Key concepts == This microlearning is about transforming messages within the API Gateway pattern

Interesting points to consider are: * The transformation process works similarly across patterns * The benefit of having the transformation capability is that it expands the capabilities of the API Gateway. This fact makes it more attractive to use the eMagiz API Gateway * You can transform from the different messaging formats (including itself) with the standard transformation functionality (for the API Gateway) == 3. Transforming messages == In the [[Crash Course of API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]], we learned the basics of the API Gateway pattern.

Considerations for API Gateway or Messaging

Key Concepts API Gateway

Considerations for API Gateway or Messaging == The following sections are helpful to understand what things to consider in selecting the right pattern

The same is true for a backend API provider which needs to be online to provide or consume data from API operations * **Error handling** ** 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.

A change of definition would result in validation issues and therefore more communication is required ** For an API Gateway solution, the contract is published via the API Gateway outwards.

Constructing Error Handling API Gateway

intermediate-api-management-constructing-error-handling-api-gateway--catalog-context-menu.png

intermediate-api-management-constructing-error-handling-api-gateway--catalog-response-tab.png

intermediate-api-management-constructing-error-handling-api-gateway--new-response.png

intermediate-api-management-constructing-error-handling-api-gateway

{{/error}} As we learned from our crash course on API Gateway we can influence the error handling within the API Gateway solution.

Constructing Error Handling API Gateway == As we learned from our crash course on API Gateway we can influence the error handling within the API Gateway solution.

When you are satisfied with your configuration you can save the custom error handler and update your API Gateway. To learn about how to update your API Gateway solution please continue with the next microlearning. == 4.

Updating your API Gateway Operations

intermediate-api-management-updating-your-api-gateway-operations

{{container}}{{container layoutStyle="columns"}}((( Building on what we covered in our [[crash course>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] about setting up the API Gateway, we will now focus on the next critical step: updating your existing API Gateway solution.

Updating your API Gateway Operations == In our [[crash course>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] on the API Gateway pattern, we have learned about setting up the API Gateway. However, we still need to delve into how to update your existing API Gateway solution. In this microlearning, we will focus on updating the design phase of your API gateway (and the subsequent steps) and the create phase of your API gateway (and subsequent steps).

Exercise - Complete Capture API Gateway

Crash Course API Gateway

Prerequisites == * Completed previous exercises and microlearnings * Access to an eMagiz model with Deploy rights and an API Gateway license attached == 2. Exercise == Below the exercises for this part of the crash course. === 2.1 Complete Capture phase OMS Carrier === Below are the results expected from this exercise: * Create the Capture phase based on the business case * Ensure to add the documents to the Capture phase at the right location ** [[Gateway reponse>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.gateway-response.WebHome||target="blank"]] ** [[System reponse>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.system-response.WebHome||target="blank"]] {{info}}Note that you should save the contents of the file as an XSD and attach it to each of the lines drawn in Capture{{/info}} === 2.2 Complete Capture phase OMS Order === Below are the results expected from this exercise: * Create the Capture phase based on the business case * Ensure to add the documents to the Capture phase at the right location ** [[Gateway Order Request>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.gateway-order-request.WebHome||target="blank"]] ** [[Gateway Order Reponse>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.gateway-order-response.WebHome||target="blank"]] ** [[Example message>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.example-message.WebHome||target="blank"]] {{info}}Note that you should save the contents of the file as an XSD and attach it to each of the lines drawn in Capture{{/info}} == 3. Solution == {{video attachment="crashcourse-api-gateway-complete-capture.mp4" reference="Main.Videos.Microlearning.WebHome"/}} )))((({{toc/}}))){{/container}}{{/container}}