Installation

This section provides the outline how to install AMPLIFY API Management solution.

Install API Management modules

Because some of the API Management modules depend on other modules, you must install the modules in the following order:

  1. Install API Gateway.
  2. Install API Manager.
  3. Install API Portal.

You can install API Gateway and API Manager together in one installation dialog.

Tip   API Gateway installer comes with a Quickstart demo that walks you through the key components and example operations.

API Portal has its own installer. After installing API Portal, you must link it to API Manager.

For more details on installing and configuring the modules API Gateway and API Manager for either a single-node or a multi-node high-availability (HA) deployment, see the API Gateway Installation Guide.

For more details on installing API Portal, see the API Portal Installation and Upgrade Guide.

Install API Builder modules

The modules you need for API Builder depend on how your deployment is hosted.

Prerequisites

Before you start installing API Builder components, you must add the IP address of the machine running API Builder to the DNS or to hosts file on any other machine accessing AMPLIFY API Management. For example:

10.142.59.203 appc02.axway.int

In addition, after you have installed API Builder, you must add the domain API Builder is running in to the list of allowed domains in API Builder.

Install a deployment hosted in Axway Appcelerator cloud

If your deployment is hosted in Appcelerator cloud, do the following:

  1. Install Node.js.
  2. Install API Builder CLI.
  3. Configure API Runtime Services.

For more details on installing and configuring API Builder, see API Builder Getting Started Guide.

Install a deployment hosted in a virtual private cloud (VPC) or an on-premise cloud

If your deployment is hosted in a virtual private cloud (VPC) or an on-premise cloud, install the following:

  1. Install Node.js.
  2. Install Appcelerator Private VMWare OVA file for Arrow Cloud installation on a private cloud using its OS-specific installer file.

For more details on installing and configuring API Runtime Services Self-install documentation.

Secure the connection between API Manager and API Builder

It is recommended that you secure the connection from API Manager to API Builder, so that only API Manager can invoke API Builder APIs. This prevents a client application by-passing API Manager and invoking an API Builder API directly, resulting in the client application accessing the API Builder API without the security and governance controls API Manager enforces.

For more details, see Configure a connector for Axway API Runtime Services in the API Manager User Guide

Install Embedded Analytics for API Management modules

For Embedded Analytics for API Management, do the following:

  1. Install Decision Insight.
  2. Download the Embedded Analytics for API Management package and import it into Decision Insight.

For more details on installing and configuring Decision Insight, see the Decision Insight documentation.

For more details on configuring Embedded Analytics for API Management, see Embedded Analytics for AMPLIFY API Management documentation.

Deploy Mobile Backend Services

For Axway Mobile Backend Services (MBS), do the following:

  1. Deploy MBS to a Docker container. For more details, see API Runtime Services Self-install documentation.
  2. Create a datasource for MBS. For more details, see Mobile Backend Services Getting Started.

Related Links