Configure API Manager

This topic describes how to run API Manager on the appliance. These instructions are valid for all form factors of the API Gateway Appliance, including the physical appliance, the virtual appliance, and the AMI virtual appliance.

Prerequisites

The API Manager software is installed as part of the appliance API Gateway software installation. To run API Manager on the appliance, the following prerequisites apply:

  • You must have a valid Axway API Manager license file.
  • A nodemanager and an API Gateway instance must be running on the appliance.
  • The external firewall must allow access to the API Manager service port (8075 by default).
  • Apache Cassandra must be configured. For more information, see Configure Cassandra HA on the appliance.

Installation instructions

Follow these steps to install API Manager on an appliance image:

  1. Install the license. See Install the API Manager license.
  2. Configure the firewall. See Configure the appliance firewall.
  3. Enable the postfix service. See Enable the postfix service.
  4. Run the setup script. See Run the API Manager setup script.
Note   These instructions assume that a Node Manager and API Gateway instance are already installed and running on the appliance. In the following sections, the API Gateway instance is named Instance1 and the group name is APIManagerGroup. The process is run by the administrator user (non-root).

Install the API Manager license

Copy a valid license for API Manager into the /INSTALL_DIR/apigateway/conf/licenses directory.

Configure the appliance firewall

You must add a new firewall rule to allow access to the API Manager service port (the default port is 8075). The most convenient way to configure the appliance firewall is to use the Web Administration Interface. See Configure the Linux firewall for an example of opening a new port in the appliance firewall.

The following figure shows the result of adding a new rule for port 8075.

Open port 8075 in appliance firewall

Alternatively, to configure the firewall on the command line, log in to the appliance as root, and run these commands:

# sed -i.bak '/REJECT/i-A INPUT -p tcp -m state -m tcp --dport 8075 --state NEW -j ACCEPT' /etc/sysconfig/iptables 
# service iptables restart
Note   On an AMI virtual appliance, you must also open the API Manager port in the AWS security group. See Allow access to ports on AMI.

On all appliances in the topology where distributed caching is configured, it is recommended that you add the following two ports to the iptables. On the command line, log in to the appliance as root, and run these commands:

sed -i.bak '/REJECT/i-A INPUT -p tcp -m state -m tcp --dport 40001 --state NEW -j ACCEPT' /etc/sysconfig/iptables
sed -i.bak '/REJECT/i-A INPUT -p tcp -m state -m tcp --dport 40002 --state NEW -j ACCEPT' /etc/sysconfig/iptables

After you add the ports, restart IPTABLES: service iptables restart and then restart the API Gateway Appliance instances.

Enable the postfix service

To enable the postfix service in the Web Administration Interface, perform the following steps:

  1. Select Bootup and Shutdown in the WAI menu.
  2. Select the check box next to postfix, and click Start Now and On Boot.

Alternatively, to enable postfix on the command line, log in to the appliance as root, and run these commands:

# chkconfig postfix on
# service postfix start

Run the API Manager setup script

A script is installed with the API Manager installation files, which must be run to set up API Manager. This script must be executed by the same user responsible for the API Gateway process. In most appliance installations, this is the administrator user.

Note   These instructions assume that the administrator user is running an API Gateway named Instance1 on APIManagerGroup.

Log in to the appliance as the administrator user and run the following commands:

$ cd /INSTALL_DIR/apigateway/posix/bin
$ ./setup-apimanager -n "Instance1" -g "APIManagerGroup"

Test the installation

To test the API Manager installation, open a browser window and enter the URL https://HOST:8075 in the address bar. The API Manager web interface login page appears.

Further information

For more information on using API Manager, see the API Manager User Guide.

Related Links