Introduction

Applications in the Platform are software entities that expose or consume digital products. Consumer applications access API Products through subscriptions, allowing controlled access to APIs. Each application belongs to an organization and a group, ensuring proper governance and visibility control. Applications have configurable attributes such as ownership, development roles, environments, and domains, and progress through a lifecycle from creation to retirement (see Applications catalog in the Core concepts section).

Applications are managed in Workspace > Apps and can be browsed by all users in the App Catalog.

Browsing the App Catalog

Steps:

1. Open the App Catalog from the main menu.

2. Search by name, owner, APIs produced, APIs consumed or category, and use Sort by to order the results.

3. Switch between Cards view and Table view.

4. Click an application to open its details.

Post-Conditions:

• The application details show its organization, group, owner, the APIs it consumes and its status.

Managing applications

Creating an application

Prerequisites:

• The user must be a member of an Organization and Group in the Platform.

Steps:

1. Click New App in the Quick actions menu, or Add in Workspace > Apps.

2. In the Overview section, fill in the details:

   • Name (Required) – The unique identifier for the application.

   • Description (Required) – A short summary that enhances discoverability in the App Catalog.

   • Organization & Group (Required) – Defines ownership and access. The group can be selected once the organization is chosen.

   • Owner & Developer (Optional) – Assign responsibility within the group. These fields appear once the group is selected.

   • Categories & Tags (Optional) – Enhance classification and searchability.

3. In the Technical details section, optionally enter the External ID, for tracking the application in external systems.

4. Click CREATE.

Post-Conditions:

• The application is created in Concept > Draft and listed in Workspace > Apps.

Tips:

• The Description field supports keywords, making the application more easily searchable.

• Only Tenant Owners, Org Admins, and certain custom roles can select a group from a pool of groups. Other users can only choose the group they belong to.

• If no Owner or Developer is selected, the creator is automatically assigned these roles.

• Categories and Tags help in organizing applications and should be chosen carefully to improve discoverability.

• External ID can be useful if the application exists in another system and needs to be referenced.

• An application can also be created directly from the subscription request, with the Create new app link.

Proposing an application

Steps:

1. Locate the draft application in Workspace > Apps.

2. Open its details and click PROPOSE.

3. Confirm the action and optionally leave a comment.

Post-Conditions:

• The application moves to Concept > Proposed, pending approval.

Tips:

• Users with appropriate permissions can skip the proposing step and directly activate the application.

Activating an application

Direct Activation:

• Users with appropriate permissions can skip the Proposed stage and activate the application immediately.

On-Demand Activation: Steps:

1. Locate the proposed application in Workspace > Apps.

2. Click ACTIVATE to approve or REJECT if necessary.

3. Confirm the action.

Post-Conditions:

• If integrated with an API Gateway, the application enters Activating.

• If successful, it moves to Published > Active.

• If an error occurs, it moves to Published > Activation Error.

Tips:

• Activation errors may indicate synchronization issues with an API Gateway or automated pipeline.

• Applications that fail activation remain in Activation Error state until resolved.

Suspending an application

Prerequisites:

• The application must be in an Active state.

Steps:

1. Locate the application in Workspace > Apps.

2. Click SUSPEND.

3. Confirm the action.

Post-Conditions:

• The application moves to Published > Suspended.

• If an integration error occurs, it moves to Published > Suspension Error.

Tips:

• Suspended applications retain their visibility in the catalog but cannot interact with APIs.

• If an application is suspended in an API Gateway, manual intervention may be required to restore access.

Retiring an application

Prerequisites:

• The application must be in Published state.

Steps:

1. Locate the application in Workspace > Apps.

2. Click RETIRE.

3. Confirm the action.

Post-Conditions:

• The application moves to Retired > Retired and disappears from the catalog.

• If an integration error occurs, it moves to Published > Retiring Error.

Tips:

• Once retired, an application cannot be reactivated.

• Retiring an application ensures that no further API interactions occur.

Managing application environments & domains

Adding a domain

Steps:

1. Open the application details.

2. Scroll to Technical details > Environments, where each environment has its own tab. You can filter production and non-production environments.

3. Select the target environment and click Add Domain.

4. Fill in the required details:

   • Protocols (Multiple options supported).

   • Domain Name.

   • Code (Optional identifier).

   • Description (Optional).

5. Click ADD, then SAVE.

Post-Conditions:

• The domain is associated with the selected environment.

Tips:

• Each environment can have multiple domains.

• Domains must be unique within the same environment.

• The order and the names of the environments displayed are configured by the administrator, and may differ for each type of organization.

Managing application use cases

The Use cases tab of the application lists its use cases on the left; selecting a use case shows, on the right, its details and the APIs linked to it.

Creating a new use case

Steps:

1. Open the application and navigate to Use cases.

2. Click Add use case.

3. Fill in:

   • Title (Required).

   • Description (Required).

   • Tags (Optional), chosen among the tags of the application.

4. Click SAVE.

Post-Conditions:

• The use case is created and linked to the application.

Tips:

• Each application has a default use case created automatically. It is used for a subscription when no other use case is selected.

• Use cases must be linked to API subscriptions.

• New use cases can be created retroactively, also from the subscription request.

Editing or deleting a use case

Steps:

1. Open the application and navigate to Use cases.

2. On the row of the use case, click Edit use case to change its title, description or tags, then click SAVE; or click Delete use case and confirm.

Post-Conditions:

• The use case is updated or removed.

Tips:

• The default use case can be edited but not deleted.

Moving an API to another use case

Steps:

1. Open the application and navigate to Use cases.

2. Select the use case that contains the API.

3. Drag the API onto another use case in the list on the left.

Post-Conditions:

• The API is linked to the new use case.

Tips:

• An API can also be removed from a use case from the detail of the use case.

Deleting an application

Prerequisites:

• The application must be in Retired state before deletion.

Steps:

1. Locate the application in Workspace > Apps.

2. Click Delete (Trash Icon).

3. Confirm the action.

Post-Conditions:

• The application is permanently removed from the Platform.

Tips:

• Applications in Published state must be Retired first before deletion.

• Deleting an application removes all associated use cases and domain configurations