Tutorials are designed to offer a guide to complete common objectives, while also acknowledging that individual developers need to respond to individual needs of their own solutions. Tutorial frameworks provide blueprints for these solutions and should be adapted to fit individual needs.

Analytics with Birst

API Gateway

Application Development with Mongoose

Artificial Intelligence

Data Fabric

Digitical Assistant

Document Management

Integration with ION

Robotic Process Automation

Add description here

Security & User Management

Add description here

## Overview This tutorial will guide you through integrating an API with an API Gateway using Infor OS. You'll discover the essence of an API Gateway, its importance, and the steps to set one up using Infor OS. You'll also learn how to test it effectively. When we ask what an API Gateway is, we're referring to a crucial Software System. It acts as a reverse proxy, forming a bridge between API consumers, like web and mobile applications, and providers, including Infor and other external services. * * * ### Components * [Enterprise Integration](https://developer.infor.com/components/enterprise-integration/) * [Enterprise Integration Best Practices](https://developer.infor.com/best-practices/enterprise-integration/) ### Requirements * Access to ION API Gateway * Security role: IONAPI-Administrator * Security role: IONAPI-User * [Infor U](https://education.infor.com/) courses. * * * ## Tutorial Difficulty: Medium Estimated completion time: 30 Minutes This tutorial will focus on using the role of an API Gateway. It functions as a strong intermediary, guaranteeing secure and efficient communication between consumers and providers. A unified access point simplifies everything for developers and their applications by providing a single base URL path for easier API access. Streamline security enhances protection by creating a uniform authentication process, which ensures that all API interactions are secure and only authorized requests get through. Enhanced API capabilities mean the gateway boosts your API with additional features without altering the existing server or code. This includes analyzing performance, logging usage patterns, and conducting thorough searches of those logs. It also includes adding and configuring an API. Let's examine how to incorporate an API into the gateway. Login to the Infor OS Portal, select the API Gateway tab at the top of the page.  The Available APIs are in the navigation menu in the upper left corner. Clicking this will take you to the menu where all the accessible APIs are listed.  Introduce a new API, and hit the \+ Add button.  You'll see two options. We will develop an API from the ground up, particularly one not offered among the templates. We'll proceed by clicking the Create New button.  Please fill in the required fields. Application name : Neutrino API . In this scenario, we'll utilize a third-party API from Neutrino, which you can find online. Assign a version number, V2 , for this example. Moving on to the Suite Name and label it Neutrino API . Enter a description , General Web API . Next, select an icon . You can either upload a custom one or pick from a selection already provided.  Define at least one target endpoint; this step is crucial to inform the API Gateway about the actual destination API URL. Click the \+ sign in the Target Endpoint section to input the proxy endpoint, which Neutrino, the vendor, has provided.  In the Target Endpoint URL field enter [ https://neutrinoapi.com/ ](https://www.neutrinoapi.com/) Add a Description of Neutrinoapi Main UR L and the in the Proxy Context field. We'll use APIS . In the Proxy Security field, there are two primary options for accessing the services. OAuth 2.0 is the default standard for securing that URL, anonymous access is also available but generally reserved for testing phases. Select OAuth 2.0 .  Neutrino opts for a widely used approach known as the API key method, necessitating the input of specific keys for Neutrino. From the drop-down, select the API Key option.  The first Key Name is identified as a user-id ; enter the user account you generated on the Nuetrino website. The second Key Name is api-key . Enter the Root Key value associated with the Neutrino account. Click Save .  Go back to the available API section, and under the Neutrino API Suite definition, you'll see that everything has been configured and saved. The status is now set to active. Click on the Neutrino API widget  You will notice the Status indicator also marks the API as active .  The next step is to add some documentation. To do this, in the Neutrino API configuration, click on the API Documentation icon.  Select the Documentation tab and click the \+ Button .  In the Name field type Main Specification . In the Type field select Swagger . In the Enter URL or Upload Swagger JASON/YAML field use and click Save .  Notice that the API Suite has been updated.  Scrolling down, we observe that the API specifications have been rendered, allowing us to view all the available Services.  Navigating to the URL Info service. We can access detailed information about this specific API, including examples of making calls and what responses to expect. Click the Try It Out button.  Test by entering a URL such as https://www.google.com in the URL to probe field. Click Execute to query against that URL.  Now, with the credentials and the two keys we've entered, it's retrieving live information directly from Neutrino and delivering a response in real-time. Receiving a 200 code is excellent news as it confirms a successful interaction and provides us with all the details about the URL.   This verifies that the API and its Suite have been successfully integrated and are now primed for use within the applications. Exploring this functionality demonstrates the API Suite's seamless integration and real-world application, ensuring it's fully operational and accessible for our development needs. Watch the following video to view all the steps that were covered. https://www.youtube.com/watch?v=lFxg4UQ2VxA&list=PLbzqMzjlWI2ai0KXdFI187v2FMoASVWEi&index=5 ## Resources Help Documents and User Guides * [API Gateway](https://docs.infor.com/inforos/latest/en-us/useradminlib_cloud/default.html?helpcontent=apigatewayag_cloud/cover.html)

