API Management

Applications

Creating a new application

  1. Provide the following details:

    1. Application ID: Provide a unique name under which the application 

    2. Application name: Name to identify 

    3. Description: A short description of the application.

    4. Redirect URI: Endpoint where the server sends users after authentication

    5. API Product: Select a product from the drop-down.

    6. Rate plan: Select a rate plan associated with the product.

  2. Click Add.

    image2025-2-18_15-2-52.png
  3. The product will be added to the list. Click the Create button on the upper-right part of the screen to create the new application.

    image2025-2-18_15-5-44.png

The added application will be created with 'PENDING' status. The administrator needs to change the status to Active.

image2025-2-18_15-21-45.png

Activating the application

This needs to be carried out by the administrator.

  1. Go to Applications> Cient Subscriptions.

    The newly added app can be seen in the Subscriptions list under the server group where it was added.

    image2025-2-18_16-20-42.png
  2. Open the newly added application.

  3. Click the ACTIVE option under the Status section.

    image2025-2-18_16-28-20.png
  4. Click Save.

Check in the dev portal app to see the updated status.

image2025-2-18_16-36-28.png

Managing Consumer key

Copying Consumer key and secret

To copy the key and secret, perform the following actions on the Applications page:

  1. Click the Details icon under the Actions column (see the figure above).

  2. Click the Hide/Unhide icon against the consumer key/secret.

    image2025-2-18_18-35-57.png
  3. Click the Copy icon to copy the key/secret

    image2025-2-18_18-54-7.png

Unique consumer key and secret codes can be found when more than one product is added to the subscription. 

image2025-2-19_16-26-41.png


Regenerating Keys

To regenerate the keys, click the Regerate keys button.

image2025-2-18_18-38-47.png

Modifying application properties

Editing App name, description or redirect URI

  1. Click the Modify application button on the Details page.

    image2025-2-18_18-42-32.png
  2. Edit the properties and click Update.

    image2025-2-18_18-51-37.png

Changing the rate plan

Click the rate plan name and select the plan from the drop-down. Click Update to save the changes.

image2025-2-18_18-50-20.png

Removing the API product from the subscription

Click the Delete icon under the Actions column against the product that needs to be removed and click Update.

image2025-2-19_16-8-23.png

There has to be more than one product to delete a product from the list because at least one product needs to be added to the subscription, 

Filtering applications

When there are numerous products added to a subscription, use the following filters to search for the product:

  • Application Status

    • Active

    • Pending

    • Revoked

  • API products: Subscribed products

image2025-2-19_16-16-37.png

Clearing the filter

Click the Clear all filters button to clear filters; it will list all the applications added.

image2025-2-19_16-23-30.png