How to use IBM® App Connect with Infobip

Infobip is a cloud communication platform that helps brands connect with and engage their customers. It provides a suite of tools for customer engagement and support, security, and authentication.

Availability:
  • A connector in IBM App Connect Enterprise as a ServiceApp Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 12.0.11.3-r1 or later

Connecting to Infobip

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your Infobip administrator to obtain these values.

Infobip connection fields:

Authorization type Connection fields Applicability
BASIC Server URL App Connect Enterprise as a Service and App Connect in containers
Username
Password
Allow self-signed certificates
Override server URL
Private network connection
API KEY Server URL App Connect Enterprise as a Service and App Connect in containers
API key
Allow self-signed certificates
Override server URL
Private network connection
The following table contains descriptions of the connection fields.
Connection field Description
Server URL Select the URL for the API server that makes runtime calls.
API key Specify the API key that you use to access Infobip.
Username Specify the username that is authorized to access Infobip.
Password Specify the password for the username.
Allow self-signed certificates Set to true or false. Set to true if you want to be able to accept self-signed certificates that are trusted and used only in a nonproduction environment. The default is false.
Override server URL Required if you want to connect to an endpoint in a private network by using the private network client, or if you want to override the server URL. Specify an override value for the host and port for the connector in the format <http or https>://<host_name>:<port>. If you are not using the private network client or do not require an override, leave this field blank.
Private network connection Select the name of a private network connection that App Connect uses to connect to your private network. This list is populated with the names of private network connections that are created from the Private network connections page in the Designer instance. You see this field only if a switch server is configured for this Designer instance. For more information, see Connecting to a private network from App Connect Designer. (In App Connect Designer 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.)

To obtain the API key (API KEY authentication method), complete the following steps:

  1. Log in to your Infobip account.
  2. Click the DEVELOPER TOOLS icon on the sidebar, and then select API keys.

    The API keys page appears.

    Tip: You can also choose to click Manage API Keys on the home page to directly open the API keys page.
  3. Click the CREATE API KEY button.

    The Create API key page appears.

  4. Enter a name for your API key.
  5. If necessary, change the expiration date for your API key.
  6. Select the API Scopes according to your requirements.
    Note: Select at least one API scope to successfully generate an API key.
  7. Click CREATE.
  8. Copy the API Key value and save it somewhere safe.
Tip: For more information about obtaining and managing the API key, see API authentication on the Infobip Docs page.

To connect to a Infobip endpoint from the App Connect Designer Catalog page for the first time, expand Infobip, then click Connect.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with Infobip, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

    For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and Actions

Infobip events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Infobip actions

Your flow completes these actions on this application.

Object Action Description
Account management Retrieve account balance Retrieves account's credit balance
Retrieve free messages count Retrieves account's free messages
Retrieve all accounts Allows you to retrieve all the accounts
Entities Retrieve entities Retrieves a paginated list of entities
Create entity Creates an entity associated with the specified entity ID
SMS Send SMS message Send an SMS and set up a rich set of features, such as batch sending with a single API request, scheduling, URL tracking, language, and transliteration configuration.
Voice Send single voice message Sends a single voice message to one or more destination addresses
WhatsApp Retrieve WhatsApp templates by sender number Retrieves all the templates and their statuses for a given sender
Send WhatsApp template message Send a single or multiple template messages to one or more recipients