API requests

The API Gateway is a component of Infor OS that is used for brokering requests from API consumers, such as web and mobile applications, and API providers, such as Infor EPM, or third-party services.

As a broker, the API sits between consumers and providers. It can provide benefits to both consumers and providers.

The API Gateway is used by many integrated applications that use API calls to expose business logic using HTTP protocols. Infor EPM uses the API to consume API services that allow access to its business logic in a secure manner.

The API Gateway is a server that acts as an API front-end to Infor products. It receives API requests and enforces throttling and security policies. The API Gateway passes requests to the back-end service, and then passes the response back to the requester. It includes a transformation engine to orchestrate and modify the requests and responses on the fly, and provides functionality such as the collection of analytics data and caching. You can use the API Gateway to support authentication, authorization, security, audit, and regulatory compliance.

Previously provisioned Infor cloud instance customers not already using the API Gateway must work with Infor Cloud team to provision the API Gateway to their Infor cloud instances.

Infor EPM constantly extends the set of functions that are available in API Gateway. To find documentation on the supported functions:

  1. In Infor OS Portal or Infor Ming.le, select the API app.
  2. Under Available APIs, double-click DEPM API.
  3. Select the Endpoints tab.
  4. For any available REST or web API endpoints in the grid, click Documentation.
  5. Click a POST API operation. The details are displayed.
  6. Click Try it now!.

Keep these points in mind when working with Application Engine processes through API Gateway:

  • All processes from all applications appear in the API.
  • When adding processes, refresh the API.
  • The description of the process shows in the API documentation.
  • Process parameter values are defined in a request body. No parameter descriptions are shown for Application Engine functions.
  • Using the API, a process can be executed in two ways: synchronously and asynchronously. For asynchronous execution, include the /async suffix in the endpoint's URL. The status and the result for asynchronously executed processes is available for all applications.