Contents

Popular
Contents

Products are a bundle of APIs available for developers while creating applications.

In the Header, click the Products link to open the Products page.

Site Administrator Account

Products will be shown based on ServerGroups.


 

Developer Account

  • 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 organization will be shown.

Icon

Products will be shown based on the access level set in Product Settings .

APIs

Multiple APIs would have been added to a product in the API Management Dashboard. We can access these APIs in the Developer Portal in the Products page.


When a product is selected, a list of APIs present in the product can be seen. Each API will be shown in a row that contains a link to the API Documentation and also option to download the client SDK in a required language.

API Documentation

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.

This section comprises of the same fields as present in the Overview section in the Fiorano API Management dashboard.

Documentation can be viewed in either Swagger or OpenAPI UI.

Prerequisite

Before starting the testing, Cross-Origin Resource Sharing (CORS) needs to 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

Icon

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

Product Settings

Site administrator can configure the visibility of products across the developer portal based on the access type of products.

Icon

Refer to the Product Access Level settings section for Product Settings.

Adaptavist ThemeBuilder EngineAtlassian Confluence