ION API connection point

To call an API operation use these scenarios:

• Send to API
• Get from API
• Trigger API

In a document flow you can use an ION API connection point to map an input document to the API request. Send an API response as an output document or map a response to the output document. You can also combine earlier mentioned methods to trigger required response based on an input document.

To call an API, these configuration steps must be completed:

• Ensure the application that exposes the API to call is registered in the ION API Gateway, Swagger 2.0 or Open API 3 documentation is provided, and that its endpoints are indexed.
• Ensure that API is sending response Content-Encoding set to "identity" (no compression) or with "deflate" compression.

• Ensure you specified the description property of the service account. The service accounts for the server application that exposes the APIs to call are created in the Infor Ming.le User Management UI. This is required by ION.

  You can use the same service account in several ION API connection points. The credentials of this service account are used in these situations:

  • When calling the API from ION Desk to perform a Test API Call.
  • When loading API Swagger/Open API documentation.
  • At runtime, when ION performs the ION API step.

The definitions of an ION API connection point:

• The standard properties for any connection point, such as name, description and tenant. For ION API connection points the logical ID type is fixed ('api'). The logical ID is lid://infor.api followed by the converted name.
• Authentication for connection to the target API.
• Selection of API operation.
• Which documents are sent and received and how the data are mapped to and from API.