Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This portion of the API management platform focuses on the "Subscriptions" section of an API product. The interface manages the relationships between API plans and client applications, showcasing subscription details and status.

At the top right, there is a "Subscribe!" button, indicating the action to subscribe a new application to an API plan.

ApiProductDetailsSubscriptions-20240209-135510.pngImage Removed

Subscriptions Table

The main component on this page is the table listing various subscriptions to API plans. Here are the details that are provided for each subscription:

  • Plan Name: The tier or level of the API plan subscribed to, which dictates the access level and rate limits. In this instance, all subscriptions are to the "Gold" plan.

  • Application: The name of the client application that has subscribed to the plan.

  • Status: Indicates the deployment status of the subscription. It can show either "Deployed" for successful deployments or "Deploy Incomplete" for subscriptions that have not been fully deployed. Statuses are visually represented with color-coded indicators—green for "Deployed" and red for "Deploy Incomplete."

  • Approval Status: Displays the approval state of the subscription, which in this case, all are marked as "APPROVED."

    section will showcase the functionality and layout of the Subscription Management interface. The emphasis here is on monitoring and managing the subscription status of various applications to API Products.

    ApiProductDetailsSubscriptions-20240209-135510.pngImage Added

    Managing API Product Subscriptions

    In the central part of the interface, we find the "SUBSCRIPTIONS" panel. This panel is pivotal for administrators who oversee the access of different subscriptions to the API Products. It lists the plan names alongside the corresponding applications that have subscribed to them.

    Each row represents a unique subscription to the API Product.

    The "STATUS" column provides critical real-time information about the deployment status of each subscription. It indicates whether the API is currently deployed and active for a given application or if there is an issue that has resulted in a deployment being incomplete.

    Moreover, the "APPROVAL STATUS" column reflects the administrative consent for the subscription. In this view, all listed subscriptions have been 'APPROVED,' denoting that they have been authorized for use but may not be fully operational due to deployment issues.

    Table of contents

    Table of Contents
    minLevel1
    maxLevel6
    outlinefalse
    styledisc
    typelist
    printablefalse