Skip to main contentDemoHub - Cloud Pak for Integration

Build and deploy new integrations and securely expose them as APIs

Lab Overview

In this tutorial, you use the IBM Cloud Pak for Integration 2021.1.1 to deploy an App Integration flow on containers and expose it as a secure rate-limited API on RedHat OpenShift 4.6.

Extend your back-end integrations securely to partners and developers. Extending access via APIs to your back-end integrations empower your partners and developer community to create new business value, technical value, and customer experiences for your products and offerings. Spur innovations where a number of technologies are combined to create something new, for example, extending the ability apply for loan pre-approvals that can be used within apps that search for cars or real estate. To do this, you must first create the back-end integrations, which combine data from existing core systems, disparate assets, or SaaS services with the ability to send critical data between systems reliably. Second, you need to provide APIs to your back-end integrations that secure access and apply rate limits. In this tutorial, you learn how to deploy an app integration flow that takes data from one source and sends it to a message queue for reliable delivery. Then, you expose this integration as a rate-limited API secured by a key and secret. This integration flow is deployed quickly and easily as an independent, auto-scalable microservice running on containers. By using RedHat OpenShift as a foundation.


  • You need to have your personal CP4I on ROKS environment. Check here how to request it
  • You need to have the OC CLI and you should have logged in your ROKS cluster via command line. Check here how to do it
  • You should have an MQ Queue Manager runtime pre-created in your CP4I on ROKS environment.
  • You need to have the IBM App Connect Enterprise Toolkit installed in your desktop. Follow the sections Download IBM App Connect Enterprise for Developers and Install IBM App Connect Enterprise from this tutorial to install it.

Business Context

Implement enterprise grade messaging that is secure and reliable for any application across your backend integration architecture. Modern applications and APIs all need the ability to communicate data reliably between mission critical systems across internal/external data sources, networks, and regions. In mission critical environments your messaging infrastructure must be robust, reliable, and secure with the ability to integrate into your applications and APIs at pace and scale. In this tutorial, you create a message queue that receives order data from an API call to a retail ordering system. The red box in the diagram shows what you are creating and where it fits in the overall architecture of a mobile retail buying application.


  • Exploring multiple integration capabilities within a single platform
  • Configuring IBM MQ
  • Creating an integration flow that connects to a message queue
  • Deploy the integration flow as a container in Kubernetes
  • Checking the message using MQ Web Console
  • Configuring API in API connect
  • Sharing API in Asset Repository
  • Checking this message using Operational Dashboard (tracing)

Configuring IBM MQ

Task 1 - Configure Message Queue (MQ) to Authorize and Accept Data.

As this is a brand-new deployment of the Cloud Pak for Integration, all instances of integrations, message queues, and event streams are deployed as microservices. We need to authorize the Message Queue service to accept incoming data from the integration running on a separate server. Cloud Pak for Integration provides a single solution for all of your enterprise integration needs. The platform provides a comprehensive set of industry-leading capabilities. Use any of them on their own or together through a single interface. Create, manage, and monitor all of your integrations across SaaS applications, messaging, streams, APIs, high-speed transfer, and more. Unlock the power of your data and support the scale required for all of your integration and digital transformation initiatives.

1.You need to configure the MQ security. Open a browser and enter .

lab1 task2 1 github

2.Select and the click Download.

lab1 task2 2 select apic download

3.Repeat step 2 and download