## Overview You want to integrate Infor OS with another system using APIs, but the system only supports SOAP web services, while Infor OS prefers REST APIs. How can you create a modern, integrated solution? * * * ### Components * [Enterprise Integration](https://developer.infor.com/components/enterprise-integration/) * [Enterprise Integration Best Practices](https://developer.infor.com/best-practices/enterprise-integration/) ### Requirements * Access to ION API Gateway * Security role: IONAPI-Administrator * Security role: IONAPI-User * API (REST vs SOAP) knowledge * Handlebars script knowledge for Policy [Docs](https://handlebarsjs.com/guide/) * * * ## Tutorial Difficulty: Medium Estimated completion time: 45 Minutes SOAP Webservices are still a valid option in the API world. They are based on WSDL (Web Service Definition Language) an XML file where you can define the input and the output with the types of messages. This approach is completely different compared to the REST (REpresentational State Transfer) that is based on swagger documentation 2.0 or Open API 3.0.x. Unless it is possible to define a SOAP web service in the API gateway, we cannot use it in ION, because the ION API connector is based on an API suite based on REST. ### Register Custom API Suite With the use of the API Policy, we can convert a SOAP web service into a REST API, and to do that we use this WSDL. ``` [](https://developer.infor.com/wp-content/uploads/2022/09/2022-09-05-15_51_28-https___www.dataaccess.com_webservicesserver_numberconversion.wso_WSDL.png) Once we have the URL (Uniform Resource Locator) of the WSDL we can register a new custom API suite in the API Gateway . Login to OS Portal and click on API Gateway . Click the ( + ) Add button.  Click on Create New button.  Input the following values and under the Target Endpoints tab, click the + button  On the Add Endpoint page, in the Target Endpoint URL field enter the WSDL URL . Enter rest in the Proxy Context field. Click Save .  Below is the output screen after Save.  * Watch the following video to view all the steps that were covered. ### Upload Swagger Documentation We need swagger documentation or an Open API 3.0.x to document our endpoint, which can be found with the following link or under the Downloads sections at the bottom the tutorial ([Swagger file to import into API Gateway](https://developer.infor.com/wp-content/uploads/2022/09/swagger.zip)). This file needs to be uploaded into the API suite. Click on the Details button for the rest Endpoint you just created.  Scroll to the bottom of the rest endpoint page and select the Documentation tab. Click the ( + ) button.  Download and extract the swagger.zip file from the Swagger file to import into API Gateway link in the Download section. On the Add Documentation page, in the Name field type rest , from the drop down select Swagger in the Type field. Click the browse button on the Enter URL or Upload Swagger JSON/YAML field and select the rest.json file that was extracted from the swagger.zip file.  Click Save . Below is the output screen after Save.  * Watch the following video to view all the steps that were covered. ### Create Request and Response Policies Defining the Endpoint Policy for Request and Response. We have to write the scripts that convert JSON input from REST API to XML (Request) and SOAP that converts XML to JSON as a (Response). From JSON to XML (Request) {{number}} ]]> ``` From XML to JSON (Response) ``` ``` Scroll to the bottom of the rest endpoint page. Select the Endpoint Policies tab and click the ( + ) button under Request Policies .  From the drop down select Transformation for the Policy Type field, in the Name field type input . For the Policy Definition replace the content with the From JSON to XML request script information displayed in a previous step. Click Save .  Go back to the rest endpoint page and under the Endpoint Policies tab click the ( + ) button under Response Polices .  From the drop down select Transformation for the Policy Type field, in the Name field type output . For the Policy Definition replace the content with the From XML to JSON response script information displayed in a previous step. Click Save .  Below is the output screen after Save.  * Watch the following video to view all the steps that were covered. ### Test API On the rest Endpoint page, select the Documentation tab and click the POST button, then click the Try it out button,  Change the number value from string to 101 and click the Execute button.  In the Response Body you should see the results, notice the one hundred and one content is displayed. This is telling you it is working.  Watch the following video to view all the steps that were covered. ### Test ION API Connection Point Go to the ION tab, expand Connect and select Connection Points . Click on the ( + ) Add button.  From the drop down, select API .  Watch the video below on how to create a Service Account . In the Name field type soap2rest_cp , click the IMPORT button to import your Service Account. Select the folder button and select your ServiceAccount csv file that was generated when creating a service account..  Click Ok . Below is the output screen after Ok.  Select the Documents tab and click the ( + ) button. Click on the SELECT button at the bottom of the screen.  From the drop down select soap to rest .  Select the search button and select the CustomerAPI/soap/rest API. Click Ok .  In the API Call Name field type soap .  Select the Request Body tab and click on the EXAMPLE button. You will change the string number value to 101 .   Select the Output Documentation tab and select the Document search button. Search and select the AnyDocuments option, click Ok .  Click the TEST button, you will receive the Warning message, click Yes .  Click the Test button.  You will notice the Output displaying the one hundred and one message. This tells us the API call is working and the Soap to REST conversion is successful.  Watch the following video to view all the steps that were covered. ## Downloads [Swagger file to import into API Gateway](https://developer.infor.com/wp-content/uploads/2022/09/swagger.zip) [Connection Point file to import into ION Desk](https://developer.infor.com/wp-content/uploads/2022/09/soap2rest_cp.zip) [API Suite definition to import into API Gateway](https://developer.infor.com/wp-content/uploads/2022/09/Custom_API_SUITE.zip) ## Resources Online help documentation: * [Target SOAP WSDL](https://docs.infor.com/inforos/latest/en-us/useradminlib_cloud/default.html?helpcontent=apigatewayag_cloud/cover.html) * [Custom API Suite](https://docs.infor.com/inforos/latest/en-us/useradminlib_cloud/default.html?helpcontent=apigatewayag_cloud/vwi1489585692124.html) * [Swagger or Open API 3.0.x documentation](https://swagger.io/docs/) * [API Policy rules](https://docs.infor.com/inforos/latest/en-us/useradminlib_cloud/default.html?helpcontent=apigatewayag_cloud/vgs1507223114567.html)

