Introduction

Applications in ApiShare are software entities that interact with 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 progress through a structured lifecycle, from creation to retirement, with configurable attributes such as ownership, development roles, environments, and domains.

Managing applications

Creating an application

Prerequisites:

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

Steps:

1. Navigate to Workspace > My Apps.

2. Click the New APP button.

3. Fill in the required details:

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

   • Description – A short summary that enhances discoverability in the APP Catalog.

   • Organization & Group (Required) – Defines ownership and access.

   • Owner & Developer (Optional) – Assign responsibility within the group.

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

   • External ID (Optional) – For tracking applications in external systems.

4. Click CREATE.

Post-Conditions:

• The application appears under Workspace > My Apps > Concept > Draft.

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.

Proposing an application

Steps:

1. Locate the draft application in Workspace > My 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 > My 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 > My 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 > My 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 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.

Managing application use cases

Creating a new use case

Steps:

1. Open the application and navigate to Use Cases.

2. Click Add New Use Case.

3. Fill in:

   • Title (Required).

   • Description (Required).

   • Tags (Optional).

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.

• Use cases must be linked to API subscriptions.

• New use cases can be created retroactively.

Deleting an application

Prerequisites:

• The application must be in Retired state before deletion.

Steps:

1. Locate the application in Workspace > My Apps.

2. Click Delete (Trash Icon).

3. Confirm the action.

Post-Conditions:

• The application is permanently removed from ApiShare.

Tips:

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

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