This guide gives a quick walk through the WSO2 API Manager product to get started fast. It introduces some of the basic features and the process from creating to testing a simple API. For a detailed description of how to install, set up and use the product's features and functionality, see each individual section of this documentation.
This guide covers the following:
|Table of Contents|
Setting up the API Manager
- Ensure that the following prerequisites are satisfied.
- JDK 1.6.* or higher installed.
- JAVA_HOME environment variable is set to <JDK_HOME>. For example,
- Download the API Manager Binary distribution from http://dist.wso2.org/products/api-manager/1.4.0/wso2am-1.4.0.zip
- Extract the zip file to a folder which will be referred to as the <APIM_HOME> throughout the rest of this guide.
- Open a command prompt (or a shell in Linux) and go to <PRODUCT_HOME>/bin directory.
- Start the API Manager server by executing wso2server.sh (or wso2server.bat in Windows).
- The operation log keep running until the server starts, which usually takes several seconds. Wait until the server has fully booted up and displays a message similar to "WSO2 Carbon started in n seconds."
If the default language settings of your web browser is not English or Spanish you will come across an issue of getting 'null' as the lables in API Publisher and Store. To overcome this you can change the default browser language to English OR
two files, replacing 'en' with your language code.
ex: If the browser is running on Italy language, rename to locale_it.json.
By following either of above, the API Store and Publisher will display in English. If you want to change the language of the API Store and Publisher Web interface to your local language, see Internationalization and Localization.
Creating an API
Now that the API Manager is up and running, let's create a simple API using the API Publisher Web application.
- Open a web browser and access the URL: https://localhost:9443/publisher.
- You should see the API Publisher login screen. Type user/password as admin/admin and click Log in button.
- The API Provider home page opens with all created APIs listed. Since first-time users haven’t created any APIs so far, they will not see any APIs. Click on the Add button to open the Add New API window.
- As our first example, we are going to create an API named TestAPI, which is based on the YouTube functionality provided by
Enter following values into the respective fields of the Add New API form. In this example, we have not provided some fields which are optional.
. Our API will accept both GET and POST requests and the output will be an Atom feed.
- Name: TestAPI
- Context: /youtube
- Version: 1.0.0
- Visibility: Public
- Endpoint Security Scheme: Non Secured
- Production URL:
- Tiers Availability
: Gold, Silver, Bronze (select all 3 – this field supports multiple values)
Anchor tiers tiers
- Click Create at the end of the form to save the API configuration. You will be taken back to the API Provider home page where the new TestAPI will be listed.
- By clicking the TestAPI, you can open its Overview tab, which lists a summary of the information entered when creating the API. The page also has other tabs.
Publishing the API
When you create a new API, it's initially in the CREATED state of its life cycle. When an API is in this state, the consumers cannot see it in the API Store. To enable consumers to view and subscribe to this created API, it should be promoted to the PUBLISHED state.
- To publish the API, select the Life Cycle tab where you will see a drop down with different states the API can be in.
- Select the PUBLISHED state in the drop down and click the Update button to apply the state change. The API Provider immediately displays the API state as PUBLISHED.
Subscribing to the API as a consumer
Now that the API is published, consumers should be able to see it and subscribe to it through the API Store.
- To access the API Store, open a Web browser and type the URL: https://localhost:9443/store. The TestAPI will be listed on the home page itself. Anonymous users also can access this API. You must log in to subscribe to an API.
- Log in to the API Store (Log in link is in the top right-hand corner of the screen) to see the Subscribe option.
- To subscribe to an API, you should have an application in place. Select the
DefaultApplicationin the Applications drop down.
- The Tiers drop down lists all the tiers specified when creating the API. Select the Gold tier and click on the Subscribe button.
- Choose to proceed to the My Subscriptions page in the pop-up that appears.
- Click Generate to obtain a key for your application. You need these access keys to invoke the API.
Testing the API
Any REST client can be used to invoke the TestAPI. For Curl, use the following command to invoke it.
curl -v -H "Authorization: Bearer xxxxx"