## Overview This tutorial will help you learn how to call an ION API within the OS portal using Authorized API Calls and Postman--a popular tool for testing APIs. It will also offer guidance on integrating this process into your own client application, ensuring a smooth and efficient implementation. * * * ### Components * [Enterprise Integration](https://developer.infor.com/components/enterprise-integration/) * [Enterprise Integration Best Practices](https://developer.infor.com/best-practices/enterprise-integration/) ### Requirements * Access to ION API Gateway * Security role: IONAPI-Administrator * Security role: IONAPI-User * [Infor U](https://education.infor.com/) courses. * * * ## Tutorial Difficulty: Medium Estimated completion time: 45 Minutes This tutorial will guide you through calling an ION API within the Infor OS portal using several OAuth scenarios, including Postman, a widely used tool for API testing. We'll also give you some tips on how to implement this from your own client application. How you call an ION API depends on the type of client application you are using. If an application is already authenticated with Infor OS, you will receive an Infor OS token, which can be used to call an ION API. This is an OAuth2 SAML Bearer Grant , the first scenario in the slide below. To be logged into the Infor OS portal means you are already authenticated, so the same token that was issued to you via login for single sign-on can be reused if you are making an ION API call from the Infor OS portal or itself or within any of the other SSO authenticated applications.  We'll call a simple API that will return the details of the currently logged- in user. Login to the OS portal and select the API Gateway tab.  On the navigation menu in the upper left corner, select Available APIs . Here, you will see a list of various APIs and associated documentation registered by the API Gateway.  Search and select the IFS Service API.  Click on the Documentation tab.  Scroll to the IFSUser section, click on the GET /usermgt/v2/users/me API.  Currently the details are empty, click the Try it out button.  Click the Execute button.  You should see the field replaced by your personal details in the 200 success code.  You will also see there is a Bearer Token issued for this request.  This is the OAuth2 SAML Bearer Token type. The client application we used here is the Documentation page of the registered API itself. The next OAuth Scenario involves calling mobile or web applications. In this case, the application is not yet authenticated within the Gateway. The user must authorize the mobile application to call the ION API on their behalf. This type of interaction uses the OAuth2 Authorization Code Grant .  On the navigation menu select Authorized Apps , then select the \+ button to create a new authorized app.  In the Name field enter Postman Web App Demo . For the Type , choose Web Applicatio n, and in the Description field, enter Postman Web App . Enter the Postman Redirect URL In this example, we will use this [https://oauth.pstmn.io/v1/browser- callback](https://www.getpostman.com/oauth2/callback). The Authorized JavaScript Origins field will be the same callback URL.  Click Save.  The Gateway will generate your Client ID and Client Secret , click the Download Credentials button to download the credentials file.  Open and view the credentials file, which will look like this. The file holds the details to call the API and Postman.  Log into Postman and create a new request collection using the Authorization methods template; click the \+ sign in the top left corner and select the View more templates link, or you can click the \+ sign in the tab section.  Click the Authorization methods button.  Click the Use Template button.  On the Authorization methods collection, click on the eclipsis and select Add request .  On the New Request collection, click on the eclipsis and select Rename . Give the Collection a new name.  We will name it Authorization Code Grant .  Within the Params tab, enter the IFS Service /usermgt/V2/users/me ION API URL in the GET parameters field. In this example we will enter  Select the Authorization tab, and in the Auth Type field, choose OAuth 2.0 .  To acquire a new access token, scroll down to the Configure New Token section and enter the following Postman Mapping information from the downloaded Postman Web App Demo.ionapi credentials file performed in the previous steps.  Enter the relevant credentials into the required input parameter. In the Token Name field, enter Auth Code Token and set Grant type to Authorization Code . The Callback URL is the embedded Postman link (). The Auth URL is a concatenation of values pu + oa , similarly, the Access Token URL is a concatenation of pu + ot , The Client ID is value ci and the Client Secret is cs .  Scroll to the bottom of the page and click the Get New Access Token button.  This will take you to a login screen. Once signed in you can see infor OS is prompting the Request For Approval regarding Postman using our credentials. Click the Allow button.  You will get the following message. You can click the Proceed button or wait a few seconds. The Manage Access Token screen will then appear.  This will provide a new token within the Postman application. On the Manage Access Tokens screen, click the Use Token button.   We can test this by calling the same GET API using the /ifsservice/usermgt/v2/users/me URL. Click the Send button.  You can see that the call was successful. Error Code 200 and returned Data .  Now, let's look into the Resource Owner Grant type. In this case, the calling application is not a mobile or web application but either a service system or backend application. Since it is an app calling an API, there is no user interaction present which requires the OAuth2 Resource Owner Grant for a silent API call from a Service/System client.  Go back to the OS portal. We'll create another authorized app. On the navigation menu, select Authorized Apps , then select the \+ button to create a new authorized app.  In the Name field enter Postman_Resource_Demo . For the Type , choose Backend Service , and in the Description field, enter Postman as a calling system . Click Save .  Click the Download Credentials button.  On the Download Credentials screen, select Create Service Account and add an account in the Full Name field. Then click Download .  The credentials will look something like the following.  Now, create another Postman request. On the Authorization methods collection, click on the eclipsis and select Add request .  On the New Request collection, click on the eclipsis and select Rename . Give the Collection a new name.  We will name it Resource Owner Grant .  Within the Params tab, enter the IFS Service /usermgt/V2/users/me ION API URL in the GET parameters field. In this example we will enter  Select the Authorization tab, and in the Auth Type field, choose OAuth 2.0 .  To acquire a new access token, scroll down to the Configure New Token section and enter the following Postman Mapping information from the downloaded Postman_Resource_Demo.ionapi credentials file performed in the previous steps.  Enter the relevant credentials into the required input parameter. In the Token Name field, enter Resource Owner Token and set the Grant type to Password Credentials . The Access Token URL is a concatenation of values pu + ot , the Client ID is value ci and the Client Secret is cs , the Username is a service account, account key saak and the Password is the service account, secret key sask .  Now we can request our token, Scroll to the bottom of the page and click the Get New Access Token button.  You will get the following message. You can click the Proceed button or wait a few seconds. The Manage Access Token screen will then appear.  This will provide a new token within the Postman application. On the Manage Access Tokens screen, click the Use Token button.   Call the GET API, by clicking the Send button.  You can see that the call was successful. Error Code 200 and returned Data .  We have demonstrated how to call an ION API in three distinct ways. One by using the OAuth2 SAML Bearer Grant , which was executed from the documentation page of the OS portal. Second, we used the Postman OAuth2 Authorization Code Grant , where the user logs in using their username and password to authenticate and allows Postman to call the API on their behalf. Thirdly, we demonstrated that if the calling system is a service or one with no user interaction, in that case, the user would need the OAuth2 Resource Owner Grant with details supplied when getting the token. Lastly, if the API allows itself to be called Anonymously , no credentials are passed, and the gateway can successfully pass the request through. This fourth scenario is strictly discouraged unless the API provides some non- sensitive information and is open to everyone.  If you are building your client application and want to call an ION API, you can refer to our [GitHub](https://github.com/infor-cloud/ion-api-sdk) , where we have published the source code for getting tokens for various types of OAuth2 grants. Your app can be a Java or .Net application we have supplied code for both. Watch the following video to view all the steps that were covered. https://www.youtube.com/watch?v=0evdcrDc6F4&list=PLbzqMzjlWI2ai0KXdFI187v2FMoASVWEi&index=7 ## Resources Help Documents and User Guides * [API Gateway](https://docs.infor.com/inforos/latest/en-us/useradminlib_cloud/default.html?helpcontent=apigatewayag_cloud/cover.html)

