General
Currently the Generic Source Module supports three (3) different ways of imports. You will find the settings page under “Imports” in the main Settings menu on the left side in NTI INTEGRATOR Server. In order to configure imports, the logged in user needs to have admin rights within NTI INTEGRATOR Server.
API Endpoints import
In the settings for API Imports you are allowed to create custom API endpoints for receiving payloads with Transaction data.
Configure new API Import endpoint
To create a new endpoint, click the green button “New API Endpoint” in the upper right corner. A dialog pops up to configure the settings for the endpoint.
- Active, set the endpoint in active state, meaning it will receive incoming data from API call.
- Method, mandatory field. Method type of incoming API call. GET, POST, PUT etc..
- URL, Mandatory field. The URL for the endpoint. The initial part of the URL is fixed and attached to the current configuration. Must be a valid URL.
- IP Whitelist, mandatory field. Filter IP Addresses of callers. Default value is “*” which means “Allow all”.
- Run As User, mandatory field. Select the NTI INTEGRATOR User to execute the Transaction as.
- Require Authentication Token, if checked, the incoming API Calls header must contain a valid Bearer Token for the “Run As User” user, meaning an Authorization API call to Integrator to retrieve a Token must be done first (see section Authorization further down).
- Preparation, set the Transaction that will be created in Preparation mode.
In the main view, after configuring the endpoint, the Request Scripts need to be coded. The Request script needs to return a Transaction object with data for processing. An example script is provided when the endpoint is created. The Response script is optional and not required. If not supplied, the Id of the Transaction will be returned as the response content and a 200 OK status code.