Lab 3: Deploy the Omni Channel API implementation


In this lab we’ll deploy the complete Omni Channel API from Lab 2 to the Cloudhub iPaas Platform from Anypoint Studio itself the same way a developer would.

CloudHub is the world’s first integration Platform as a Service (iPaaS). CloudHub is built on top of Mule, the most widely used integration platform. CloudHub lets you manage applications in the cloud and manage servers located in your organization.

Step 1: Deploy the Complete Omni Channel API to Cloudhub

Let’s begin:

  1. Let’s deploy it to Cloudhub. Right click on the project nameAnypoint PlatformDeploy to Cloud.

    module2 lab3 step1 1 deploy to cloudhub
  2. If this is your first time deploying in this way, a popup menu asks you to provide your login credentials for Anypoint Platform. Studio stores your credentials and uses them automatically the next time you deploy to CloudHub.

    You can manage these credentials through the Studio Preferences menu, in Anypoint Studio > Authentication.

    Once logged in to the Anypoint Platform one needs to select an Environment and Business Group. Choose the one Business Group you have access to and select as environment Sandbox.

    module2 lab3 step1 2 choose environmentand businessgroup
  3. Now we need to specify application (worker) configuration for our API.

    1. On the application name put <<MyName-omni-channel-api>>. You should see a green check if the name is available. If not, please use another name

      1. Save this name as you will use it later on. An example would be donald-omni-channel-api

    2. On Runtime version select 4.3.0

      You can manage these credentials through the Studio Preferences menu, in Anypoint Studio > Authentication.

    3. On Worker Size select 0.1 vCore and SANDBOX as the environment

      module2 lab3 step1 3 deploy runtime manager
  4. Once the configuration is done, click on the Deploy Application button.

  5. Once the deployment is complete (it may take a few minutes), you can browse the API Console at http://<<username-omni-channel-api>>.<region>

    The Region may change depending on which Platform you are working US or EU.

    In the previous example it would be something like

    module2 lab3 step1 4 api console

    Now you have a fully functional Omni Channel API of your own.

Step 2: Test the API from a Mobile Application

Your API application is running on CloudHub, lets try to hit it using a mobile application. We have developed a mobile application to test our APIs. This mobile application will invoke your REST API using the CloudHub URL.

You can access the mobile application through:

Follow the instructions there to access an emulator of the mobile app or download the mobile app to your phone.

  1. Click on create a new account and create an account to access the Mythical Mobile Commerce App

    module2 lab3 mobile signup
  2. Login using your email address. The mobile app is not enforcing any authentication yet, so the password can be anything.

    module2 lab3 mobile login
  3. To connect this to your Mobile Experience API, go to Settings and add the Cloudhub URL for your Mobile Experience API.

    module2 lab3 mobile settings2

    The mobile app will communicate with your Experience API to bring your design to life with API Led Connectivity!

    module2 lab3 mobile list


In this lab, we

  • Deployed our Omni Channel API application to Anypoint Platform’s CloudHub directly from Studio. CloudHub provides you a way to manage your applications in the cloud or servers located on-premises.

  • Test the application through the Mobile App.

Go Further:

Congratulations! You have completed Lab 3.

Please proceed to Lab 4