Overview

To use an ION API connection point in ION Connect, you must first register an ION API Suite in the API Gateway with Swagger 2.0 or Open API documentation. However, not all APIs available online come with the necessary documentation, and in some cases, you may need to create it manually.

---

Components

• Enterprise Integration * Enterprise Integration Best Practices

Requirements

• User privileges to ION * Security roles: IONDeskAdmin * User privileges to API Gateway * Security roles: IONAPI-Administrator * Optional classes on Infor U * Infor OS: Foundation for Multi-Tenant-Part 1 * Infor OS: Foundation for Multi-Tenant-Part 2 * Infor OS: Configuring ION Connect

---

Tutorial

Difficulty: Medium Estimated completion time: 45 Minutes

Swagger documentation is used for REST APIs, while WSDL documentation is for web services. Swagger outlines the HTTP verb methods (GET, POST, PUT, PATCH, DELETE), along with the request and response parameters and their types. For more information, refer to the official Swagger documentation. Many free REST APIs lack proper documentation—one example is an API for Exchange Rates, which we will create in this tutorial.

To accomplish this, you'll use a free tool called Swagger Editor, an online platform designed to help you create accurate API documentation. Here are the steps we'll follow:

• Create an Account and API Key. * Choose the endpoint you want to document. * Create the swagger documentation (swagger editor). * Test the documentation (swagger editor). * Register the custom API suite and upload the documentation. * Test the documentation (API Gateway).

1. Create an Account and API Key

The free API is protected by an API Key. To create the API Key you need to register an account.

Open a browser and go to this URL and provide Name, Email, Password, and Confirm Password and click on the Register button to create a new account.

Check your email and confirm your subscription.

Once verified, you are logged in and the API Key is created for you.

---

2. Choose the endpoint you want to document

When you are logged in, click the Docs link and then select Documentation .

Scroll down and on the left bar, select Latest Rates Endpoints .

You reached the endpoint description, which outlines the parameter specifications , their types ( optional or required ), and provides an example of the API response .

You can test it directly in your browser, by opening a new tab and pasting this URL :

https://commodities-api.com/api/latest ? access_key = API_KEY & base = USD & symbols = GBP,JPY,EUR Replacing the API_KEY with your API Access Key generated when you have created your account.

---

3. Create the swagger documentation (swagger editor)

Once you identified the endpoint for which you want to create the documentation, it's time to create it.

Open a new tab in your browser and go to this URL: Swagger Editor. You will see the page below.

This is the default example of Open API documentation for a Petstore API. Your goal is to create Swagger 2.0 documentation for your endpoint.

You wonder what is the difference between Open API and Swagger 2.0 documentation. Mainly there are 2 differences.

• Swagger 2.0 is the old definition for REST API and it is written in JSON format. * Open API 3.0.X is the new definition for REST API and it is written in YAML.

