...

Fiorano REST APIs are documented using Swagger. To access the swagger Swagger JSON file for REST APIs of the API Management Server, please make sure that the API Management Server is running and use the following URL format:

Image Removed

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 API Management server is running and visit the following URL to access the Swagger UI page:

   Info
   title Swgger Swagger UI URL
   http://<IP Address>:1981/swaggerui

   Note
   While accessing from a different machine, provide the IP Address in the JSON URL present in the Explore text field of the Swagger UI. Image Added Figure 1: 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 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 2: Swagger UI testing screen
      
      

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

      Info
      icon false
      Provide API as context for the API Management Server.

      
      Figure 3: 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

API Analytics

These APIs help in managing the analytics of the API server. Using these APIs, the analytics data can be fetched, data that may not be needed can be deleted, reports and notifications can be created/removed/fetched etc.

...