Versions Compared

Key

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

Overview

You can subscribe to as many API products with different plans as you like with one application.

image-20240312-142402.pngImage Removed

Subscriptions of the Application

The "Subscriptions" page is a segment of the application management interface within an API management platform, specifically for the application named "#5 Car Finder." This page focuses on managing subscriptions to API products.

Subscription Management Area

  • Subscription Actions: At the top, there are buttons for batch actions like "Unsubscribe" and "Deploy," which allow for managing subscriptions in bulk.

  • Subscription Creation: The "Create New Subscription" button is prominently placed in the upper right corner, indicating that users can initiate new API product subscriptions from this interface.

Subscriptions List

This central area displays the list of API product subscriptions for the application. Each subscription entry provides:

  • API Product: The name of the API product to which the application is subscribed.

  • Status: Indicates the current state of the subscription; in this instance, there is a "Deploy Incomplete" status, suggesting that the deployment process for this API product is not finalized.

  • Plan: The specific plan associated with the API product subscription, which may define the level of access or the rate limits that apply to the application.

Subscription Options

Adjacent to each subscription entry are options:

  • Change Plan: This button suggests the capability to switch the application's subscription to a different plan offered by the API product.

  • Show Secrets: Likely reveals sensitive information such as API keys or tokens that are required for the application to access the subscribed API

    apiida31.pngImage Added

    Overview

    The API management interface in view presents a structured and user-centric platform aimed at facilitating the comprehensive management of API subscriptions. As one navigates the interface, the central theme revolves around the ease of subscribing to and managing APIs which are categorized within API products. Each API product is a collection of individual APIs, encapsulated to offer a suite of services.

    Managing API Subscriptions

    Within the 'Subscriptions' section, users are greeted with a streamlined view that lays out API products along with relevant details. For instance, an API Product can be listed with its current deployment status displayed as 'Deploy Incomplete', signaling that the setup of this API product is not yet finalized. Adjacent to the status, one finds the plan associated with the API product, in this case, 'Petstore AWS', again affirming the product's nature and intended utility.

    This section of the interface allows users to perform critical actions like subscribing and unsubscribing to API products with just a few clicks. The interface is designed to encourage user action, highlighted by the presence of buttons such as 'Unsubscribe' and 'Deploy', positioned prominently at the top of the table. This design choice underscores the interface's commitment to a seamless user experience by offering straightforward access to essential functionalities.

    Moreover, the option to 'Create New Subscription' is made readily available and is accentuated by its placement and the use of contrasting color, inviting users to expand their API utilization by exploring additional API products available within the platform.

    Create New Subscription

    To do this, click on the 'Create New Subscription' button at the top right. You will then be guided through a dialogue which will help you to create a subscription step by step.

    image-20240312-142948.pngImage Removed

    apiida32.pngImage Added

    Show Secrets

    You can display the secrets for each subscription.

    image-20240312-142905.pngImage Removed

    apiida33.pngImage Added

    Change Plan

    You can also change the subscription plan at a later date.

    image-20240312-142619.pngImage Removed

    apiida34.pngImage Added

    Terms of Use

    You can see who, when and which terms of use have been confirmed

    apiida35.pngImage Added

    image-20240312-160503.pngImage Removedimage-20240312-160524.pngImage Removed

    apiida36.pngImage Added

    Table of contents

    Table of Contents
    minLevel1
    maxLevel6
    outlinefalse
    styledisc
    typelist
    printablefalse