Working with the Optiva API

API consumer uses the Optiva Endpoint URL from the Endpoints tab of ION API to communicate with the Optiva API. The Optiva API retrieves data from the Optiva App Server.

API Endpoint

End points are secured via oAuth2 authentication. Any call made to the Optiva Endpoint URL will contain the ION API oAuth2 token.

To configure the Optiva API, see Configuring Optiva API in Xi/Infor OS.

The Optiva API supports the Basic and OAuth 1.0 authentication.

To configure with OAuth1.0 authentication, see Generating an OAuth 1.0 Authentication Key.

The Optiva API uses the oAuth 2.0 for API gateway authorization. For the Optiva API application authentication, a separate header is used.

Obtain the oAuth 2.0 Token

You must generate the oAuth 2.0 Token by obtaining the Infor ION Api application Authorizations from the ION API Authorized apps.

You can capture the oAuth Token:
uXXKXXXj8tkXXXXXXxXXXXqfb9c
You can perform these functions in Optiva RESTAPI:
Category Uses
Working with Data Perform create, update or delete operations on Optiva objects.
Wizards See the same information that is displayed in the Optiva Home page. For example, you can see the list of Recently Viewed objects, Recently Saved objects, Wizard Action Sets, and Pending Tasks.

API URL:

GET https://OptivaAPIEndPointURL/recentlySaved
Functions Simulate calculations for items and formulas. This information is not saved to the Optiva database.

API URL:

POST https://OptivaAPIEndPointURL/method/Symbol/ID/Function
Workflow Launch workflows with or without input parameters. You can also process workflow events and view the WIP IDs.

API URL:

POST https://OptivaAPIEndPointURL/workflow/WorkflowOperation
Filter Retrieve information for a specific Optiva object. This information can be parameters, references, reports, and custom tables.

API URL:

GET https://OptivaAPIEndPointURL/ filter/Symbol Name/Symbol Id/Filter Type/Filter Name
For more information on functions, see Optiva API Swagger Documentation.