...
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 the Swagger interface.
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 AMS Profile > Fiorano REST APIs are documented using Swagger. > APIManager > APIJetty > APIManagerJetty 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
| Note |
|---|
In case of HA servers, the configuration needs to be updated for the Backup AMS server as well. |
To access the 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:
| Info | ||
|---|---|---|
| ||
http://<IP Address>:<1981>/api/ams/swagger.json |
| Note |
|---|
Before attempting to access the Swagger, ensure that the API Management Server is running. |
Testing the REST APIs using Swagger UI
...
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 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.
Figure 12: Swagger UI Explore text field to change the machine IP addressGenerate an API Key to execute any call on the Swagger UI:
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 23: Swagger UI testing screenClick Try it out and provide username and password for the server.
Info icon false Provide API as context for the API Management Server.
Figure 34: JSON Input to generate API KeyClick Execute, the response will return the API key.
...
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.
Figure 45: List of API Analytics APIs
...
API Policy refers to the various actions that can be performed when an API call reaches the server. These APIs can manage actions that needs to be performed on receipt of a new backend API call being managed by the product.
Figure 56: List of API Policy APIs
...
These APIs help in managing the API Projects. Using these APIs, projects can be imported/exported/deployed/undeployed and details regarding the project like deployment status, environment, policies used, jetty access URL etc. can be fetched.
Figure 67: List of API Projects APIs
...
These APIs help in managing API Products, Developers and Subscriptions. Users can add/remove/change products, developers or subscriptions, and get information like developer's email ID, product details, developer details, subscription details, etc.
Figure 78: List of API Product APIs
...
These APIs help in controlling trace modules of the product. Using these APIs, tracing can be started/stopped and get configuration of the module for a particular project in an environment.
Figure 89: List of API Trace APIs
Servers
These APIs help in managing the servers of the API Management product, using these APIs, servers can be restarted/stopped and details such as system details, memory details, patches, logs etc can be fetched.
Figure 910: List of Servers APIs