To create a flow that passes key data between your applications or APIs, you must connect App Connect to each application and API in the flow. You’ll need to provide account details for each application and API that you want to connect. The type of account information required varies by application and by API:

  • With some applications, you’ll need only an email address (or user name) and password to connect. With others, you might require information such as subdomain or host details, or a client ID and secret, and might need to consult your administrator to obtain the relevant details. If your application server is in a private network in an on-premises location or private cloud, you’ll also need to set up a gateway for secure access and reference that gateway while connecting. For details about the account information required for individual applications, see the How-to guides for apps. For information about setting up a gateway for secure access to application servers in a private network, see Configuring a private network for IBM App Connect on IBM Cloud.
  • For APIs, you’ll require a user name and password, an API key, or no authentication based on the security scheme defined for the API you are connecting to.

You can add account details in two ways:

Before you create a flow
You can connect to your applications from the Applications tab on the App Connect Catalog page, and connect to your imported and shared APIs from the APIs tab.

  • To connect to an app from the Applications tab, click the app and then click the Connect button to enter the account information.

    Connecting to an app from the Applications tab

  • To connect to an API from the APIs tab, click the API and then click the Connect button to enter the account information.

    Note: To successfully connect to an API, its API definition must meet a set of OpenAPI requirements.

While you are creating a flow
You can connect to an application or imported API from the flow editor while creating a flow.

  • To connect to a selected app from the flow editor, first select the event or action that you want to add, and then click Connect to enter the account information.

    Connecting to an app from the  flow editor

  • To connect to an imported API from the flow editor, first select the action (or operation) that you want to add, and then click Connect to enter the account information.

    Note: You can connect to a shared API only from the APIs tab on the App Connect Catalog page.

While connecting, you might also be informed that App Connect wants to access your account for the app. If you see this prompt, be sure to grant App Connect access to that app.

  • Example of a prompt for access

    Prompt for access to an app's account

After you connect the first account from the Applications or APIs tab or from the flow editor, a default name for the account is shown in a drop-down list below the application or API name.

  • Example of a connected Gmail account in the Applications tab

    Connected account in the Applications tab

  • Example of a connected Gmail account in the flow editor

    Connected account in the flow editor

Accounts are typically added using the following naming convention:
Account n (user_identifier)
where:

  • Account n represents an account name. When you add an account, its default name is given as Account n, where n is a number that starts from 1 and increments for each account added for that app or API. You can change the default name to make it more meaningful; for example, by assigning a name such as Test instance, US Lab, or Inventory API (1000 calls per min), which helps you identify the application or API to which you are connected or the credentials used to connect.
  • (user_identifier) provides additional contextual information such as the email address or user name that is associated with the account, or a generic label; for example: (my_email@example.com), (username), (My Wufoo Account). This value varies based on the application, and might be null for some apps and for APIs.

Tip: You cannot rename the account for an application if that account is currently being used in a flow; so it’s best to rename your account immediately after you connect. You can rename the account for an API regardless of whether the account is used in a flow. To rename an account, click the Accounts options menu [⋮] on the Applications or APIs tab, and then select Rename Account.

Renaming an account

After you add an account for an app, you can use that account in multiple flows. You can also add multiple accounts for an app if required, and can update your account credentials in App Connect or remove redundant accounts. For more information, see Managing accounts in App Connect.

Join The Discussion

Your email address will not be published. Required fields are marked *