...
Installing Fiorano API Management
Download Fiorano platform Platform using the .bin or .exe installer from http://www.fiorano.com/downloads/downloads.php which has an intuitive wizard to install the Fiorano setup as per scenario requirements.
| Tip |
|---|
Refer to the Installing Fiorano Platform documentation which lists the steps involved in for installing Fiorano Platform. |
| Note |
|---|
In this document, "$FIORANO_HOME" refers to the Fiorano Setup installation directory. |
...
For the servers to run, JAVA1.8 (or higher versions) needs to be installed.
| Info |
|---|
Download and install Java 1.8 from http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html. |
Installing Cassandra Database Server
Cassandra DB Server needs to be installed as Fiorano API Management uses Cassandra as the data store for all information that is looked up while a request is being processed such as the subscriptions, clients, and distributed quotas. Cassandra Database is an open source database that provides linear scalability and high availability with proven fault-tolerance in storing details that need to be looked up on-the-fly.
| Tipinfo |
|---|
Download Cassandra Version 3.x from the link https://academy.datastax.com/planet-cassandra/cassandra and please refer to the directions provided here at http://cassandra.apache.org/doc/latest/getting_started/index.html to install Cassandra. |
| Note | |||||
|---|---|---|---|---|---|
After
|
| Tip |
|---|
Fiorano API Management servers are preconfigured to use Cassandra Data Store URL and Keyspaces with default values as below:
These Advanced users may change these default values may be changed by the advanced users by following the steps mentioned in the Changing Cassandra Data Store URL and Keyspace values section. |
| Note |
|---|
To avoid a single point of failure of Cassandra servers, configure Cassandra as a cluster. |
| Anchor | ||||
|---|---|---|---|---|
|
The following steps will provide you with step by step instructions on how to go about using the product.
| Anchor | ||||
|---|---|---|---|---|
|
Please contact Fiorano Support at presales@fiorano.com for licenses. Once the licenses are received, copy them to the FIORANO_HOME/licenses directory.
| Anchor | ||||
|---|---|---|---|---|
|
...
| Anchor | ||||
|---|---|---|---|---|
|
AMS acts as the central repository to create and access API projects. It hosts the API dashboard and incorporates Analytics engine apart from Managing access control and performing aggregation functions for APIs. The API Dashboard is also hosted on this server.
...
To start the AMS server, please execute the following command at $FIORANO_HOME/esb/server/bin:
Linux
Code Block title Linux ./server.sh -mode ams -profile server1 –nobackground
Windows
Code Block server.bat -mode ams -profile server1
...
AGS acts as a proxy server for backend REST/SOAP-based web services. It receives client requests and performs activities such as authentication, traffic control and other features like Cachingcaching, load balancing, and quota management and more.
| Info |
|---|
There can be multiple Gateway servers running on a single network controlled by an API Management Server. |
Starting the API Gateway 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 server.bat -mode ags -profile server1
Fiorano provides a pre-configured second secondary 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 server.bat -mode ags -profile server2
When both the servers start, the Command Prompt prompt displays the content below as a confirmation of having successfully connected to the Cassandra database.:
================ API traffic dataStore Initialized ================
In case you do not get the above statement does not get displayed on the Server Console and find , but displays errors as below, please check whether the Cassandra DB is running.:
================ API traffic dataStore Initialization Failed ================
| Note |
|---|
|
...
Fiorano API Management provides API Management Dashboard as a client GUI to assist in configuring and maintaining the API servers and projects.
...
After logging in with the credentials, the API Management Dashboard should be gets displayed as in the following figure.
...
Figure 1: Fiorano API Management Dashboard
| Tip |
|---|
Analyzing Analyzing the API management data Fiorano provides an analytics tool to analyse the api to analyze the API traffic and other metrics. For storing this these analytical data, Fiorano uses Postgresql PostgreSQL as its datastore. Refer the Configuring Analytics Database section for configuring the same. Configuring Analytics notifications By configuring Mail Server in the Admin module of Fiorano APIManagement API Management Dashboard, Analytics notifications can be received via email. Refer the Mail Server section to see the properties that need to be updated. |