Products Module provides ways for developers to search for different API products (bundles) based on product details such as description and tag. The developer can check different APIs bundled as part of the product and add them to the application created. Click the Products prompt in the Home Page to navigate to this module.
Figure 1: Products Module
Product Details
To view the Product details along with the projects under the product, click the Product ID name present in the Products module (refer to the figure above).
This section gives out the Product details which are comprised of:
- ID
- Name
- Subscription Status
- Description
ID and name are the attributes attached to the product as they are in the API Management tool. The subscription status indicates whether or not the product has been subscribed.
APIs
Multiple APIs would have been added to a product in the API Management tool. In the Developer Portal, the APIs are available in the Product Details page.
Figure 2: Products Details with the list of API Projects present under the product
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 Documentation section.
To see the documentation, click the Project ID name present in the APIs section under the Product Details page (see the figure above). This section comprises of the same fields as present in the Overview section within Fiorano API Management.
Figure 3: Documentation section with the GET method parameters and the option for testing
The figure above shows the Query and Header parameters for the GET method. For the PUT, POST and DELETE methods, additional parameters such as the Form Params and the URL Encoded Params may also appear (as added in the API Management Overview section) as shown in the figure below.
Figure 4: The Documentation section showing the POST method customer parameters
Testing
The testing module (click the Try button as shown in the figure above) present under the Documentation section allows the developer to test the API with different sample requests and parameters to understand different invocation options and availability.