Fiorano API Management is quick to install and easy to use. The steps below illustrate how to install Fiorano API Management product as well as to launch the Fiorano API Dashboard:
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Installing Fiorano API Management
Download Fiorano 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 for installing Fiorano Platform. |
...
Anchor | ||||
---|---|---|---|---|
|
Installing Java
Setting up Java
Download and Install JDK
For the servers to run, JAVA1.8 (or higher versions) Java Development Kit needs to be installedconfigured.
...
Download and install
...
from any of the following download links which include Oracle Java and some open JDK builds:
Tip |
---|
...
Set Java Home
Provide the JDK installation path for the JAVA_HOME property in the fiorano_vars.sh/bat file present at the Forano installation directory.
Info | ||
---|---|---|
| ||
SET JAVA_HOME=C:\Fiorano\12.2.0\jre1.8.0_231_64 |
Installing and Running 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.
...
Installing Cassandra
- Download Cassandra Version 3.x from the
...
- link http://
...
...
...
...
- download/
- Install Cassandra by referring to the directions provided
...
...
- Make the changes mentioned in the subsections below as applicable or/and move to the Running the Cassandra server section.
Cassandra in a Windows environment
Before starting Cassandra in Windows environment as a service,
...
perform the following actions to enable the database:
- Go to <CASSANDRA_HOME>/conf.
- Open the cassandra.yaml file.
- Find the cdc_raw_directory
...
- parameter.
Un-comment the property and rename the value as below:
Code Block <CASSANDRA_HOME>/data/cdc_raw
...
Info title Example cdc_raw_directory: "C:/Program Files/DataStax-DDC/data/cdc_raw"
...
Enabling Connection to a Remote Cassandra Server
If Cassandra Server is running on a different system, the two steps below need to be performed:
Step 1: Enabling Remote Access to Cassandra Server
Since Cassandra server will be hosted in the local system alone by default, cassandra cannot be accessed from any other systems. To enable remote access, perform the following actions:
- Go to the location <CASSANDRA_HOME>/conf.
- Open the cassandra.yaml file.
- Replace the value of the following parameters with the IP address of the system where Cassandra DB would be running:
- rpc_address
- listen_address
Step 2: Configuring AGS and AMS Profiles
Fiorano API Management server profiles are preconfigured to run Cassandra in the local system with default values of Cassandra Data Store URL and Keyspaces
...
as below:
- DatastoreURL: localhost/9042
- KeyspaceName: API
...
If the Cassandra Server has to be run in a different system and thereby enable access to this remote Cassandra, replace "localhost" with the IP address of that system.
Tip |
---|
IP Address has to be changed in eStudio Profile Management. Refer to the Changing Cassandra Data Store URL and Keyspace values section to configure these. |
Note |
Cassandra as a Cluster
Warning |
---|
To avoid a single point of failure of Cassandra servers, configure Cassandra as a cluster. |
Running the Cassandra server
Open Command prompt from bin folder at CASSANDRA_HOME and run the following command:
Linux:
Code Block cassandra -R -f
Windows:
Code Block cassandra -f
Note If Cassandra is installed as a service, start the server from Windows Services.
Tip In the Windows Component Services panel, Cassandra server will be displayed as "DataStax DDC Server <VersionNumber>".
Anchor | ||||
---|---|---|---|---|
|
...
Linux
Code Block title Linux ./server.sh -mode ams -profile server1 –nobackground-nobackground
Windows
Code Block server.bat -mode ams -profile server1
...
Linux
Code Block ./server.sh -mode ags -profile server1 –nobackground-nobackground
Windows
Code Block server.bat -mode ags -profile server1
...
Linux
Code Block ./server.sh -mode ags -profile server2 –nobackground-nobackground
Windows
Code Block server.bat -mode ags -profile server2
...
Fiorano API Management provides API Management Dashboard as a client GUI to assist in configuring and maintaining API servers and projects.
The dashboard is hosted at the following address after starting the AMS serverAfter starting the servers, use the URL below to login to the Dashboard:
Code Block |
---|
http://<ip-address-of-installation-machine>:1981localhost:1981/apimgmt/login |
Note | ||
---|---|---|
To access from a different system, replace "localhost" with the IP address of the system.
|
Figure 1: Fiorano API Management Login page
After logging in with the credentials, the API Management Dashboard Home page gets displayed as in the following figure.
Info |
---|
Default username and password are 'admin' and 'passwd' respectively). |
Figure 1: Fiorano API Management Dashboard
...
Figure 2: Fiorano API Management Dashboard
The Home page displays an overall graphical picture about the entire data in the Fiorano API Management such as the number of Deployed/Undeployed Projects, projects which are Active/Deprecated/Retired, projects deployed on different environments, and an overview about users, products, projects, and operations.
The sections present in the API Management Menu bar are the ones that drive Fiorano API Management:
Click the above links to understand each section clearly or click Quick Start to try hands-on with the product right away.
API Analytics
Tip |
---|
Analyzing the API management data Fiorano provides an analytics tool to analyze the API to analyze API traffic and other metrics. For storing these analytical data, Fiorano uses PostgreSQL as its datastore. Refer to the Configuring Analytics Database section section for configuring the same. Configuring Analytics notifications By configuring Mail Server in the Admin module of Fiorano API Management Dashboard, Analytics notifications can be received via email. Refer to the Mail Server section to see the properties that need to be updated. |