Anchor
_Toc396220939 _Toc396220939

Overview

This is a getting started Guide for the API Management product which provides a platform to build web proxies on top of existing web services to secure them as well as to analyze the footfall to the backend servers.

Anchor
_Toc396220940 _Toc396220940

Prerequisites

Perform the following before setting up the Product.

1. Install the product with the .bin or .exe installer of the product; run the installer which gives you an intuitive wizard to install the Fiorano setup as per your needs.

   Note
   Further in this document, "$FIORANO_HOME" refers to the Fiorano Setup installation directory.

2. The main prerequisite for the product, apart from JAVA 1.7.0_55 and ANT 1.9.2, are the installation of a Cassandra Database Server and PostGre SQL server.

   1. Cassandra Database is an open source database that provides unmatched linear scalability and high availability with proven fault tolerance and is used to store details that needs to be looked up on the fly.

      Note
      Please refer http://planetcassandra.org/cassandra/?action=true for directions to install Cassandra. For now the assumption is that both Management Server and Gateway are in same machine with Cassandra installed in it.

   2. Fiorano uses PostGre SQL for its analytics data store. To configure PostGre SQL for analytics, perform the following actions:
      1. Install PostGre on the machine where you want your Analytics Database to be.
      2. Create your desired username, set the desired password and create the database that you want Fiorano to use for the purpose.
      3. Download the PostGre JDBC driver for your JVM and keep it ready for the later steps.
      4. Once Fiorano is installed, some changes need to be done in the Fiorano setup for the Analytics to connect to the PostGre SQL. To do this, open the apidb.cfg file present at $FIORANO_HOME/esb/server/profiles/server1/AMS/conf and make the following changes in the document:
         
         1. Under section 2, change the <ip-address>, <port> and <database> variables to the actual desired settings of the above installed PostGre setup.
         2. Under section 3 and section 4 of this document, provide the username and password credentials needed to connect to the installed database.
         3. Under section 6 and 7, provide the reconnect settings of your choice.
         4. Go to $FIORANO_HOME/esb/server/bin/server.conf and under the <java.classpath> segment, add the path to the above downloaded JDBC driver, so that the driver gets added to the classpath of the JVM.

Now you are ready for the set up. You may continue with the steps mentioned in the next section.

Anchor
_Toc396220941 _Toc396220941

Setting up

The following steps will provide you with step by step instructions on how to go about using the product.

Anchor
_Toc396220942 _Toc396220942

Adding product licenses

The Fiorano API installers work with the same license as used by the main Fiorano Platform.

Anchor
_Toc396220943 _Toc396220943

Starting API servers

Fiorano API Management product provides you with two server setups:

• API Management Server (AMS)
• API Gateway Server (AGS)

Anchor
_Toc396220944 _Toc396220944

API Management Server (AMS)

This is the control centre of the API Management product. It is the place from where all the main deployment of your API projects and policies will be controlled.
To start the AMS server, please execute the following command at $FIORANO_HOME/esb/server/bin

• Linux

  Code Block
  $ ./server.sh -mode ams -profile server1 –nobackground

• Windows

  Code Block
  # sever.bat -mode ams -profile server1

Anchor
_Toc396220945 _Toc396220945

API Gateway Server (AGS)

This is the server on which the projects get deployed. This server will be the place to which the clients will connect before their traffic is stored for analysis and request is redirected to the backend API. There can be multiple Gateway Servers running on a single network controlled by an API Management Server.

To start the AGS server, execute the following command at $FIORANO_HOME/esb/server/bin:

• Linux

  Code Block
  $ ./server.sh -mode ags -profile server1 –nobackground

• Windows

  Code Block
  # sever.bat -mode ags -profile server1

Fiorano also provides you with a pre-configured second Gateway Server Profile which can also be started by executing the following command at $FIORANO_HOME/esb/server/bin:

• Linux

  Code Block
  $ ./server.sh -mode ags -profile server2 –nobackground

• Windows

  Code Block
  # sever.bat -mode ags -profile server2

Both the servers should start without any issues, and should display the below content, on console, as a confirmation of having successfully connected to Cassandra database:

================Connected===========================

In case you do not get the above statement on the Server Console and find errors of the following type: "API traffic dataStore Initialization Failed", please check whether the Cassandra DB is running.

Anchor
_Toc396220946 _Toc396220946

Launching the API Dashboard

Fiorano API Management uses a new API Management Dashboard as a client GUI to assist in configuring and maintaining the API servers and projects.

The dashboard is hosted at the following address after the starting of the AMS server:

http://<ip-address-of-installation-machine>:1981

After logging in with the User name and Password credentials, the Dashboard Home page looks as in the following figure.

Figure 1: Fiorano API Management Dashboard Home page