Skip to content

Products Overview

Introducing Products where users can discover & leverage the API & Event capabilities

The Product is a container which has APIs & Events, the consumers can discover and subscribe to the Products before they invoke it.

Pre-Requisite for a user to view Products

  • User must be part of a team and must be assigned any role. A member with any role can access the Products menu.
  • The discoverability of a Product varies depending on the combination of visibility of the Product and the team to which the user belongs to. For more details. see API visibility and team roles.

Products search capability

In Products, consumers can filter the Products using the Search capability.

  • Search can be performed by following criteria:
    • Full (or) Partial text of Product Name
    • Full (or) Partial text of Product Short Description
    • Full (or) Partial text of Product Long Description

Viewing a Product Summary:

  • From the listed Products in ‘Product List Page’, user can select their required Product using the search capability.
  • Selecting the Product will take user to the ‘Product Summary Page’
  • In the Products Summary Page, user will be able to do the following:
    • View selected Product Name & it’s description
    • Based on the selection of API/Event type & Versions
      • Summary tab will display the API & Event endpoints
      • Specification tab will display the API/Event specification of the respective version.
    • Able to subscribe to an Application

API Service Endpoints: Event Endpoints: API Specification: Event Specification:

Adding new subscriptions

  • From Product summary page, user will be able to subscribe to an Application
  • Clicking on Subscribe from Product summary page will take user to Subscribe to page
  • In the Subscribe to page, user can filter to the application using search capability & proceed with subscription.
  • If a user is subscribing to an open product, subscription should happen immediately
  • If the product is closed, it will be ‘In Review’ state until the Team Admin of that api review the request and approve or reject it

Removing existing subscriptions

  • The user will have permission to remove the existing subscription. API visibility and team roles
  • To remove the subscription follow the below steps,
    • Option 1:
      • Navigate to Subscriptions > Expand Product to which you want to unsubscribe your Product
      • Click on ‘Delete’ icon in Actions & Proceed with deletion
    • Option 2:
      • Navigate to Subscriptions > Expand Product to which you want to unsubscribe your Product
      • Click on ‘Edit’ icon in Actions
      • In Subscription summary page, click on ‘Unsubscribe’ & proceed with unsubscribing