Applications

Overview

When you invoke a protected API from Developer Portal, you need to create an application requesting access to the API from the provider. Through the application, you can request access tokens from the provider by revealing a corresponding authentication such as username and password, OAuth, or JWT details.

During runtime, the provider recognizes the consumer’s identity through the application. The details passed from Developer Portal to the provider enables them to:

You can create, view, and share applications from the Manage applications section.

Developer Portal sends the application requests from consumers to providers using the callback URL of providers. Configuring an incorrect callback URL can lead to communication issues between the provider and Developer Portal.

If an application onboarding strategy is configured, then the applications that you create will be processed based on the configured strategy. For information on configuring an application onboarding strategy, see How do I configure onboarding strategy to process application or subscription requests?

If you do not configure an onboarding strategy, then the registration requests are automatically approved.

You can view the status of requested applications from the Manage applications section. Once an application is approved, you can share the application with other users or user groups to alllow them use the application and invoke the corresponding APIs. When an application is shared, only the application owner can view the analytics and other cannot.

From the Trace application section of an application, you can view the stages that the application has passed through and their corresponding timestamp. These stages include application creation request,

You can trace the status and stages of an application using the Trace application section of an application. This section displays the various stages including application creation request, application request submit, application publish, application scope increase or decrease, and so on with the corresponding time stamp.

How do I configure onboarding strategy to process application or subscription requests?

This use case starts when you want to configure onboarding process to approve or reject the application or subscription registration requests.

Before you begin:

Ensure that you have:

To configure onboarding strategy to process application or subscription requests

  1. Click the menu options icon from the title bar and click Administration.

  2. Select Onboarding.

  3. From the Application/subscription onboarding section, enable any or all of the required strategies:

  4. Use the arrow keys next to these strategies to change their order. The strategies are followed by the order they appear.

  5. Click Save.

    The onboarding strategy to process application or subscription requests configuration is saved.

Next steps:

Creating an application

You must create applications to invoke protected APIs.

You can create applications for an API from one of the following:

You can create more than one application for an API.

How do I create an application from Manage applications screen?

This use case starts when you want to create an application and ends when you have created one.

In this example, consider creating an application app1 to access the API, Petstore that is published by the provider, Provider1.

Before you begin:

Ensure you have the API Administrator or the API Provider privilege.

To create an application from the Manage applications screen

  1. Click the menu options icon from the title bar and click Manage applications.

    The list of applications appear.

  2. Click Create application.

  3. Select Provider1 from the Stage list.

  4. Select Petstore from the Select API field.

  5. Provide app1 in the Name field.

  6. Select the required callback URL of the provider.

  7. Click Save.

    The application is created.

Next steps:

How do I create an application from API details screen?

This use case starts when you want to create an application and ends when you have created one.

To create an application from the API details screen:

  1. From the API gallery page, click the view icon next to the API for which you want to create an application.

  2. In the API details page, click the request application icon .

    Note: The request application icon appears only for the protected APIs.

  3. In the Request application screen, click Request.

    If there is an existing application for the selected API, then the following screen appears:

    You can select an existing one or create a new one. The application stage and API name appear in the corresponding fields on the Create application page. If you select to use an existing application, the scope of the application increases and you can invoke the API using an existing application.

  4. Provide the application name and description.

  5. Click Save.

    The application is created.

Next steps:

How do I create an application from Try API screen?

This use case starts when you want to create an application and ends when you have created one.

To create an application from the Try API screen

  1. From the API gallery page, click the Try API icon next to the API for which you want to create an application.

  2. In the Try API page, click Create new application.

    The application stage and API name appear in the corresponding fields on the Create application page.

  3. Provide the application name and description.

  4. Click Save.

    The application is created.

Next steps: