Asset lifecycle
ApiShare assets follow a structured lifecycle that can be fully managed within the platform. This lifecycle is divided into macro-states, each with its own sub-states that provide further granularity to the asset's evolution.
In Progress: The initial development phase where assets are not yet visible in the API Catalog.
Draft: The starting point where users input the necessary details before deciding whether to propose the asset for evaluation.
Proposed: The asset awaits review from designated users for approval or rejection.
Rejected: If not approved, the asset can be revised and resubmitted or permanently deleted.
Active: The asset is fully developed and operational.
Unpublished: The asset is active but not yet listed in the API Catalog.
Published: The asset is visible and accessible within the API Catalog.
Deprecated: The asset is no longer recommended but remains functional until it is replaced or deleted.
Asset integration patterns
Assets in ApiShare integrate with various systems following predefined patterns.
These integration methods define how data flows and how communication is structured. Common integration patterns include REST for HTTP-based API communication, SOAP for structured messaging with built-in security features, SFTP for secure file transfers, JMS for asynchronous messaging, JDBC for direct database connectivity, HTTP for basic web communication, and Kafka for scalable, real-time streaming.
Asset fields
Assets have specific fields that define their properties and usage.
Field Label | Entry Mode | Field Checks | Notes |
|---|---|---|---|
Overview | |||
Name | Entered by the user as free text |
| The regex formula can be configured |
Description | Entered by the user as free text | The Description must be at least 10 characters long |
|
Organization | Single choice from list | The Organization must exist and be Internal | Entity must be previously created |
Group | Single choice from list | The Group must exist in the selected | Entity must be previously created |
Developer | Single choice from list | The User must be present within the | If not indicated, the user who performs the API creation/editing will be considered as the API Developer. |
Owner | Single choice from list | The User must be present within the | If not indicated, the user who performs the API creation/editing will be considered as the API Owner. |
Tags | Multiple choice from list | The Tag must exist | Entity must be previously created. |
Categories | Multiple choice from list | The Category must exist | Entity must be previously created. |
Technical Details | |||
Integration pattern | Single choice from list |
| When creating an Asset, users are prompted to input an integration pattern. They can choose from a list of available options or can be created through the Admin Functionalities. Once the pattern is assigned and the Asset is created, the pattern cannot be modified. |
+ Integration pattern parameters | NA | NA | Every integration pattern is defined by one or more configurable parameters, each of which has an entry mode and unique checks tailored to its specific use case. |
Enterprise Integration | |||
Provider | Single choice from list |
|
|
Consumed Products | Multiple Choice via a Dedicated Modal |
|
|
Consumed Assets | Multiple Choice via a Dedicated Modal |
|
|
Other | |||
Comment | Entered by the user as free text in action confirmation modal |
| Provide in confirmation modal |
Product lifecycle
Products follow a structured lifecycle, ensuring clear progress from concept to retirement. Each macro-state includes several sub-states that define specific steps in the process.
Concept: The initial phase where ideas are proposed, analyzed, and evaluated before they can proceed.
Draft: The product is in its initial design stage. High-level functionality is defined, but no development has started.
Proposed: The product undergoes evaluation to determine feasibility and alignment with business objectives.
Rejected: If the product does not meet the required criteria, it is rejected. It can either be modified and resubmitted or discarded permanently.
In Progress: The phase where the product is being actively developed and documented.
Draft: Development work begins based on the approved concept.
Pending for Validation: The product is finalized and submitted for quality assurance and internal review.
Validation Rejected: If the validation process identifies issues, the product is sent back for revisions before it can proceed.
Pending for Publishing: The product is fully developed and validated but not yet deployed.
Published: The product is made available for use, following a structured deployment process.
Non-Production: The product is deployed in a lower environment for further testing and refinement.
Pending for Go-Live: The product is considered stable and ready for production deployment.
Live: The product is fully operational and accessible for use.
Deprecated: The product remains available but is no longer actively maintained or recommended for new integrations.
Retired: The product is officially withdrawn and is no longer accessible. Active subscriptions are revoked, and any dependencies on the product must be migrated.
Product fields
Similar to assets, products are defined by specific attributes.
Data fields
Field Label | Entry Mode | Field Checks | Notes |
|---|---|---|---|
Original Asset | |||
Name | Search modal |
| Available only in the API full configuration. Available only when creating an API product from an existing asset. |
Integration Pattern | Single choice from list | Integration pattern needs to be of productizable type | Available only when creating a brand new API product. |
Overview | |||
Name | Entered by the user as free text |
| The regex formula can be influenced |
Version | Entered by the user as free text.
When creating a new version of an existing API Product, the user chooses from a list one of the values | The version provided must respect semantic versioning format (e.g. X.Y.Z) '0.0.0' is not a valid version.
| The default version is 1.0.0 |
Description | Entered by the user as free text | The Description must be at least 10 characters long |
|
Use case | Entered by the user as free text | The Use case must be at least 10 characters long, if present |
|
Organization | Single choice from list | The Organization must exist and be Internal | Entity must be previously created |
Group | Single choice from list | The Group must exist in the selected | Entity must be previously created |
Developer | Single choice from list | The User must be present within the | If not indicated, the user who performs the API creation/editing will be considered as the API Developer. |
Owner | Single choice from list | The User must be present within the | If not indicated, the user who performs the API creation/editing will be considered as the API Owner. |
Tags | Multiple choice from list | The Tag must exist | Entity must be previously created. |
Categories | Multiple choice from list | The Category must exist | Entity must be previously created. |
Lifecycle | |||
Publication date | Single choice via a calendar tool |
| The publication date is an informational field, which does not imply any automated procedure There are as many API Products publication dates as there are deployments environments. The publication date for an environment is always an optional field. However, at the Publish of the Product API in that given environment, it will always be valued by the system with the actual publication date. |
Deprecation date | Single choice via a calendar tool |
| The deprecation date is an informational field, which does not imply any automated procedure |
Retirement date | Single choice via a calendar tool |
| The retirement date is an informational field, which does not imply any automated procedure |
Technical Details | |||
Gateway OpenApi definition | NA | NA | The API definition related to the gateway is retrieved by integrating with the Gateway API itself. |
Gateway Providers | Multiple choice from list | Gateway provider must exist | Entity must be previously created. |
Back-end OpenApi definition | File upload or API definition creation wizard | Only OpenAPI version 3 standard allowed |
|
Gateway authentication type | Multiple choice from list | Authentication must exist | Entity must be previously created. |
External ID | Entered by the user as free text | NA |
|
Technical tags | Retrieved from the uploaded or created swagger (Backend API definition) | NA |
|
Data formats | Multiple choice from list | NA |
|
Messaging patterns | Multiple choice from list | NA |
|
Enterprise Integration | |||
Provided Asset | In API-Full configuration: In Product-Only configuration: | NA |
|
Provider | In API-Full configuration: In Product-Only configuration: | Provider application must exist and be in the status "Published, Active" |
|
Consumed Products | In API-Full configuration: In Product-Only configuration: | NA |
|
Consumed Assets | In API-Full configuration: In Product-Only configuration: | NA |
|
Links | |||
Developer portal endpoint | Entered by the user as free text | NA |
|
Links | Entered by the user as free text | NA |
|
Partner Visibility | |||
External organizations | Multiple choice from list | The Organization must exist and be External | Entity must be previously created |
Other | |||
Comment | Entered by the user as free text in action confirmation modal |
| Provide in confirmation modal |
The above specified fields requiredness and modifiability, based on the state of the API lifecycle, can be found in the API Fields-detailed section.
Deployment fields
Field Label | Entry Mode | Field Checks | Notes |
|---|---|---|---|
Gateway | |||
Provider | Single choice from list | The Gateway Provider must exist | Entity must be previously created.
|
Environment | Single choice from list | The Environment must exist | Entity must be previously created. Publication or republication in each of the configured environments is profilable by role. |
Public Server URL | Multiple choice from list | The Domain must exist | Values configurable during the Each domain is associated with one or more providers and one or more environments, and allows it to be associated with a default basepath. |
Private Server URL | Single choice from list | It must be a valid server URL | Retrieved from the API definition |
API fields - detailed
The following table presents, for each API default field, its detailed properties regarding its mandatory status, editing options, and visibility.
Field | API Lifecycle | Mandatory | Editable | Viewable |
|---|---|---|---|---|
Name | API Creation Modal | Yes | Yes | Yes |
Concept, Draft | Yes | Yes | Yes | |
Concept, Proposed | Yes | Yes | Yes | |
In Progress, Draft | Yes | No | Yes | |
In Progress, Pending for validation | Yes | No | Yes | |
In Progress, Validation rejected | Yes | No | Yes | |
In Progress, Pending for publishing | Yes | No | Yes | |
Published, Non production | Yes | No | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | No | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Description | API Creation Modal | Yes | Yes | Yes |
Concept, Draft | Yes | Yes | Yes | |
Concept, Proposed | Yes | Yes | Yes | |
In Progress, Draft | Yes | Yes | Yes | |
In Progress, Pending for validation | Yes | Yes | Yes | |
In Progress, Validation rejected | Yes | Yes | Yes | |
In Progress, Pending for publishing | Yes | Yes | Yes | |
Published, Non production | Yes | Yes | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | Yes | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Use case | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Organization | API Creation Modal | Yes | Yes | Yes |
Concept, Draft | Yes | Yes | Yes | |
Concept, Proposed | Yes | Yes | Yes | |
In Progress, Draft | Yes | Yes | Yes | |
In Progress, Pending for validation | Yes | Yes | Yes | |
In Progress, Validation rejected | Yes | Yes | Yes | |
In Progress, Pending for publishing | Yes | Yes | Yes | |
Published, Non production | Yes | Yes | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | Yes | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Group | API Creation Modal | Yes | Yes | Yes |
Concept, Draft | Yes | Yes | Yes | |
Concept, Proposed | Yes | Yes | Yes | |
In Progress, Draft | Yes | Yes | Yes | |
In Progress, Pending for validation | Yes | Yes | Yes | |
In Progress, Validation rejected | Yes | Yes | Yes | |
In Progress, Pending for publishing | Yes | Yes | Yes | |
Published, Non production | Yes | Yes | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | Yes | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Developer | API Creation Modal | Yes | Yes | Yes |
Concept, Draft | Yes | Yes | Yes | |
Concept, Proposed | Yes | Yes | Yes | |
In Progress, Draft | Yes | Yes | Yes | |
In Progress, Pending for validation | Yes | Yes | Yes | |
In Progress, Validation rejected | Yes | Yes | Yes | |
In Progress, Pending for publishing | Yes | Yes | Yes | |
Published, Non production | Yes | Yes | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | Yes | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Owner | API Creation Modal | Yes | Yes | Yes |
Concept, Draft | Yes | Yes | Yes | |
Concept, Proposed | Yes | Yes | Yes | |
In Progress, Draft | Yes | Yes | Yes | |
In Progress, Pending for validation | Yes | Yes | Yes | |
In Progress, Validation rejected | Yes | Yes | Yes | |
In Progress, Pending for publishing | Yes | Yes | Yes | |
Published, Non production | Yes | Yes | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | Yes | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Tags | API Creation Modal | No | Yes | Yes |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Categories | API Creation Modal | No | Yes | Yes |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Version | API Creation Modal | Yes | Yes | Yes |
Concept, Draft | Yes | Yes | Yes | |
Concept, Proposed | Yes | Yes | Yes | |
In Progress, Draft | Yes | No | Yes | |
In Progress, Pending for validation | Yes | No | Yes | |
In Progress, Validation rejected | Yes | No | Yes | |
In Progress, Pending for publishing | Yes | No | Yes | |
Published, Non production | Yes | No | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | No | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Publication date | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | Yes | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Deprecation date | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Retirement date | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Gateway openApi definition | API Creation Modal | No | No | No |
Concept, Draft | No | No | No | |
Concept, Proposed | No | No | No | |
In Progress, Draft | No | No | No | |
In Progress, Pending for validation | No | No | No | |
In Progress, Validation rejected | No | No | No | |
In Progress, Pending for publishing | No | No | No | |
Published, Non production | Yes | No | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | No | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Gateway Providers | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Backend API definition | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | Yes | Yes | Yes | |
In Progress, Pending for validation | Yes | Yes | Yes | |
In Progress, Validation rejected | Yes | Yes | Yes | |
In Progress, Pending for publishing | Yes | Yes | Yes | |
Published, Non production | Yes | No | Yes | |
Published, Pending for go-live | Yes | No | Yes | |
Published, Live | Yes | No | Yes | |
Published, Deprecated | Yes | No | Yes | |
| ||||
Gateway authentication type | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
External ID | API Creation Modal | No | Yes | Yes |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Technical tags | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Data formats | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Messaging patterns | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Provided Asset | Concept, Draft | API-Full configuration: | No | API-Full configuration: |
Concept, Proposed | API-Full configuration: | No | API-Full configuration: | |
In Progress, Draft | API-Full configuration: | No | API-Full configuration: | |
In Progress, Pending for validation | API-Full configuration: | No | API-Full configuration: | |
In Progress, Validation rejected | API-Full configuration: | No | API-Full configuration: | |
In Progress, Pending for publishing | API-Full configuration: | No | API-Full configuration: | |
Published, Non production | API-Full configuration: | No | API-Full configuration: | |
Published, Pending for go-live | API-Full configuration: | No | API-Full configuration: | |
Published, Live | API-Full configuration: | No | API-Full configuration: | |
Published, Deprecated | API-Full configuration: | No | API-Full configuration: | |
| ||||
Provider | API Creation Modal | No | API-Full configuration: | Yes
|
Concept, Draft | No | API-Full configuration: | Yes | |
Concept, Proposed | No | API-Full configuration: | Yes | |
In Progress, Draft | No | API-Full configuration: | Yes | |
In Progress, Pending for validation | No | API-Full configuration: | Yes | |
In Progress, Validation rejected | No | API-Full configuration: | Yes | |
In Progress, Pending for publishing | No | API-Full configuration: | Yes | |
Published, Non production | Yes | API-Full configuration: | Yes | |
Published, Pending for go-live | Yes | API-Full configuration: | Yes | |
Published, Live | Yes | API-Full configuration: | Yes | |
Published, Deprecated | Yes | API-Full configuration: | Yes | |
| ||||
Consumed Asset | API Creation Modal | No | API-Full configuration: | No |
Concept, Draft | No | API-Full configuration: | Yes | |
Concept, Proposed | No | API-Full configuration: | Yes | |
In Progress, Draft | No | API-Full configuration: | Yes | |
In Progress, Pending for validation | No | API-Full configuration: | Yes | |
In Progress, Validation rejected | No | API-Full configuration: | Yes | |
In Progress, Pending for publishing | No | API-Full configuration: | Yes | |
Published, Non production | No | API-Full configuration: | Yes | |
Published, Pending for go-live | No | API-Full configuration: | Yes | |
Published, Live | No | API-Full configuration: | Yes | |
Published, Deprecated | No | API-Full configuration: | Yes | |
| ||||
Consumed Products | API Creation Modal | No | API-Full configuration: | No |
Concept, Draft | No | API-Full configuration: | Yes | |
Concept, Proposed | No | API-Full configuration: | Yes | |
In Progress, Draft | No | API-Full configuration: | Yes | |
In Progress, Pending for validation | No | API-Full configuration: | Yes | |
In Progress, Validation rejected | No | API-Full configuration: | Yes | |
In Progress, Pending for publishing | No | API-Full configuration: | Yes | |
Published, Non production | No | API-Full configuration: | Yes | |
Published, Pending for go-live | No | API-Full configuration: | Yes | |
Published, Live | No | API-Full configuration: | Yes | |
Published, Deprecated | No | API-Full configuration: | Yes | |
| ||||
Developer portal endpoint | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Links | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | No | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | No | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
External organizations | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | No | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | No | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | No | No | Yes | |
| ||||
Comment | API Creation Modal | No | No | No |
Concept, Draft | No | Yes | Yes | |
Concept, Proposed | No | Yes | Yes | |
In Progress, Draft | No | Yes | Yes | |
In Progress, Pending for validation | No | Yes | Yes | |
In Progress, Validation rejected | Yes | Yes | Yes | |
In Progress, Pending for publishing | No | Yes | Yes | |
Published, Non production | No | Yes | Yes | |
Published, Pending for go-live | No | Yes | Yes | |
Published, Live | No | Yes | Yes | |
Published, Deprecated | Yes | Yes | Yes | |
| ||||
Product Publishing and Versioning
Publishing a product involves deploying it through different environments:
Development (DEV) → Testing (TEST) → Production (PROD).
Promotion to higher environments is dependent on successful deployment in the previous stage.
Versioning ensures proper evolution of products:
Major Versions introduce breaking changes and may require new assets. Different versions of the same Product can exist in the same deployment environment.
Minor Versions introduce backward-compatible updates. When a minor version of an Product reaches the Product version from which it originated, the oldest one is overridden.
Patch Versions focus on fixes without altering functionality. When a patch version of an Product reaches the Product version from which it originated, the oldest one is overridden.
Documentation & Visibility
Documentation Management
Each API product can be associated with documentation, serving as a guide for users. When a Product new version is created, documentation is inherited but remains independent. Users can organize content into structured sections, including usage examples and best practices.
Product Visibility
Visibility settings control access to API products, ensuring they are available only to designated users. By default, visibility settings are inherited but can be customized per version or deployment stage. Additional refinements can be applied at the organizational level, ensuring APIs remain accessible only to the intended stakeholders.
For detailed procedures, refer to the relevant ApiShare user guides.