There are also tools that convert Swagger 2.0 to OpenAPI 3.0 and vice versa. Your goal will be to write Swagger 2.0 documentation and also see how to convert to OpenAPI 3.0.

Select and remove everything from the editor, and you will see this page.

You will be creating 4 parts:

• info * schemes * paths * definitions

3.1 info

In the "info" section, you have to provide the title , description , and version of the documentation, plus the host and the basePath of the endpoint. You will receive an error which you will fix later on.

3.2 schemes

In the "scheme" section, you have to provide the protocol [HTTP,HTTPS], in your case you have only HTTPS . You still have the same error which you will fix later on.

3.3 paths

In the "paths" section, you define the final part of the endpoint URL, specify the HTTP verb methods (such as GET, POST, PUT), and outline the parameters, including their types, as well as the structure for request and response bodies.

3.4 definitions

This part can be the most challenging, as it requires familiarity with JSON schema definitions. In this section, you define the types for the Request and Response payloads. In your case, since you're using the GET method rather than POST, there is no request payload to define, but you will need to create the schema for the Response payload.

For the Request, you’ve already defined the types in the parameters section. If not, you’ll need to create a new definition here. As you can see, these definitions can be quite complex, but we'll explore how to simplify the process. Since you’re working with a GET verb method, you can easily use your browser for testing. However, for POST verb methods, you'll need to use a client like Postman to make the API call.

Make the API call as generic as possible providing only mandatory values, in your case provide the API_KEY . The other parameters are optional. Copy the output.

Now you have to create a JSON schema for this JSON Object. You can find free tools on the internet like this one, copy the output and generate the schema.

Copy the generated schema and use it in the Swagger documentation. Remove the $schema line from the generated schema, give a Name to the definition and paste the JSON Schema.

---

4. Test the documentation (swagger editor)

Now that you have created the swagger documentation, let's test if it works. On the right side of the page editor expand the GET endpoint, click TRY IT OUT , provide the required parameter ( API_KEY ) and click the EXECUTE button. Check that the response is the same as the response you have received in your browser.

---

5. Register the custom API suite and upload the documentation

You have created a working Swagger 2.0 documentation for the free API, now let's try to use it in the API Gateway. To do that you have to create a New custom API Suite and upload the Swagger 2.0 documentation.

5.1 Register the custom API suite

Log into the Infor OS Portal and click the API Gateway menu label on the top bar.

Click the ( +Add ) tile to create a New API suite.

On the next page, click on the ( + Create New ) button.

Fill in all mandatory input and then click the ( + ) button below Target Endpoints tab.

Provide the Target Endpoint URL , the Target Endpoint Description , and the Proxy value (any value you like). Click Save .

• Target Endpoint URL - https://commodities-api.com/api * Target Endpoint Description - Latest Rates * Proxy value - proxy

Now you are ready for uploading the Swagger documentation.

5.2 Upload the documentation

