Introduction
Introduction
This page explains how to find, create and manage digital products in the Platform: API Products, MCP servers, AI Agents and the custom digital product types defined by the administrator, together with the API Assets that support API Products.
Consumers mostly use the Active Catalog, to find digital products and start using them.
Producers mostly use the Workspace, where the Digital Products and Assets sections list the items they manage.
The concepts behind digital products and their lifecycles are described in Digital products: from producers to consumers, in the Core concepts section.
Assets, MCP servers, AI Agents and custom digital product types are available if enabled for your installation. What each user can see and do depends on the roles, visibility and profiling configured by the administrator.
Finding digital products in the Active Catalog
Steps:
Open the Active Catalog from the main menu.
Choose the Digital Products tab or the Assets tab.
Filter by type (All, API, MCP, AI Agent or another type), search by text and use Sort by to order the results.
Switch between Cards view and Table view; in the table view, use Manage Columns to choose the columns to display. Frequently used filters can be kept as Saved filters.
Click a digital product to open its detail page.
Post-Conditions:
The detail page of an API Product shows its identity card, documentation, releases, the Try It console and its history, and offers the Subscribe button.
The detail page of other digital products shows their identity card, specifications, attachments, documentation and history; for MCP servers and AI Agents, the Try It tab allows trying them directly from the Platform (see Using MCP servers, AI Agents and custom digital products from the Active Catalog below).
Tips:
Users who are not members of an organization, such as guests and visitors, may see a simplified API catalog instead of the Active Catalog, according to the configuration of the installation.
Creating a digital product
Prerequisites:
Requires Administrator, Contributor, or equivalent custom role permissions.
The user must belong to an organization within which the digital product will be created.
Steps:
Click New Digital Product in the Quick actions menu, or Add in Workspace > Digital Products.
In the Digital Product Type step, answer What type of digital product do you want to create? by choosing one of the cards:
API REST: expose business functionality through secure REST endpoints;
MCP: expose tools, prompts and resources to LLMs through the standard protocol;
AI Agent: communicate and collaborate with other AI agents through the A2A protocol;
Other product type: choose one of the custom types configured for your installation.
Continue according to the type you have chosen:
for an API REST, see Creating an API product below;
for an MCP server, an AI Agent or a custom type, see Creating an MCP server, an AI Agent or a custom digital product below.
Post-Conditions:
The creation page of the chosen type opens.
Tips:
The types marked as highlighted by the administrator are shown as cards; the others are listed under Other product type.
Managing MCP servers, AI Agents and custom digital products
Besides API Products, the Platform can manage other kinds of digital products:
MCP servers: servers based on the Model Context Protocol (MCP), which expose tools, resources and prompts that LLM-based applications and agents can use.
AI Agents: agents that communicate and collaborate with other AI agents through the Agent2Agent (A2A) protocol. Each agent is described by an agent card that explains what it does, how to contact it and which skills it offers.
Custom digital products: the other types defined by the administrator for your installation.
Each of these digital products is created from a template, which defines the properties to fill in and the technical files (specifications) the product carries. Templates are defined and versioned by the administrator, and the template chosen when creating a digital product cannot be changed afterwards.
Producers create and maintain these digital products in Workspace > Digital Products: data, specifications, attachments, documentation, visibility and lifecycle.
Consumers find them in the Active Catalog, read their properties and specifications and, for MCP servers and AI Agents, try them directly from the Platform.
MCP servers, AI Agents and custom digital product types are available if enabled for your installation. The fields and specifications mentioned below for MCP servers and AI Agents are those of the default templates: the templates of your installation may define different ones.
Lifecycle of MCP servers, AI Agents and custom digital products
These digital products follow a simpler lifecycle than API Products, without deployment environments. The lifecycle is a governance tool: each organization can use it as much as it needs.
State | How it is reached | What can be done |
|---|---|---|
Concept, Draft | When the digital product is created | Edit the data, upload and remove specifications and attachments, Submit |
In Progress, Pending for publishing | Submit | Publish. Data, specifications and attachments are read-only |
Published, Live | Publish | The digital product is available in the Active Catalog according to its visibility. Retire |
Retired | Retire | The digital product is no longer offered; it stays visible only where its visibility includes the Retired state |
The actions shown in each state depend on the permissions of your role, which the administrator configures for each state (see the Organizations and Users chapter of the Administrator Manual). Delete is available in the states in which your role allows it.
Creating an MCP server, an AI Agent or a custom digital product
Prerequisites:
Requires Administrator, Contributor, or equivalent custom role permissions.
The user must belong to an organization within which the digital product will be created.
At least one template must be available for the chosen type.
Steps:
Click New Digital Product in the Quick actions menu, or Add in Workspace > Digital Products, and choose MCP, AI Agent or a type listed under Other product type. The New page opens.
In the Template section, select the Template that defines the configuration of the digital product. Each option shows its version and, where applicable, whether it is the default or a highlighted template.
Once a template is selected, a card lists the fields it defines (by default titled Custom Fields): click Show fields to see the fields you will be able to fill in after creation, with their description.
In the Overview section, enter the details:
Name: name of the digital product (from 2 to 255 characters, not starting with a space).
Description: a brief summary of the purpose of the digital product, useful for searchability (from 2 to 10,000 characters, not starting with a space).
Organization: one of the organizations you belong to.
Group: the group that will own the digital product. It can be selected once the organization is chosen.
Owner and Developer (optional): the business and technical references, searched among the users of the selected group. These fields appear once the group is selected; if left empty, they are filled in with your user.
Tags (optional): help users find the digital product in the catalog and can be used as filters.
Click Create. The button is enabled once all the required fields are filled in.
Post-Conditions:
The digital product is created in the Concept, Draft state and its detail page opens on the Data tab.
The creation is recorded in the History tab.
Tips:
The fields defined by the template and the specifications can be filled in only after the digital product has been created. If you change template before creating it, the fields shown change accordingly.
A digital product with the same name, template and group cannot be created twice.
If you leave the page before creating the digital product, a confirmation window warns you that the data entered will be lost. While the creation is in progress, the page cannot be left.
Detail page of a digital product
The detail page, opened from Workspace > Digital Products, shows the name of the digital product with its type, version and lifecycle state, and is organized in the following tabs:
Tab | Content |
|---|---|
Data | Lifecycle indicator, Overview section with the common fields and the section with the properties defined by the template (by default Custom Fields) |
Specification | The technical files that describe the digital product, as defined by the template |
Try it | For MCP servers and AI Agents only: the console to try the server or the agent |
Documentation | The documentation pages of the digital product |
Attachments | Additional files of any type |
Visibility | Who can see the digital product and its documentation in the catalog |
History | The timeline of the lifecycle changes and comments |
The Documentation and History tabs are shown if enabled for your type of user in the profiling configured by the administrator. The Try it tab is shown only when the template of the MCP server or AI Agent defines the specification that describes the server or the agent.
Editing the data of a digital product
The Data tab collects the information of the digital product in two sections:
Overview: Name, Version, Template, Description, Organization, Group, Owner, Developer and Tags. Version and Template are always read-only.
The properties defined by the template, possibly grouped in sub-tabs. With the default templates, for example:
for an MCP server, the configuration of the tools, prompts and resources it exposes and its security settings (security schemes, remote and package distribution options);
for an AI Agent, its skills (name, description, examples, input and output modes), the supported interfaces (for example JSON-RPC) and its security schemes.
Prerequisites:
The digital product must be in the Concept, Draft state.
The user must have permissions to save the digital product.
Steps:
Navigate to Workspace > Digital Products, filter by type and open the digital product.
In the Data tab, edit the fields of the Overview section.
Fill in or edit the properties defined by the template. Required fields are highlighted; a counter on the header of each section shows how many fields are missing or invalid, including those in sub-tabs that are not currently displayed.
Click Save, or Reset to discard the unsaved changes.
If the template links some properties to a specification already uploaded, the window These changes can also update the specification appears: click Save to confirm.
Post-Conditions:
The digital product is updated while maintaining its state.
Where the template links the properties to a specification, the changed values are also copied into the uploaded specification file. If this is not possible, the data is saved anyway and the message Saved, specification not updated is shown.
Tips:
In any state other than Concept, Draft, the data is read-only.
If you leave the page with unsaved changes, a confirmation window asks whether to discard them.
Managing the specifications of a digital product
The Specification tab (Technical file specification) shows one card for each technical file defined by the template, with its name and description. Required files are marked with an asterisk. With the default templates:
an MCP server carries its server configuration, with the information needed to integrate the server into an application or agent (for example its URL and the headers it expects), and its server card, which describes the server and the tools, resources and prompts it exposes;
an AI Agent carries its agent card, the standard A2A file that describes what the agent does, how to contact it and which skills it offers.
Prerequisites:
To upload, replace or remove a file, the digital product must be in the Concept, Draft state and the user must have the corresponding permissions.
Steps:
Open the digital product and go to the Specification tab.
On the card of the specification, drag the file onto the upload area or click Browse files. The accepted formats are shown under Supported files (usually .json).
If the template links the file to the data of the digital product, the window This specification can update the product data appears: click Upload to confirm, or Cancel.
Post-Conditions:
The file is checked against the schema defined in the template. If it does not match, the upload is rejected and the error lists the properties that are missing or incorrect.
If the template links the file to the data, the corresponding values are copied into the Data tab, replacing those already saved.
Tips:
Once a file is uploaded, you can preview its content, download it, replace it with a new file or remove it (after confirmation).
For MCP servers and AI Agents, upload the specifications before trying the digital product: the Try it tab reads from them the address of the server or of the agent.
Managing the attachments of a digital product
Prerequisites:
To upload or delete attachments, the digital product must be in the Concept, Draft state and the user must have the corresponding permissions.
Steps:
Open the digital product and go to the Attachments tab.
Click Upload file.
Drag the files onto the upload area or click Browse files: you can select up to 10 files at a time, of any type, up to 10 MB each.
Click Upload. The progress of each file is shown.
Post-Conditions:
The uploaded files are listed in the Attachments tab. If a file cannot be uploaded, its error stays visible in the window, while the other files are uploaded normally.
Tips:
Use the search bar to find an attachment by name. Each attachment can be downloaded or deleted (after confirmation).
Writing the documentation of a digital product
Steps:
Open the digital product and go to the Documentation tab.
Click Add page and enter the page title and its content in Markdown.
Save the page. Use Page actions to manage the existing pages and Previous / Next to move between them.
Post-Conditions:
The documentation is shown in the Documentation tab of the digital product in the Active Catalog, according to the visibility of the documentation.
Tips:
The documentation editor works as described in Documentation management.
Trying an MCP server
The Try it tab lets producers and consumers explore an MCP server and call its tools, resources and prompts directly from the Platform, without writing code. It is available in the Workspace and in the Active Catalog.
Prerequisites:
The template of the MCP server must define the server configuration or the server card, and at least one of them should be uploaded in the Specification tab.
The MCP server must be reachable from your browser.
Steps:
Open the MCP server and go to the Try it tab.
If the server card lists tools, resources or prompts, the Server card view shows them as declared, without contacting the server.
The Platform connects automatically to the server address declared in the specifications. If the configuration declares headers without a value, the Connection settings window opens: fill in the missing values and click Connect.
To change the connection, click Connection settings and set:
Server URL: the address of the remote MCP server (Streamable HTTP);
Authentication: My session token (the requests are signed with your own access token to the Platform), No auth, Basic auth (username and password), Bearer token or OAuth 2.0 (access token);
Custom headers: additional headers, added with Add header.
When the server is Connected, the Live view lists what the server exposes in the Tools, Resources and Prompts tabs, each with the number of items. Use the search bar to search all three lists at once.
Expand an item, fill in its arguments (the form is built from the input schema of the tool; click Input schema to see it as declared by the server) and click Run for a tool, Read for a resource or Get for a prompt.
Read the response in the Result section.
Click Disconnect when you have finished.
Post-Conditions:
The calls are executed on the real MCP server; the digital product is not changed.
Tips:
Running a tool executes it for real: keep in mind the effects it may have on the systems behind the server.
If the server refuses your session token, use Retry without authentication; if it requires credentials that the configuration does not declare, use Add credentials.
If no server specification has been uploaded yet, the tab shows MCP server configuration missing: use Go to Specifications to upload it, or connect to a server by entering its URL in Connection settings.
Trying an AI Agent
The Try it tab lets producers and consumers read the agent card of an AI Agent and talk to the agent directly from the Platform. It is available in the Workspace and in the Active Catalog.
Prerequisites:
The template of the AI Agent must define the agent card, and the agent card should be uploaded in the Specification tab.
The agent must expose a JSON-RPC interface reachable from your browser.
Steps:
Open the AI Agent and go to the Try it tab.
In the Agent card view, read what the agent declares: name, version and address, its Skills with their description, Examples and Input / output modes, and whether it supports Streaming.
Click an example to send it to the agent, or open the Chat view and write a message.
Read the answer of the agent in the conversation. While the agent is working, you can stop the answer.
Click New session to start a new conversation from scratch.
To change the address or the credentials, click Connection settings: the options are the same as for MCP servers.
Post-Conditions:
The messages are sent to the real agent; the digital product is not changed.
Tips:
If the agent card declares no interface that can be called from the Platform, the tab shows No reachable interface.
If the agent refuses the credentials, the Connection settings window opens so that you can change them.
If the agent card has not been uploaded yet, the tab shows Agent card missing: use Go to Specifications to upload it, or enter the address of the agent in Connection settings.
The chat supports text messages only.
Submitting a digital product for publishing
Prerequisites:
The digital product must be in the Concept, Draft state.
The user must have permissions to submit the digital product.
Steps:
Navigate to Workspace > Digital Products, filter by type and open the digital product.
Check that the required properties and specifications are complete.
Click Submit.
In the Confirm action window, which shows the digital product with its version and the action type, optionally add a comment and click Confirm.
Post-Conditions:
The digital product moves to In Progress, Pending for publishing: from now on its data, specifications and attachments are read-only.
The change is recorded in the History tab.
Publishing a digital product
Prerequisites:
The digital product must be in the In Progress, Pending for publishing state.
The user must have permissions to publish the digital product. By default, publishing is reserved to the Owner and the Organization Admin.
Steps:
Navigate to Workspace > Digital Products, filter by type and open the digital product.
Click Publish.
In the Confirm action window, optionally add a comment and click Confirm.
Post-Conditions:
The digital product moves to Published, Live and is available in the Active Catalog to the users allowed by its visibility.
The change is recorded in the History tab.
Retiring a digital product
Prerequisites:
The digital product must be in the Published, Live state.
The user must have permissions to retire the digital product.
Steps:
Navigate to Workspace > Digital Products, filter by type and open the digital product.
Click Retire.
In the Confirm action window, enter a comment (mandatory) and click Confirm.
Post-Conditions:
The digital product moves to Retired. It remains visible in the catalog only to the users whose visibility includes the Retired state.
The change is recorded in the History tab.
Deleting a digital product
Prerequisites:
The user must have permissions to delete the digital product in its current state.
Steps:
Open the digital product from Workspace > Digital Products, or select it in the list.
Click Delete.
In the Delete digital product window, check the name of the digital product and confirm.
Post-Conditions:
The digital product is permanently removed and the list of digital products is shown again.
Tips:
The deletion cannot be undone.
Managing the visibility of a digital product
Prerequisites:
Requires Administrator, Contributor, or equivalent role permissions.
Steps:
Open the digital product and go to the Visibility tab.
Choose the Digital Product sub-tab, or the Documentation sub-tab to set the visibility of its documentation.
Select the type of access:
Default access: the default visibility of digital products configured for your installation applies;
Custom access: you choose who can see the digital product;
Full access: everyone can see the digital product.
For custom access, configure:
in the Organizations tab, the organization types, organization categories or specific organizations that can see the digital product;
in the States tab, the lifecycle states (Concept, In Progress, Published, Retired) in which the digital product is visible.
For the documentation, select the pages concerned.
Click Save.
Post-Conditions:
The digital product is visible in the catalog only to the selected users and in the selected states.
Tips:
The default visibility of digital products is configured by the administrator (see the Default Entity Visibility chapter of the Administrator Manual).
The Documentation sub-tab is shown if documentation is enabled for your type of user.
Viewing the history of a digital product
Steps:
Open the digital product and go to the History tab.
Browse the timeline: each entry shows the state reached, who performed the action, when, and the comment entered in the Confirm action window, if any.
Post-Conditions:
The history is read-only.
Using MCP servers, AI Agents and custom digital products from the Active Catalog
Steps:
Open the Active Catalog, choose the Digital Products tab and filter by MCP, AI Agent or another type.
Open the digital product. Its detail page has the following tabs:
Identity card: description, template, owner, developer, organization, group, tags and the properties defined by the template, in read-only mode, with the lifecycle state and the date of the last update;
Specification: the technical files of the digital product, which can be previewed and downloaded;
Try It (MCP servers and AI Agents only): see Trying an MCP server and Trying an AI Agent above;
Documentation, Attachments and History.
Download the specifications you need (for example the server configuration of an MCP server or the agent card of an AI Agent) to integrate the digital product into your application or agent.
Post-Conditions:
You have the information needed to use the digital product.
Tips:
Subscriptions are available only for API Products: on the other digital products the Subscribe button is shown but cannot be used. The credentials needed to call an MCP server or an AI Agent, if any, are those required by the server or the agent itself, as described in its specifications.
The tabs and the information shown depend on the profiling configured for your type of user.
Managing API products
In the Platform, an API Product is a refined and standardized version of an API Asset, designed for integration and external consumption. API Products serve as the interface between enterprise systems and external consumers, enabling seamless interactions. Each API Product follows a structured lifecycle, ensuring proper governance, visibility, and versioning. API Products are listed in Workspace > Digital Products, filtering by the API type.
Creating an API product
Prerequisites:
Requires Administrator, Contributor, or equivalent custom role permissions.
The user must belong to an organization within which the API Product will be created.
Steps:
Click New Digital Product in the Quick actions menu, or Add in Workspace > Digital Products, and choose API REST.
Choose the type of API Product creation:
Create a new API Product from scratch.
Productize an existing API Asset.
In the Source section of the New API product page (available when API Assets are enabled for your installation):
when creating from scratch, select the Integration Pattern of the API Asset that is created together with the product;
when productizing, click Choose Asset and pick the API Asset. The rest of the form is pre-filled from it, and the products already generated from the same asset are listed for reference.
In the Overview section, enter the details:
Name: Unique identifier for the API Product within the organization.
Version: Version of the API Product (following semantic versioning, usually starting from 1.0.0).
Description: A brief summary of the product’s purpose, useful for searchability.
Organization & Group: Define the ownership structure. The group can be selected once the organization is chosen.
Owner & Developer: Assign business and technical roles. These fields appear once the group is selected.
Categories & Tags (optional): help users find the product in the catalog.
In the Technical details section, optionally enter:
External ID: correlates the product with your own systems.
Provider: the application of the group exposing the API Product.
Click CREATE to confirm.
Post-Conditions:
The API Product is created and listed under Concept > Draft.
If created from an existing asset, the product inherits the asset’s information.
Tips:
If the API Full Configuration is enabled, an associated API Asset will also be created automatically.
Defining the OpenAPI specification of an API product
Steps:
Open the API Product and go to the Technical details of the Data tab.
Choose how to provide the back-end OpenAPI definition:
import it from a file (.yml, .yaml or .json);
build it with the guided creation, adding domains and endpoints;
click Go to Designer to create or edit it in the API Designer.
Save the changes.
Tips:
When domains and endpoints are saved with the guided creation, a new definition is generated and completely replaces the current one.
Creating a new version of an API product
Prerequisites:
The existing API Product must be Active and Published.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the API Product and open its details.
Click New Version and select the version type:
Major: Introduces breaking changes.
Minor: Backward-compatible updates.
Patch: Bug fixes or small enhancements.
Confirm the action.
Post-Conditions:
A new version of the API Product is created in In Progress > Draft.
Tips:
For Major Versions, a new related API Asset is created.
Proposing an API product
Prerequisites:
The API Product must be in Draft state.
The user must have permissions to propose an API Product.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the draft API Product and open its details.
Click PROPOSE to submit for evaluation.
Confirm the action and optionally leave a comment.
Post-Conditions:
The API Product moves to Concept > Proposed state for review.
Managing a proposed API product
Prerequisites:
Requires Administrator or equivalent custom role permissions.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the Proposed API Product and open its details.
Choose an action:
ACCEPT: Moves the API Product to In Progress > Draft.
REJECT: Moves the API Product to Concept > Rejected.
Confirm the action.
Post-Conditions:
The API Product’s state updates based on the decision.
Publishing an API product
Prerequisites:
The API Product must be in In Progress > Pending for Publishing.
An API Product must have an API Specification to be published.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the API Product and open its details.
Click PUBLISH.
Select the Deployment Environment (e.g., DEV, TEST, PROD).
Confirm the action.
Post-Conditions:
The API Product is published in the selected environment.
If integrated with an API Gateway, synchronization occurs automatically.
Promoting an API product
Prerequisites:
The API Product must be in Published > Non-Production.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the Non-Production API Product and open its details.
Click PROMOTE to the next environment.
Confirm the action.
Post-Conditions:
The API Product is promoted through environments until it reaches Production.
Tips:
Promotion follows a strict sequence: DEV → TEST → PROD. The order in which environments are displayed is configured by the administrator.
Deprecating an API product
Prerequisites:
The API Product must be Published in Production.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the API Product and open its details.
Click DEPRECATE.
Optionally set a Deprecation Date.
Confirm the action.
Post-Conditions:
The API Product remains usable but is marked as deprecated.
Retiring an API product
Prerequisites:
The API Product must be Deprecated.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the API Product and open its details.
Click RETIRE.
Optionally set a Retirement Date.
Confirm the action.
Post-Conditions:
The API Product is no longer accessible.
Modifying an API product
Prerequisites:
Requires Administrator, Contributor, or equivalent role permissions.
The API Product must not be in Retired or Transitional states.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the API Product and open its details.
Make necessary modifications.
Click SAVE.
Post-Conditions:
The API Product is updated while maintaining its state.
Tips:
Some fields may be locked based on the lifecycle state.
A user with the right permissions can modify an API specification even after publishing it and then sync the content on the gateway through the Republish API process.
Deleting an API product
Prerequisites:
The API Product must not be Published.
If published, it must be Retired first.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the API Product and open its details.
Click DELETE.
Confirm the action.
Post-Conditions:
The API Product is permanently removed.
Managing API product visibility
Prerequisites:
Requires Administrator, Contributor, or equivalent role permissions.
Steps:
Navigate to Workspace > Digital Products and filter by API.
Locate the API Product and open its Visibility tab, choosing the sub-tab for the API or for its documentation.
Configure visibility by:
Organization Type
Organization Category
Specific Organization
Lifecycle Status & Deployment Environments depending on the type of user.
Click SAVE.
Post-Conditions:
The API Product’s visibility is updated based on the selected criteria.
Tips:
When you grant full access to an API Product, you're allowing anyone to see it. No authentication or special permissions required. If the public showcase is enabled, your API will be visible in the API Catalog to all visitors. Make sure you are comfortable with this level of exposure.
Managing API product approvability
Prerequisites:
Requires Administrator, Contributor, or equivalent role permissions.
Steps:
Navigate to the API Product
Go to Workspace > Digital Products and filter by API.
Locate the desired API Product and open its Subscriptions Lifecycle tab.
Configure Approval Lifecycle
In this section, you can define how subscription approvals should be handled for this API.
The system supports two approval steps:
Business Approval
Technical Approval
You may enable or disable these steps depending on your governance needs:
If both steps are disabled, all new subscriptions will be automatically approved with no manual intervention.
If one or both steps are enabled, subscriptions must pass the corresponding approval step(s) before proceeding.
Define Auto-Approval Exceptions
For each enabled approval step, you can configure rules that allow certain subscription requests to skip the approval step and be automatically approved.
Auto-approval can be configured based on:
Organization Type
Organization Category
Specific Organization
Save Changes
Once your approval logic and exceptions are configured, click SAVE.
Post-Conditions:
The API Product’s subscription approvability rules are updated according to the selected approval steps and configured exceptions.
Tips:
If you want a fully automated subscription flow, simply disable both approval steps.
For granular control, enable approval steps but use exception rules to streamline approval for trusted organizations or partners.
Managing API assets
In the Platform, an API Asset represents an enterprise resource that provides access to valuable functionalities or data. Each asset is owned by an organization and a designated developer team, ensuring proper governance. API Assets serve as the foundation for creating API Products, which are tailored for target consumers and business needs. API Assets are listed in Workspace > Assets.
API Assets are available if enabled for your installation.
Creating an API asset
Prerequisites:
Requires Administrator, Contributor, or equivalent custom role permissions.
The user must belong to an organization within which the asset will be created.
Steps:
Click New Asset in the Quick actions menu, or Add in Workspace > Assets.
Enter the required details:
Name: Unique identifier for the API Asset.
Description: A brief summary of the asset’s purpose, useful for searchability.
Organization: Select an organization the user is a member of.
Group: Choose a group within the organization.
Owner: (Optional) Assign a business owner from the selected group.
Developer: (Optional) Assign a technical developer from the selected group.
Categories & Tags: (Optional) Select predefined classifications.
Integration Pattern: Choose the integration type for the asset (e.g., REST, SOAP).
Provider: (Optional) Select the application exposing the API Asset.
Click CREATE to confirm the asset creation.
Post-Conditions:
A new API Asset is created in In Progress > Draft and listed in Workspace > Assets.
The asset is editable and can be proposed for activation.
Tips:
Users with custom roles may have additional configuration options. Contact the administrator of your installation for details.
Duplicating an API asset
Prerequisites:
Requires Administrator or equivalent custom role permissions.
Only active assets can be duplicated.
Steps:
Navigate to Workspace > Assets.
Find the active asset to duplicate.
Click the DUPLICATE button.
A copy of the asset is created with "- Copy" appended to its name.
Post-Conditions:
The new API Asset is listed under In Progress > Draft and inherits the parent asset’s information.
Tips:
Some fields, such as Integration Pattern, may not be editable in the duplicate.
Proposing an API asset
Prerequisites:
The asset must be in Draft state.
The user must have permissions to propose an asset.
Steps:
Navigate to Workspace > Assets.
Locate the draft asset and open its details.
Click PROPOSE to submit it for evaluation.
Confirm the action and optionally leave a comment.
Post-Conditions:
The API Asset moves to In Progress > Proposed state for evaluation.
Managing a proposed API asset
Prerequisites:
Requires Administrator or equivalent custom role permissions.
Steps:
Navigate to Workspace > Assets.
Locate the Proposed asset and open its details.
Choose an action:
ACTIVATE: Moves the asset to Active > Unpublished.
ACTIVATE AND PUBLISH: Moves the asset to Active > Published.
REJECT: Moves the asset to In Progress > Rejected.
Confirm the action and optionally add a comment.
Post-Conditions:
The asset's status updates based on the selected action.
Directly activating (and publishing) a draft API asset
Prerequisites:
Requires Administrator or equivalent custom role permissions.
The asset must be in Draft state.
Steps:
Navigate to Workspace > Assets.
Locate the Draft asset and open its details.
Choose one of the following actions:
ACTIVATE: Moves the asset to Active > Unpublished.
ACTIVATE AND PUBLISH: Moves the asset to Active > Published.
Confirm the action.
Post-Conditions:
The API Asset is activated and, if chosen, published.
Publishing an API asset
Prerequisites:
The asset must be in Active > Unpublished state.
Steps:
Navigate to Workspace > Assets.
Locate the Unpublished asset and open its details.
Click PUBLISH.
Confirm the action.
Post-Conditions:
The API Asset is now available in the Assets tab of the Active Catalog as Active > Published.
Unpublishing an API asset
Prerequisites:
The asset must be in Active > Published state.
Steps:
Navigate to Workspace > Assets.
Locate the Published asset and open its details.
Click UNPUBLISH.
Confirm the action.
Post-Conditions:
The asset is moved back to Active > Unpublished.
Deprecating an API asset
Prerequisites:
The asset must be in Active > Published or Active > Unpublished state.
Steps:
Navigate to Workspace > Assets.
Locate the asset and open its details.
Click DEPRECATE.
Confirm the action.
Post-Conditions:
The asset is moved to Active > Deprecated.
Deprecated assets remain accessible but are no longer maintained.
Modifying an API asset
Prerequisites:
Requires Administrator, Contributor, or equivalent role permissions.
Steps:
Navigate to Workspace > Assets.
Locate the asset and open its details.
Make the necessary modifications.
Click SAVE to confirm changes.
Post-Conditions:
The asset is updated, but its lifecycle state remains unchanged.
Tips:
Some fields may be locked based on the asset's current state.
Productizing an API asset
Prerequisites:
Only SOAP and REST API Assets can be productized.
Steps:
Navigate to Workspace > Assets.
Locate the asset and open its details.
Click PRODUCTIZE.
A new API Product creation page opens, pre-filled with the asset’s details.
Click CREATE to finalize the product.
Post-Conditions:
A new API Product is created in Concept > Draft and listed in Workspace > Digital Products.
Deleting an API asset
Prerequisites:
The asset must be Inactive or Deprecated.
No API Products should be associated with the asset.
Steps:
Navigate to Workspace > Assets.
Locate the asset and open its details.
Click DELETE.
Confirm the action.
Post-Conditions:
The API Asset is permanently removed.
Tips:
If an asset has associated products, it must be unlinked before deletion.