API Products

Products are a bundle of APIs available for developers while creating applications. Click API Products from the menu to open the API Products page where products will be shown based on ServerGroup to which the developer has registered and logged in. 

• If the developer is not part of any organization, then Products available in the server group the developer has registered will be shown.
• If the developer is part of an organization, Products assigned to the organization will be shown.

APIs

One or more APIs would have been added to a product in the API Management Dashboard. We can access these APIs by clicking the Explore icon next to the product name (see the figure above).

When a product is selected, a list of APIs present in the product can be seen.

Click an API to list all the endpoints in the API. 

Click the SDK Ooption on the upper-right part of the screen to download the client SDK in the required language.

Detailed documentation of the API with complete information about the parameters involved, sample requests and responses, and authentication mechanisms used can be viewed in the API Documentation section.

Prerequisite

Before starting the testing, Cross-Origin Resource Sharing (CORS) must be enabled in the API Manager profile.

1. Stop the API Management Server.
2. Open Profile Manager perspective in eStudio and launch the APIManager profile.
3. Navigate to Fiorano > APIManager > APIProject > Controller > APIProjectController.
4. Enable the following properties under the ComponentInstanceConfiguration section:
   1. EnableCors: To enable cors globally for all API projects.
   2. HandlePreFlightRequest: To handle preflight requests globally for all API projects.
5. Restart API Management and API Gateway Servers.

Testing the app

1. Click the Try it out button on the upper-right and provide parameters for the required API as below.
   
   

   

   
   
   
2. After providing parameters, click the Execute button.
   
   

   

   

Hiding IP Address from the the Request URL in Swagger

If the IP address should not be shown in the Request URL in Swagger, specify the domain name in the Gateway Server profile.

To provide the domain name, perform the following actions:

1. Stop the API Gateway Server.
2. Open Profile Manager perspective in eStudio and launch the APIGateway profile.
3. Navigate to Fiorano > APIGateway > Esb > Peer > Configuration > FPSCommonConfigLoader.
4. Provide the domain name in the MappedPublicAddress section.
5. Start the API Management Server.

Option to specify the domain name for which the IP address should not be displayed

The administrator can configure the visibility of products across the developer portal based on the access level of products.