Before uploading the Swagger 2.0 documentation, you have to apply a small modification.

The reason for this modification is that now the host and basePath are managed by the API Gateway and the basePath of the documentation is now related to the New custom API suite. Change the basePath to the correct path. (see the photos above).

Now that you have applied this modification, click on File and Save as JSON and store the file in a local folder. You may also notice the option to convert and save the file in YAML format. If you click on the Edit menu, there is the option to convert the swagger 2.0 documentation to OpenAPI3 as we discussed before.

On the Commodities API screen, under the Endpoints tab. Click on the Documentation icon.

You arrive at a new Proxy page, Scroll down to the Documentation tab and click the ( + ) button, on the Add Documentation page, provide a Name , from the drop down select Swagger as a Type and in the Enter URL or Upload Swagger JSON/YAML field select the JSON file you created with the Swagger editor. Click Save . The new custom API suite now has its own Swagger documentation.

---

6. Test the documentation (API Gateway)

Let's test now the custom API in the API Gateway. From the document tab, expand the resource definition, click the Try it out button, enter the API_KEY and click the Execute button. Check if the response is the same as what you get from the swagger editor and from the browser. You have created a swagger 2.0 documentation and you have registered a new API Suite, now you can use it in the API connection point of the ION Connect.

---

Downloads

API Suite & Swagger Editor Definition

Resources

Online help documentation:

• API Gateway * API Connector

