Adding BMC Helix iPaaS APIs to BMC Helix Innovation Studio

To integrate your BMC Helix Innovation Studio applications with other third-party applications, you must connect to BMC Helix iPaaS and add the APIs available in BMC Helix iPaaS.

To connect to BMC Helix iPaaS

1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
2. Select Integrations > iPaas Jitterbit > iPaaS Jitterbit configuration. 
   

3. On the Helix iPaaS Jitterbit configuration page, enter the following details:

   Field	Description
   iPaaS Jitterbit API endpoint URL	The API URL for the BMC Helix iPaaS service.  For example, https://calbro.jitterbit.com/
   User name	User login name to connect to BMC Helix iPaaS service.
   Password	Password to connect to the BMC Helix iPaaS service.

4. Click Test connection.

   Important

   If the connection fails, verify that you have entered the correct endpoint API, user name and password.

5. After successfully testing the connection, click Save.

To add BMC Helix iPaaS APIs to BMC Helix Innovation Studio

Before you add the APIs available in BMC Helix iPaaS, make sure that you have defined the Organization, Environment, and generated and published the APIs in BMC Helix iPaaS. For more information, see the following topics on Jitterbit Success Central:

• Cloud Studio Quick Start Guide

• Jitterbit Harmony API Integration Platform documentation

1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
2. Select Integrations > iPaas Jitterbit > iPaaS Jitterbit APIs. 
3. On the iPaaS Jitterbit APIs page, click Add. 
   

4. On the Add API page, enter the details described in the following table:

   Field	Description
   API path
   Organization	Select the organization that you have defined in BMC Helix iPaaS. If you have defined a single organization in BMC Helix iPaaS, then the value is automatically populated. You create and manage your company's integration projects in an organization.
   Environment	Select the environment within the organization defined in BMC Helix iPaaS. You define and manage the project's lifecycle in an environment like Development, Test, and Production within an organization.
   API paths	Select the API you created within the environment; for example, /development/createIssue. Important: If the API paths are not displayed for the selected environment, make sure that you select the appropriate environment on the Portal Manager page, and click Regenerate Docs & Publish. For more information, see API Manager.
   API properties
   API group name	Select the existing group name. To create a new group, click Add new. An API group is used to organize related APIs. For example, you can use one group to add all the APIs with the same endpoint.
   API name	Enter a name for the API.
   Request methods	Select the HTTP method for the API. If you have defined a single request method for the API path in BMC Helix iPaaS, this value is automatically populated when you select the API path.
   Authorization type	Select the authorization type for the API path. If you have defined a single authorization type for the API path in BMC Helix iPaaS, this value is automatically populated when you select the API path.
   API variables
   Headers	Add the headers for this API request. Headers represent the metadata associated with the API request and response.
   Query parameters	Add the query parameters for this API request. Query parameters control what data is returned in the endpoint responses.

5. Click Save. 
6. (Optional) To edit the APIs, on the iPaaS Jitterbit APIs page, click on the API name that you want to edit. 
   From the Edit API page, update the value of the fields you want to update, and click Save. 
7. (Optional) To rename an API group, on the iPaaS Jitterbit APIs page, select the Group name that you want to rename. 
   On the Rename API group dialog box, in the API group name, update the existing group name, and click Save.

Where to go from here

Leveraging-BMC-Helix-iPaaS-APIs-in-a-business-process