Managing applications

When you call a protected API from webMethods Developer Portal, you need to create an application to request access to the API from the provider. Through the application, you can request access tokens from the provider. To get the token, you must provide a corresponding authentication such as username and password, OAuth, or JWT details.

At run time, the provider recognizes the consumer's identity through the application. The details passed to the provider enable them to perform the following actions.
  • Control access to an API at run time (allow only authorized applications to start an API.
  • Monitor an API for violations of a Service-Level Agreement (SLA) for a specified application.
  • Indicate the application to which a logged transaction event belongs.
You can create, view, and share applications from the Manage applications section.
Note: Creating of applications and testing is not supported for Async APIs.

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

If an application onboarding strategy is configured, then the applications that you create are processed based on the configured strategy. For information on configuring an application onboarding strategy, see Configuring application or subscription onboarding strategy.

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. When an application is approved, you can share the application with other users or user groups to allow them to use the application and start the corresponding APIs.

Consumers can share their applications and subscriptions to other consumers based on the consumer visibility settings. That is, consumers can share their applications and subscriptions only with the users or user groups that are visible to them.

When the shared applications exist in Developer Portal versions before 11.0, and when you migrate that data to the 11.0 installation, then the shared applications (owned by a consumer) are accessible to any of its shared users (consumers) by default. This behaviour is because the default consumer visibility is set as None. If your requirement is to allow visibility of consumers within a community or to allow visibility to all consumers then you can select the Only to the consumers who belong to their communities option or the All consumers option. For information about the steps to configure or modify the consumer visibility settings, see Configuring consumer visibility.

Consumers can share their applications and subscriptions to other consumers based on the consumer visibility settings. That is, consumers can share their applications and subscriptions only with the users or user groups that are visible to them.

When the shared applications exist in the Developer Portal versions before 11.0, and when you migrate that data to the 11.0 instance, then the shared applications (owned by a consumer) are not accessible to any of its shared users (consumers) by default. This behaviour is because the default consumer visibility is set as None. If your requirement is to allow visibility of consumers within a community or to allow visibility to all consumers then you can select the Only to the consumers who belong to their communities option or the All consumers option. For information about the steps to configure or modify the consumer visibility settings, see Configuring consumer visibility.

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. The Trace application section displays the various stages that include application creation request, application request submit, application publish, application scope increase or decrease, and other states with the corresponding timestamp.