Applications overview

Applications in ApiShare serve as the fundamental units for API consumption and provisioning. Each Application can act as:

• Consumer: An entity that subscribes to APIs to use their services.

• Provider: An entity that exposes APIs to be consumed by other applications.

Applications are associated with a Group within an Organization, allowing governance and role-based access control. Each application has two key stakeholders:

• Application Owner: Responsible for functional and business aspects of the application.

• Application Developer: Manages the technical implementation and maintenance of the application.

Applications are scoped to a specific Organization, so each user can only create them in the context of Organizations which he is a member of. Tenant Owners are the only ones exempt from this rule, thus they can create Applications everywhere.

Application lifecycle

The APP lifecycle is divided into macro-states, each containing one or more sub-states.

Here is a list:

• Concept: all applications are born in this state where all information is collected. Applications in this state are not yet visible in the APP Catalog.
  The default sub-states are:

  • Draft: this is the initial state when you first CREATE an application

  • Proposed: when all required fields have been filled and your APP is ready to be validated by a supervisor or a functional responsible, you can PROPOSE your APP

  • Rejected: An APP proposed that has been rejected for any reason.

• Published: When a proposed APP gets ACCEPTED it means that it is ready to begin exposing services and/or consuming services provided by others. Once they reach this state applications are visible in the APP Catalog.
  The default sub-states are:

  • Activating: a transitional state in which ApiShare performs synchronization operations.

  • Activation Error: something went wrong while ApiShare tried to perform synchronization operations with an API Gateway and/or automatic pipelines. You can check the error and then RETRY.

  • Active: Once it has reached this state the APP can expose and/or consume APIs.

  • Suspending: transitional state in which ApiShare performs synchronization operations.

  • Suspension Error: something went wrong while ApiShare tried to perform synchronization operation with an API Gateway and/or automatic pipelines. You can check the error and the RETRY.

  • Suspended: the APP is frozen. It is still available on the Gateway and its subscriptions required are active but any subscription to its exposed APIs is Suspended.

⚠ Note: Activating, Activation Error, Suspending and Suspension Error sub-states are expected and relevant only if ApiShare is integrated with an API Gateway and/or automatic deploy pipelines.

• Retired: when an application is dismissed, meaning that it will no longer expose or consume APIs, you can retire it. This state has no sub-states.
  When retiring an application:

  • all its exposed APIs will be automatically retired so they will no longer be usable

  • any subscriptions to the above-mentioned APIs will be revoked

  • any subscription of the retired application to APIs exposed by other providers gets revoked as well

Application Fields

The following table summarizes all the default fields of an Application, specifying how the value(s) are to be inserted and any checks performed on the value(s).