Running the API Manager Runtime

Follow the steps given below to run the WSO2 API Manager runtime and access its web portals: Management Console, API Publisher, and the Developer Portal.

Before you begin

Download and install the API Manager server.

Starting the API-M server

Follow the steps given below to start the server.

  1. Open a command prompt as explained below.

    On Linux/Mac OS Establish an SSH connection to the server, log on to the text Linux console, or open a terminal window.
    On Windows Click Start >Run, type cmd at the prompt, and then press Enter.

  2. Navigate to the <API-M_HOME>/bin folder from your command line.

  3. Execute one of the commands given below.

    • To start the server:

      sh api-manager.sh
      api-manager.bat --run
    • To start the server in background mode:

      sh api-manager.sh start
      api-manager.bat --start

When the server starts successfully, the following log is printed: "WSO2 Carbon started in 'n' seconds"

Accessing the Web Portals

When you start the API-M runtime, all of its web portals are started. You will see the URLs of each portal printed in the server-startup log as shown below.

API-M server startup log

Note that the server is running on localhost by default. You can use these URLs to access the web portals on your computer from any other computer connected to the LAN. When accessing the portals from the same computer where it is installed, you can use localhost instead of the IP address.

Info

To change the default hostname/port and to secure the API-M portals, see the following topics:

To sign in to each web portal:

  1. Copy the web portal's URL to your browser.

    Tip

    The web browser typically displays an "insecure connection" message, which requires your confirmation before you can continue.

  2. Enter your username and password to sign in.

    Tip

    The default username and password is admin.

Stopping the API-M server

  • To stop the API-M server standalone application, go to the terminal and press Ctrl+C.
  • To stop the API-M server in background mode:

    sh api-manager.sh stop
    api-manager.bat --stop

Tip

For additional options, you can use with the startup commands, add -help after the start-up command as shown below.

sh api-manager.sh -help

Troubleshooting server startup errors

  • If you are in a Windows environment, the HTTPS listener would have started on a host address of 0:0:0:0:0:0:0:0. You can verify that from the Carbon logs. In that case, you need to define 0:0:0:0:0:0:0:0 as the bind-address in <API-M_HOME>\repository\resources\security\listenerprofiles.xml to avoid errors during SSL reloads. In order to make the change to listenerprofiles.xml, you will need to modify <API-M_HOME>\repository\resources\conf\templates\repository\resources\security\listenerprofiles.xml.j2.
  • If you are on a Mac OS, you may encounter the following startup error with similar logs.

    [2021-04-16 08:48:27,655] ERROR - InboundEndpoint Error initializing inbound endpoint SecureWebhookServer
    [2021-04-16 08:48:27,655] ERROR - InboundEndpointDeployer Inbound Endpoint deployment from the file : /Users/sanjeewa/Downloads/wso2am-4.0.0/repository/deployment/server/synapse-configs/default/inbound-endpoints/SecureWebhookServer.xml : Failed.
    org.apache.synapse.SynapseException: Error initializing inbound endpoint SecureWebhookServer at org.apache.synapse.inbound.InboundEndpoint.init(InboundEndpoint.java:83) ~[synapse-core_2.1.7.wso2v227.jar:2.1.7-wso2v227]

    This may occur due to a native launchd service com.apple.ftp-proxy.plist living at /System/Library/LaunchDaemons/com.apple.ftp-proxy.plist that fires /usr/libexec/ftp-proxy. To fix this issue, change the default port that the webhooks HTTPS inbound endpoint is listening in all the Gateway nodes in <API-M_HOME>/repository/deployment/server/synapse-configs/default/inbound-endpoints/SecureWebhookServer.xml. Change 8021 to a different port.

    <p:parameter  name="inbound.http.port">8021</p:parameter>

    For the Control Plane nodes (with the Publisher), change the deployment.toml file as follows:

    [[apim.gateway.environment]]
    ######## other properties ########
    websub_event_receiver_https_endpoint = "https://localhost:8021"

See Also

Top