This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Setting up the Samples - API Manager 1.8.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

The API Manager binary distribution comes with a number of samples to demonstrate API Manager's basic functionality. These samples are located in <APIM_HOME>/samples folder. Inside this directory, there are sub directories for each sample. Each sub directory contains the relevant configurations, scripts and instructions required to run the a sample. Each sample contains an APIPopulator script, which drives the API Manager via a REST API.

The sections below describe the generic setup instructions and prerequisites to run API Manager samples:

Executing these steps only once is enough to try multiple samples in a single API Manager installation.


  • Java Development Kit/JRE version 1.6.* or 1.7.*
  • Apache Ant 1.6.x or later
  • An HTTP client tool such as cURL ( )
  • A JavaScript compatible web browser
  • An active Internet connection

Setting up samples

  1. Download and install the API Manager according to the instructions given in Getting Started.
  2. Before installing samples, you must configure libraries. Go to <APIM_HOME>/bin directory using a command prompt (on Windows) or text Linux console (on Linux) and type ant command. This step populates master data required for the API Manager to start up. For example, on Windows:

  3. Start the API Manager by executing <APIM_HOME>/bin/wso2server.bat (on Windows) or <APIM_HOME>/bin/ (on Linux). For more information, see Running the API Manager. This step also populates more master data required for the server to start up.
  4. Next, shut down the API Manager.

    It is a must to shut down the server before executing step 5 below.

  5. Run the ant command inside <APIM_HOME>/samples/Data directory. An output similar to following appears:

    It executes the UserPopulator.sql, which creates two user accounts as provider1 and subscriber1. You can use them to log in to the API Publisher and API Store respectively.

  6. Start the API Manager again and log in to the API Publisher (http://localhost:9763/publisher) using username/password as provider1/provider1. Similarly, log in to the API Store (https://localhost:9443/store) using username/password as subscriber1/subscriber1.

Next, proceed to executing the samples as described from the next section onwards.

  • No labels