About API Manager

As an organization implements SOA, it becomes beneficial to expose its core processes, data and services as APIs to the public. External parties can mash up these APIs in innovative ways to build new solutions. A business can increase its growth potential and partnership advancements by facilitating developments that are powered by its APIs. For example, the WSO2 Gadget Server leverages the Google Gadget API, ensuring that users of WSO2 Gadget Server can easily develop and deploy their own or third-party Google gadgets in it, in a simple, decentralized manner.

However, leveraging APIs in a collaborative manner introduces new challenges in exercising control, establishing trust, security and regulation. As a result, proper API management is crucial. The WSO2 API Manager overcomes these challenges through a set of features for API creation, publishing, life cycle management, versioning, monetization, governance, security etc. It facilitates two Web interfaces for development teams to deploy and monitor APIs and offer managed APIs through an API Store, which enables consumers to subscribe to and utilize APIs.

The WSO2 API Manager is an on-going project with continuous improvements and enhancements introduced with each new release to address new business challenges and customer expectations. WSO2 invites users, developers and enthusiasts to get involved or get the assistance of our development teams at many different levels through online forums, mailing lists and support options. We are committed to ensure you a fulfilling user experience at any level of involvement with the WSO2 API Manager.

Known Issues

For a list of known issues in the API Manager version 1.0.0, please refer to the following link in WSO2 Oxygen Tank: WSO2 API Manager 1.0.0 - Known Issues.

Community Resources

WSO2 is willing to provide you guidance for any technical issues or questions regarding the WSO2 API Manager product. You can communicate with the API Manager development team directly using the following mailing lists:

WSO2 encourages you to report issues and enhancement requests for WSO2 API Manager using the publicJIRA available at https://wso2.org/jira/browse/APISTORE. You can also track their resolutions and comment on the progress.

Questions regarding the Application Server can also be raised through http://stackoverflow.com. Ensure that you tag the question with appropriate keywords such as WSO2 and API Manager so that our team can easily find your questions and provide answers.

For tutorials, articles, Webinars and similar resources, visit the WSO2 Oxygen Tank and search under the Resources menu.

Support Options

WSO2 also offers a variety of development and production support programs, ranging from Web-based support during normal business hours, to premium 24x7 phone support. WSO2 is committed to ensuring that your enterprise middleware deployment is completely supported from evaluation to production. Our unique approach ensures that support leverages the open development methodology and is provided by the very same engineers who build the products. For additional support information please refer to http://wso2.com/support.

Get Involved

WSO2 invites you to contribute by checking out the source from SVN using the following commands. This project uses Subversion to manage its source code. Instructions on Subversion can be found at http://svnbook.red-bean.com.

The WSO2 API Manager release 1.0.0 is based on Carbon 4.0.0.

Anonymous Checkout

The complete source including the Carbon platform can be checked out anonymously from SVN with this command:

$ svn checkout http://svn.wso2.org/repos/wso2/carbon/kernel/branches/4.0.0 wso2carbon

The list of commands that can be run are as follows. If you only want to build the API Manager, you have to always use the option "-Dproduct=apimgt".


mvn clean install -Dproduct=apimgt	To create the complete release artifacts of the product including the binary and source distributions.
mvn clean install -Dmaven.test.skip=true -Dproduct=apimgt	To create the complete release artifacts of the product including the binary and source distributions, without running any of the unit tests.
mvn clean install -Dmaven.test.skip=true -Dproduct=apimgt -o	To create the complete release artifacts of the product including the binary and source distributions, without running any of the unit tests, in offline mode. This can be done only if you've already built the source at least once.

Developer Access

Everyone can access the Subversion repository via HTTPS, but Committers must checkout via HTTPS. The Carbon framework related source code can be checked out using the following commands.

$ svn checkout https://svn.wso2.org/repos/wso2/carbon/kernel/branches/4.0.0 wso2carbon

The Carbon core project is the root project of the OSGi platform on which the Java product stack is built. The Carbon components contain all the components not just the API Manager specific ones. Therefore, you need to build just the set of components required by the API Manager, using the following command:

$ mvn clean install -Dproduct=apimgt

Execute the following command to commit your changes (SVN will prompt you for password).

$ svn commit --username your-username -m "A message"

Access through a Firewall

If you are behind a corporate firewall which is blocking http access to the Subversion repository, you can try the developer connection:

$ svn checkout https://svn.wso2.org/repos/wso2/trunk/carbon carbon

Access through a Proxy

The Subversion client can be configured to access through a proxy.

1) Specify the proxy to use in the "servers" configuration file in:

"~/.subversion" directory for Linux/Unix
"%APPDATA%\Subversion" hidden directory for Windows. (Try "echo %APPDATA%")

2) There are comments in the file explaining what to do. If you don't have this file, get the latest Subversion client and run any command. It will create the configuration directory and template files.

Example : Edit the 'servers' file and add something similar to:

[global]
http-proxy-host = your.proxy.name
http-proxy-port = 3128