Install the API Gateway server

The API Gateway server is the main runtime environment consisting of an API Gateway instance and a Node Manager. For more details on API Gateway components and concepts, see the API Gateway Concepts Guide.

Note   It is not necessary to install the API Gateway server on the API Gateway appliance because this component is preinstalled on the appliance.

Prerequisites

Ensure that all of the prerequisites detailed in Prerequisites are met.

Axway license file

You must have a valid Axway license file to install the API Gateway server. Also, if you intend to run API Gateway in FIPS-compliant mode, ensure that your license file allows this. To obtain an evaluation trial license or a full license, contact your Axway Account Manager.

Note   If you are using Apache Cassandra, before starting API Gateway, you must first ensure that Cassandra is installed and running. For more details, see Install an Apache Cassandra database.

Install the API Gateway server

To install the API Gateway server in GUI mode, perform an installation following the steps described in Installation options, using the following selections:

  • Select the Custom setup type.
  • Select to install the API Gateway server component.

To install the API Gateway server in unattended mode, follow the steps described in Unattended installation.

The following example shows how to install the API Gateway server component in unattended mode:

./APIGateway_7.5.3_Install_linux-x86-32_BN<n>.run --mode unattended 
--setup_type advanced 
--enable-components apigateway 
--disable-components nodemanager,qstart,analytics,policystudio,
apitester,configurationstudio,apimgmt,cassandra,packagedeploytools 
--licenseFilePath mylicense.lic

Before you start API Gateway

Note   Before you can start the API Gateway, you must first use the managedomain script to create a new domain that includes an API Gateway instance. If you installed the QuickStart tutorial, a sample API Gateway domain is automatically configured in your installation. Otherwise, you must first create a new domain. For more details, see the API Gateway Administrator Guide.

If you installed the QuickStart tutorial, the QuickStart server and Admin Node Manager start automatically. Otherwise, you must start them manually.

If you installed Apache Cassandra, before starting API Gateway, you must first ensure that your Apache Cassandra server is running. For more details, see Install an Apache Cassandra database.

Start API Gateway

To start the API Gateway manually, follow these steps:

  1. Open a command prompt in the following directory:
Windows INSTALL_DIR\apigateway\Win32\bin
UNIX/Linux INSTALL_DIR/apigateway/posix/bin
  1. Run the startinstance command, for example:
startinstance -n "Server1" -g "Group1"
Note   On UNIX/Linux, you must ensure that the startinstance has execute permissions.
  1. To manage and monitor the API Gateway, you must ensure that the Admin Node Manager is running. Use the nodemanager command to start the Admin Node Manager from the same directory.
  2. To launch API Gateway Manager, enter the following address in your browser:
https://HOST:8090/
  1. HOST refers to the host name or IP address of the machine on which API Gateway is running (for example, https://localhost:8090/).
  2. Enter the administrator user name and password. This is the administrator user name and password you entered during installation.
Note   You can encrypt all sensitive API Gateway configuration data with an encryption passphrase. For example, you can specify this passphrase in your API Gateway configuration file, or on the command line when the API Gateway is starting up. For more details, see the API Gateway Administrator Guide.

Start as a service

You can also run API Gateway instances and Node Managers as services. For more information, see Set up services.

Related Links