This documentation is for WSO2 API Manager 2.5.0. View documentation for the latest release.

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Formatted


The instructions below show you how to use the WSS support capabilities in WSO2 API Manager.

  1. Update WSO2 API Manager using WUM (WSO2 Update Manager).

  2. Start API Manager.
  3. Create a WebSocket API using the following endpoint.

  4. Download and unzip the to a directory to your local drive. 
    This location will be referred to as WS_CLIENT_HOME. This is a Maven project of a simple WebSocket client.
  5. Open this source code in <WS_CLIENT_HOME> from your preferred Java IDE. Find the class.
  6. In addition, to the changes mentioned in steps 13 and 14 given above, change the variable carbonKeyStoreLocation to point to <API-M_HOME>/repository/resources/security/wso2carbon.jks. Note that the port for the WSS API is 8099.
  7. Run the WSS client.
    You will see it connecting via the WSS API to the backend.