4.The files and are in ~/Downloads. Uncompress the (use unzip, the unzip generates a directory mqconf with two files and mq_ace_lab.mqsc.

lab1 task2 4 unzip mqconf

5.In terminal window, check the name of MQ pods in your environment, using this command: oc get pods | grep mq. Your MQ pod is the pod that starts with mq-quickstart. Take note of the pod name (e.g.: mq-quickstart-ibm-mq-0).

mq pod

6.Execute the shell script to run MQ configuration (update the channel and security). Go to ~/Downloads/mqconf directory and enter ./ mq-quickstart-ibm-mq-0. The MQ configuration will be updated for this lab.

lab1 task2 5

7.Open a browser and go to your Cloud Pak for Integration Platform Navigation. On the Message box, click to open your MQ Queue Manager Runtime.

view capabilities

*Note: Maybe you need to log in again. Use your admin username and Password (Enter the 32 characters password that you created when you made the Cloud Pak provisioning) and click Log in.

lab1 task1 2 userid password

9.In the Welcome IBM MQ page. This page, you can manage queue manager, create queues, learn MQ basics, and get more information about IBM MQ. Click Create a queue.

lab1 task2 8 access mq console

10.In Create a queue page. You can choose queue type: Local, Alias, Remote, and Model. Click local to create a queue.

lab1 task2 9 create a queue

11.Enter the queue name: ORDERS (this is case-sensitive) and keep the default values and the click Create.

create queue

12.Click Manage QUICKSTART and You see the queues window. You see queue names, type and queue depth.

lab1 task2 11 show queues

Creating a BAR file

Task 2 – Configuring the integration flow using App Connect Enterprise Toolkit

This task covers opening and examining an application integration flow in the IBM App Connect Enterprise Toolkit. With the Toolkit you can build powerful and complex integration applications, services, and APIs quickly and easily using a visual designer. Your integration solutions can be directly deployed to the Cloud Pak for Integration on IBM Cloud Pak running on-premise, in any cloud, or combinations of both.

1.Open a terminal window. If you are using MAC click App Connect Enterprise Toolkit icon and go to the Step 3.

2.Before starting App Connect Enterprise toolkit, let’s check IBM MQ IP address. In th terminal window, enter the OpenShift command, oc get svc -n cp4i | grep mq to get a list of services in the namespaces. and copy the IP address ( which the port is 1414.

mq get svc

3.Open your App Connect Enterprise Toolkit by clicking the icon or executing ace toolkit in terminal window (depends of your operational system).

4.In the Workspace Launcher window, choose the workspace ~/IBM/ACET11/workspace/ace-apic. Click OK.

lab1 task3 3

5.The toolkit opens the project. Import the file that you downloaded ( see ~/Downloads/ ). Select File->Import->Project Interchange and click Next.

import zipfile


6.The toolkit opens the project. To view the integration flow that you deploy, click orders -> Resources -> Subflows -> getOrder.subflow .

lab1 task3 4

7.Check the MQ node by clicking the MQ Output Node. Click Properties and select Basic, and enter the queue name (you created in MQ Task) ORDERS.

lab1 task3 5

8.Select the MQ connection tab. App Connect Enterprise uses a mq client connection. Select MQ client connection properties (1). Type Destination queue manager name: QUICKSTART (2). Enter the IP of your MQ Queue manager host, identified the beginner of this task (3). Type port number: 1414 (4). Type Channel name: SYSTEM.DEF.SVRCONN (5). Save the flow (Control + S).

lab1 task3 7

9.In the Application Development view on the left, on orders flow, right-click and then select New -> BAR file.

lab1 task3 8

10.Enter the name of BAR file: orders and click Finish. App Connect Enterprise is creating an empty BAR file.

lab1 task3 9

11.You need to configure which artifacts are compiled in the BAR file. Check orders and check Compile and in-line resources, then click the Build and Save button. A pop-up window displays “Operation completed successfully.” Click OK.

lab1 task3 10

Deploying a BAR file

Task 3 – Deploy Integration BAR file as containers

In this task, you deploy a BAR file in App Connect Enterprise Dashboard.

1.Back to the Cloud Pak Platform Navigator in the browser. Open the Menu and on the Run section, open the Integrations dashboard.

2.To deploy the file, you need to create an Integration server. Let’s do it! Click Create a server.

lab1 task4 2

3.In the Create an Integration Server page, you have two options to deploy a BAR file: Deploy a BAR file from App Connect Toolkit or from App Connect Designer. In this lab you deploy BAR file from App Connect Toolkit. Select Quick start toolkit integration option and click NEXT.

create integration server

4.Click to upload your BAR File. And select the (~/IBM/ACET11/workspace/ace-apic/BARfiles). And click Next.

create server from bar

5.You don’t need to download configuration package (Configuration package contains the files that you can use for App Connect Enterprise works with Databases, Event Streams, etc) click Next.

server config

6.On Create an Integration Server page, enter the Integration Server name as orders (1). Switch to On to Enable Operations Dashboard tracing (2). Enter cp4i as namespace(3). Then click Create (4).

server details

7.During the deployment process, App Connect Enterprise opens the servers page. You see the App Connect Enterprise Dashboard with the Integration Server orders deployed and started .Click the orders server icon.

Note: The deployment process takes 2-3 minutes, refresh the browser to see the BAR file.

lab1 task4 8

8.Click orders API.

lab1 task4 9

lab1 task4 10

10.From the terminal window, execute the following curl command and complete with 0000. Enter:

curl -G -k

If the API call is successful, you see JSON reply with {“accountid”:“ABC-1234567890”,“orderid”:“0000000”}

lab1 task4 11

11.You check the message arrived in queue ORDERS in MQ You can check using MQ Console. Open a browser and go to Cloud Pak Platform Navigator and click mq link. Click Manage QUICKSTART.

lab1 task4 12

12.You see in the queues on QUICKSTART. The queue ORDERS has a message (look at Queue Depth)

lab1 task4 13

Configuring API Connect

Task 4 – Configuring API Connect to test the integration

You’ve created an application integration flow and successfully called it via a REST API call! Now, to make it accessible to the rest of the world, it’s important to add security around it—at least in the form of a client ID .This way, in addition to access control, you can get insights into which teams or customers are the least and most active. Adding security to an API is simply done via an OpenAPI configuration parameter. We can add rate limits to the API to increase the calls per second, minute, or hour to scale up as much as you need.

Note: During some tests, we found some issues to execute this task on Chrome browser, because of security certification issues. We recommend to use Firefox during this task.

1.Open the orders API. Then click Download OpenAPI Document link. The file is saved as orders-1.0.0.yaml file in ~/Downloads directory.

download openapi

2.Now, you will do a manual edition of the Open API YAML file. Open your YAML file with any editor and manually add the attribute below at the end of your document:

gateway: datapower-api-gateway

yaml edition

3.Open the Menu and on Run section, select APIs.

open api manager

You might receive a Warning: Potential Security Risk Ahead. Click Advanced and then Accept the Risk and Continue.

4.In the API Connect page, click IBM Common Services user registry.

lab1 task6 4

5.Click Develop APIs and Products.

lab1 task6 5

6.Click Add, then choose API (from REST, GraphQL or SOAP) from the drop-down menu.

create api

7.Choose From an existing OpenAPI service, scroll down and click Next.

create from existing service

8.Click Drag and drop files here or click to upload and select order-1.0.0.yaml from ~/Downloads directory. Then click Next.

lab1 task6 8

9.Confirm the Info about API and click Next.

lab1 task6 9

10.Keep the security settings and click Next.

lab1 task6 10

11.Your API with Client ID is created! Click Edit API.

lab1 task6 11

12.In the API Setup page. Let’s put our API Online (1) and click Save (2).

api setup

13.Let’s test the API. Click the Test link and replace {order} for 0000 in GET command. Click Send.

lab1 task6 13

14.Scroll down and see Body and check the results. You see a status code: 200 created with a response body containing the results details.

lab1 task6 14

15.You need to get the Developer Portal, click Manage icon on the left navigator.

manage api

16.Click on Sandbox.

lab1 task6 16

Note: You should have the Portal already configured (if not, go ahead and configure, it is really simple).

lab1 task6 17

18.Open a new browser tab, and go to the Developer Portal server using the Portal URL. Click Create account to create a developer account.

portal create account

19.Go ahead and complete the Registration Form. Then activate the new account from the email link. When is ready, log in with the new developer user.

lab1 task6 19

20.In the Developer Portal, on the Explore products section, click orders auto product 1.0.0.

lab1 task6 20

21.You need to subscribe to Default Plan, clicking Subscribe.

lab1 task6 21

22.Create an Application, clicking Create Application.

lab1 task6 22

23.Create an application called myapp and click Save. You will use this application to test the API.

lab1 task6 23

24.Here you can see the credentials for your new application (API Key and secret). You will not use this credential in this lab, just close the window.

lab1 task6 24

25.Click myapp icon to select Application.

lab1 task6 25

26.Confirm the subscription for orders auto product. Click Next.

lab1 task6 26

27.The subscription is completed. Now click Done.

lab1 task6 27

28.Click orders 1.0.0, to open the API.

lab1 task6 28

29.In orders 1.0.0 page, select GET/{order} (1). Click on Try it (2). Enter 0000* as order parameter (3). Click Send**.

lab1 task6 29

30.The results are shown in the response string.

lab1 task6 30

Sharing the API

Task 5 - Share the API

Now that you’ve built, secured, published, and tested your API, the last step is to add it to the Asset Repository. With the Asset Repository, your organization can store, manage, and share all of your integration assets in one central location. Sharing assets in this way increases collaboration between teams, avoids unnecessary duplication and boosts productivity.

1.To push our new API to Asset Repository you will use the API Manager. Back to the Cloud Pak for Integration Navigator Platform browser tab. Open the Menu and on Run section, select APIs.

open apimanager

2.In the API Manager screen, click Develop APIs and Products.

lab1 task7 3

3.On the Develop Screen, select the menu next to your API and from the drop-down, click Push to asset repository.

lab1 task7 4

4.Once the upload completes, you see a success dialogue at top-right.

lab1 task7 5

5.Now, let’s explore the Asset Repository. Open the Menu again and select Integration Capabilities.

integration capabilities

6.Click on the Automation assets capability link.

asset repo link

7.Here you see the orders asset that you pushed from API Connect in the previous step. Open the context menu and choose Open to check the orders API.

open order asset

8.Here you can see the API overview.

lab1 task7 8

9.Click Get/{order} link. Here you can see the API parameters.

lab1 task7 9

10.Click Definitions and then click the arrow on order. Here you can see an example of results.

lab1 task7 10

Great! Here you learned how developers can leverage the Automation Assets repository to implement a culture of reusability. Additional information about the asset is available in the sidebar including when the file was created, a description that explains the purpose and use, and any relevant tags

Using Operations Dashboard

Task 6 – Using Operations Dashboard (tracing)

Cloud Pak for Integration - Operations Dashboard Add-on is based on Jaeger open source project and the OpenTracing standard to monitor and troubleshoot microservices-based distributed systems. Operations Dashboard can distinguish call paths and latencies. DevOps personnel, developers, and performance engineers now have one tool to visualize throughput and latency across integration components that run on Cloud Pak for Integration. Cloud Pak for Integration - Operations Dashboard Add-on is designed to help organizations that need to meet and ensure maximum service availability and react quickly to any variations in their systems.

1.Let’s explore the Operations Dashboard. Open again the Menu, and on the Administration section, open Integration capabilities.

integration capabilities

2.From the Capabilities list, open Integration tracing link: tracing-demo.

tracing demo

3.In the Tracing page, check the Overview page. Here you can check the products that you can use this tool: APIC ,APP Connect and MQ. (more tracing products will add in the future releases).

lab1 task8 2

4.You can monitor each product separately. Click App C overview.

lab1 task8 3

5.Now, let’s explore the API C overview.

lab1 task8 4

6.Operations Dashboard generated a list of tracing. Select Traces on the left menu. And select the line that you want to see the trace.

lab1 task8 5

7.You are welcome to explore the tracing.

lab1 task8 6


You have successfully completed this lab. In this lab you learned how to:

  • Deploy a back-end integration to containers that are readily available as a scalable web service.
  • Secure access to the back-end integration by creating a secure, governed API using the OpenAPI definition of the integration.
  • Use Operations Dashboard to tracing MQ, APIC and APPC

Now that you’ve made your back-end integrations ready for external distribution, your developer community is able to access the APIs via a developer portal. The developer portal is included in the platform and provides a full-featured experience to onboard and nurture your API consumers. For more information about Cloud Pak for Integration, access here.