Prerequisites
- An existing Service Account, see Configure Service Account
- An existing API for Vince Live, see Configure API Connection to Vince Live
Step-by-step guide
-
Go to ION Desk ⇒ Connect ⇒ Connection Points
-
Click ➕ Add then select API
-
Give the connection point a name and also upload the service account csv by clicking
IMPORTand selecting the file.
-
Click on the Documents tab and click the ➕ icon to add a an API transaction to the connection point.
-
Select the Scenario. In this example we want to send to a Vince Live API, by selecting Send to API ****
-
Select the document you want to be used in the transaction
-
Click on the ION API tab and give a call name. Then press Select
-
Search and select the relevant endpoint, and click OK
-
Click on the Request parameters tab and enter the relevant values for the parameters
For a workflow endpoint, this would typically be the
workflowId
-
Click on the Request Body tab and be sure to select the outgoing format you want.
For a workflow endpoint, this would typically be
JSON from BOD
-
Click Save.
-
If you have just created the connection point, it will be marked as Inactive until you use it in an activated Document Flow
