Skip to content

Quick Start Guide

Let's get started with WSO2 Micro Integrator by running a simple integration use case in your local environment.

Before you begin...

  1. Install Java SE Development Kit (JDK) version 11.
  2. In the environment variables, set the JAVA_HOME environment variable.


    For more information on setting the JAVA_HOME environment variable for different operating systems, see the Install and Setup documentation.

  3. Go to the WSO2 Micro Integrator web page, click Download, and then click Zip Archive under the 'Latest Release' section to download the Micro Integrator distribution as a ZIP file.

  4. In the same page click on Integration Studio under the 'Other Components' section to download WSO2 Integration Studio.


    For more information, see the installation instructions.

  5. Download the sample files. From this point onwards, let's refer to this directory as <mi-qsg-home>.

  6. Download curl or a similar tool that can call an HTTP endpoint.

What you'll build

This is a simple service orchestration scenario. The scenario is about a basic healthcare system where the Micro Integrator is used to integrate two back-end hospital services to provide information to the client.

Most healthcare centers have a system that is used to make doctor appointments. To check the availability of the doctors for a particular time, users typically need to visit the hospitals or use each and every online system that is dedicated to a particular healthcare center. Here, we are making it easier for patients by orchestrating those isolated systems for each healthcare provider and exposing a single interface to the users.


You may export<mi-qsg-home>/HealthcareIntegrationProject to Integration Studio to view the project structure.

In the above scenario, the following takes place:

  1. The client makes a call to the Healthcare API created using Micro Integrator.

  2. The Healthcare API calls the Pine Valley Hospital back-end service and gets the queried information.

  3. The Healthcare API calls the Grand Oak Hospital back-end service and gets the queried information.

  4. The response is returned to the client with the required information.

Both Grand Oak Hospital and Pine Valley Hospital have services exposed over the HTTP protocol.

The Pine Valley Hospital service accepts a POST request in the following service endpoint URL.


The Grand Oak Hospital service accepts a GET request in the following service endpoint URL.


The expected payload should be in the following JSON format:

        "doctorType": "<DOCTOR_TYPE>"

Let’s implement a simple integration solution that can be used to query the availability of doctors for a particular category from all the available healthcare centers.

Step 1 - Set up the workspace

To set up the integration workspace for this quick start guide, we will use an integration project that was built using WSO2 Integration Studio:

  1. Extract the downloaded WSO2 Micro Integrator and sample files into the same directory location.

  2. Navigate to the <mi-qsg-home> directory. The following project files and executable back-end services are available in the <mi-qsg-home>.

  3. HealthcareIntegrationProject/HealthcareIntegrationProjectConfigs: This is the ESB Config module with the integration artifacts for the healthcare service. This service consists of the following REST API:

    <?xml version="1.0" encoding="UTF-8"?>
    <api context="/healthcare" name="HealthcareAPI" xmlns="">
        <resource methods="GET" uri-template="/doctor/{doctorType}">
                                <endpoint key="GrandOakEndpoint"/>
                            <payloadFactory media-type="json">
                                "doctorType": "$1"
                                    <arg evaluator="xml" expression="$ctx:uri.var.doctorType"/>
                                <endpoint key="PineValleyEndpoint"/>
                        <messageCount max="-1" min="-1"/>
                    <onComplete aggregateElementType="root" expression="json-eval($">

    It also contains the following two files in the metadata folder.


    This data is used later in this guide by the API management runtime to generate the managed API proxy.

    HealthcareAPI_metadata.yaml This file contains the metadata of the integration service. The default serviceUrl is configured as http://localhost:8290/healthcare. If you are running Micro Integrator on a different host and port, you may have to change these values.
    HealthcareAPI_swagger.yaml This Swagger file contains the OpenAPI definition of the integration service.

  4. HealthcareIntegrationProject/HealthcareIntegrationProjectCompositeExporter: This is the Composite Application Project folder, which contains the packaged CAR file of the healthcare service.

  5. Backend: This contains an executable .jar file that contains mock back-end service implementations for the Pine Valley Hospital and Grand Oak Hospital.

  6. bin: This contains a script to copy artifacts and run the backend service.

Step 2 - Running the integration artifacts

Follow the steps given below to run the integration artifacts we developed on a Micro Integrator instance that is installed on a VM.

  1. Run script in <mi-qsg-home>/bin based on your operating system to start up the workspace.

    1. Open a terminal and navigate to the <mi-qsg-home>/bin folder.
    2. Execute the relevant OS specific command:



      The script assumes MI_HOME and <mi-qsg-home> are located in the same directory. It carries out the following steps.

      • Start the back-end services.
      - Two mock hospital information services are available in the `DoctorInfo.jar` file located in the `<mi-qsg-home>/Backend/` directory.
      - To manually start the service, open a terminal window, navigate to the `<mi-qsg-home>/Backend/` folder, and use the following command to start the services:
      java -jar DoctorInfo.jar
      • Deploy the Healthcare service.
      - Copy the CAR file of the Healthcare service ( from the `<mi-qsg-home>/HealthcareIntegrationProject/HealthcareIntegrationProjectCompositeExporter/target/` directory to the `<MI_HOME>/repository/deployment/server/carbonapps` directory.
  2. Start the Micro Integrator.

    1. Execute the relevant command in a terminal based on the OS:

    === "On MacOS/Linux/CentOS"

    === "On Windows"

  3. (Optional) Start the Dashboard.

    If you want to view the integration artifacts deployed in the Micro Integrator, you can start the dashboard. The instructions on running the MI dashboard is given in the installation guide:

    1. Install the MI dashboard.
    2. Start the MI dashboard.

You can now test the HealthcareIntegrationService that you just generated.

Step 3 - Testing the integration service

  1. Invoke the healthcare service.

    Open a terminal and execute the following curl command to invoke the service:

    curl -v http://localhost:8290/healthcare/doctor/Ophthalmologist

    Upon invocation, you should be able to observe the following response:

             "name":"John Mathew",
             "time":"03:30 PM",
             "hospital":"Grand Oak"
             "name":"Allan Silvester",
             "time":"04:30 PM",
             "hospital":"Grand Oak"
             "name":"John Mathew",
             "time":"07:30 AM",
             "name":"Roma Katherine",
             "time":"04:30 PM",
    Congratulations! Now you have created your first integration service. Optionally, you can follow the steps given below to expose the service as a Managed API in API Manager.

What's next?