Fiorano REST API

Fiorano provides REST APIs to help manage and monitor the Fiorano API Management product externally using user-defined clients performing pre-defined API calls. Fiorano REST APIs are documented using Swagger UI.

How to access?

To access the Swagger UI from a remote machine, make the following changes before starting the server from the Profile Management perspective.

Go to FES Profile > Fiorano > Esb > Jetty > Jetty and replace "localhost" with the IP address of the system in the SwaggerBasePath parameter.

 
Figure 1: Profile configuration to access REST APIs using swagger from a remote machine.

To access the Swagger JSON file for REST APIs of the Enterprise Server, use the following URL format:

Testing the REST APIs using Swagger UI

Fiorano's REST APIs can be tested directly through Swagger UI on the installed service provider:

1. To access the Swagger UI, make sure that the enterprise server is running and visit the following URL to access the Swagger UI page:

   Swagger UI URL

   Icon

   http://<IP Address>:1980/swaggerui

   Icon

   While accessing from a different machine, provide the IP Address in the JSON URL present in the Explore text field of the Swagger UI.
   
   
   Figure 2: Swagger UI Explore text field to change the machine IP address

2. Generate an API Key to execute any call on the Swagger UI:

   1. In the Swagger UI, go to the Security tab for the server whose calls need to be tested and select the /security/apikey row. The row expands and shows an execution panel.
      
      

      
      Figure 3: Swagger UI where testing can be executed
      
      

   2. Click Try it out and provide username and password for the server.

      Provide ESB as context for the Enterprise Server.

      
      Figure 4: JSON Input to generate API Key
      
      

   3. Click Execute, the response will return the API key.

Similarly, all the REST calls can be tested using this pre-generated API Key and the parameters mentioned in the self-explanatory execution panels of each call.

REST API Calls

The following calls are available through REST APIs :

Servers

These APIs help in managing the servers of the Fiorano platform. Using these APIs, servers can be restarted/stopped and details such as system details, memory details, patches, logs etc can be fetched.

Figure 5: List of Server APIs

Applications

These APIs help in managing the applications (event processes) running on the Fiorano platform. Using these APIs, applications can be imported/exported/started/stopped, and application details such as logs, remote instances, memory usage, breakpoints info etc. can be fetched. 

Figure 6: List of Applications APIs

Events

These APIs help in managing the Events raised and configuration to raise certain events on the Fiorano Platform. Using these APIs, we can configure event alerts, analyse them and delete events that are not needed anymore.

Figure 7: List of Events APIs

Microservice

These APIs help with import and export of microservices into the enterprise server.

Figure 8: List of Microservice APIs

Policies

These APIs help in managing the policies and also get alerts when the category specified by these policies are met. These APIs help configuring Low Memory (server and component), backlog monitoring and disk space monitoring policies for both enterprise and peer servers.

Figure 9: List of Ploicies APIs

Document Tracking

These APIs help in managing the document tracking module of the Fiorano Platform. Using these APIs, documents that are tracked can be analysed, searched for data, re-injected to the flow, and those not needed anymore can be deleted as well.

Figure 10: List of Document Tracking APIs