## Overview Infor OS Platform features a robust API Gateway, which includes the powerful ION API Suite complete with workflow endpoints. This functionality enables seamless integration of your applications, allowing you to trigger workflows effortlessly. By leveraging these capabilities, you can enhance your system's interoperability, streamline business processes, and achieve greater efficiency across your enterprise solutions. Join us as we uncover the potential of Infor OS Platform and its API-driven approach to modern workflow management. * * * ### Components * [Enterprise Integration](https://developer.infor.com/components/enterprise-integration/) * [Enterprise Integration Best Practices](https://developer.infor.com/best-practices/enterprise-integration/) ### Requirements * Access to ION API Gateway * Security role: IONAPI-Administrator * Security role: IONAPI-User * [Infor U](https://education.infor.com/) courses. * * * ## Tutorial Difficulty: Medium Estimated completion time: 30 Minutes In this tutorial, we'll explore the powerful capabilities of Infor OS's API Gateway. You'll see how its robust ION API Suite, complete with workflow endpoints, enables seamless application integration to easily trigger workflows. Discover how to enhance interoperability and streamline processes with Infor OS. Let's examine how to call a workflow from an API. Log in to the Infor OS Portal and select the API Gateway tab at the top of the page.  The Available APIs option is in the navigation menu in the upper left corner. Clicking this will take you to the menu where all the accessible APIs are listed.  Using the search function at the top, Type in Infor ION and double click the Infor ION Suite.  It reveals a comprehensive list of endpoints, including two workflow-specific ION process endpoints. Our focus is on the IONSERVICES/process/application endpoint; proceed by clicking on its documentation.  The Swagger UI interface for this endpoint is displayed. Scrolling down we find the workflow /v1/workflow/start API listed among the available methods. Click on it.  Expanding the details revealing essential information such as required inputs. Specifically a logicalid and JSON body, it also provides a helpful example demonstrating how to structure the JSON.  Now let's click the try it out button.  To execute this API, input the Logical ID following this format: lid://infor.iondesk.iondesk .It's important to consult your system administrator to confirm your environment setup. Additionally, input the JSON body. A generic JSON is displayed as a default example or guide. We will paste the JSON using the following example, which specifies the workflowName of WF_DEMO and the pre-assigned instanceName of TestInstance . Even though this workflow doesn't require any inputs, we'll include one for demonstration.  Click the Execute button.  Below in the server response section, we've achieved a Code 200, signifying a successful execution. The response body reveals the ID of the workflow that's up and running.  We'll be using Postman to make a request call. Postman is a popular and freely available API client that can be found online. First, on the OS portal, we must build an Authorized App using the Web Application type for the request in Postman's OAuth2 Authentication setup. In this case, the application has not yet been authenticated within the Gateway. The user must authorize the mobile application to call the ION API on their behalf. This type of interaction uses the OAuth2 Authorization Code Grant .  On the navigation menu select Authorized Apps , then select the \+ button to create a new authorized app.  In the Name field enter Postman Web App Demo . For the Type , choose Web Applicatio n, and in the Description field, enter Postman Web App . Enter the Postman Redirect URL In this example, we will use this [https://oauth.pstmn.io/v1/browser- callback](https://www.getpostman.com/oauth2/callback). The Authorized JavaScript Origins field will be the same callback URL.  Click Save .  The Gateway will generate your Client ID and Client Secret , click the Download Credentials button to download the credentials file.  Open and view the Postman Web App Demo.ionapi credentials file, which will look like this. The file holds the details to call the API and Postman.  Log into Postman and create a new request collection using the Authorization methods template; click the \+ sign in the top left corner and select the View more templates link, or you can click the \+ sign in the tab section.  Click the Authorization methods button.  Click the Use Template button.  On the Authorization methods collection, click on the eclipsis and select Add request .  On the New Request collection, click on the ellipsis and select Rename . Give the Collection a new name.  We will name it API Workflow Demo .  Within the Params tab, enter the IFS Service /application/V1/workflow/start ION API URL in the POST parameters field. In this example we will enter The key named logicalId will be filled in with the required value for our API. lid://infor.iondesk.iondesk  Select the Authorization tab, and in the Auth Type field, choose OAuth 2.0 .  To acquire a new access token, scroll down to the Configure New Token section and enter the following Postman Mapping information from the downloaded Postman Web App Demo.ionapi credentials file performed in the previous steps.  Enter the relevant credentials into the required input parameter. In the Token Name field, enter Auth Code Token and set Grant type to Authorization Code . The Callback URL is the embedded Postman link (). The Auth URL is a concatenation of values pu + oa , similarly, the Access Token URL is a concatenation of pu + ot , The Client ID is value ci and the Client Secret is cs .  Scroll to the bottom of the page and click the Get New Access Token button.  Postman will initiate a handshake with Infor's Cloud OAuth authentication and take you to a login screen, where you must sign in. Once signed in you can see infor OS is prompting the Request For Approval regarding Postman using our credentials. Click the Allow button.  You will get the following message. You can click the Proceed button or wait a few seconds. The Manage Access Token screen will then appear.  This will provide a new token within the Postman application. On the Manage Access Tokens screen, click the Use Token button.   Click on the Body tab where we'll enter our JSON to call the API and kick off the workflow. Ensure the format is set to raw and JSON is selected from the dropdown. Paste in the script we successfully tested previously when we did the " try it out " in the ION API section of this tutorial.   Click the Send button, to trigger the chain of events we've set up.  You can see that the call was successful. Error Code 200 and a job ID of 56903 .  Go back to the OS Portal, and view active workflows in ION. Click the ION tab, and in the navigation menu expand Monitors and Workflows and select Active Workflows .  Searching for the WF_DEMO workflow. You can see the last one has a status of Running .  Let's confirm it's the one we executed in Postman by clicking on Workflow Instances .  There's the matching job ID of 56903 we got from Postman.  This Concludes this Tutorial on how to Start a workflow from an API. Watch the following video to view all the steps that were covered. https://www.youtube.com/watch?v=CFuRaN8NQK4&t=24s ## Resources Help Documents and User Guides * [API Gateway](https://docs.infor.com/inforos/latest/en-us/useradminlib_cloud/default.html?helpcontent=apigatewayag_cloud/cover.html)

Go beyond basic fit and customize your cloud experience with extensibility tools that leverage no-code, low-code, and full-code frameworks.

Use Machine Learning to build an AI into your business processes.

Manage data on the platform so that humans and systems can securely access information from anywhere.

Streamline the user experience with a digital assistant that helps your employees navigate and access information by voice or chat.

Leverage Infor's central document repository to manage your enterprise document in the cloud.

Create a unified application topology using the integration hub in the Infor Platform.

RPA automates repetitive tasks and empowers your team to focus on what they do best.

Tutorials that help you leverage Infor's cloud security and user management capabilities.