Search...

Out of support

Search...

Out of support

Introduction

General questions

What is the Platform and how does it work?

The Platform is a comprehensive Digital Product governance platform that helps organizations manage product lifecycles, enforce governance policies, and standardize Product access across different teams and business units.

Who can use the Platform?

The Platform is designed for developers, architects, digital product managers, and business users who need a structured way to manage digital product lifecycles and ensure compliance with security and governance policies.

How does the Platform enforce Digital Product governance?

The Platform enforces Digital Product governance through role-based access control (RBAC), lifecycle management policies, compliance tracking, and product standardization frameworks.

Roles and access

What are the default user roles in the Platform?

The Platform includes predefined roles such as Owner, Organization Admin, Group Admin, Contributor, Consumer, Guest and Visitor, each with specific permissions. What each type of user can see and do is configured by the administrator, according to the needs of each installation.

Can I create custom roles in the Platform?

Yes, administrators can create custom roles with fine-grained permissions, allowing organizations to define specific access controls for different lifecycle stages.

Digital Products

What's the difference between an API Asset and a Digital Product?

  • API Asset represents an individual technical service, such as a specific REST or SOAP service, that development teams register with the Platform to put under governance. Assets are not directly exposed to consumers.

  • Digital Product is what producers publish and consumers use: an API Product (often backed by one or more API Assets), an MCP server, an AI Agent or a custom type defined by the administrator. Digital products follow a lifecycle, have their own documentation and visibility, and are shown in the Active Catalog.

So API Assets are the granular technical components, while digital products are the higher-level offering made available for consumption. Typically development teams register Assets, while product managers curate the digital products that are published.

What is the Active Catalog in the Platform?

The Active Catalog is the single place where users find all the digital products and API Assets they are allowed to see. It can be filtered by type (API, MCP, AI Agent and other types), viewed as cards or as a table, and is the starting point for discovering digital products, reading their documentation and subscribing to them.

How does the Platform handle API versioning?

The Platform allows versioning to ensure backward compatibility. When updating an API, a new version can be created while maintaining support for previous versions.

AI and Agent

MCP servers, AI Agents and the AI assistants of the Platform are available only if enabled for your installation.

What is the difference between an Agent and Agentic AI?

  • Agent AI is an individual AI model or system that can perceive, reason, and take actions autonomously to achieve its goals. Agent AIs operate independently based on their training.

  • Agentic AI refers to the broader concept and field of building AI systems with agentic properties - the ability to act as autonomous agents with their own goals, decision making, and interactions with the environment.

So an Agent is a specific implementation, while Agentic AI is the general approach of creating AI systems that behave as agents. In the Platform, AI Agents can be described and published as digital products, so that they can be discovered and reused.

What is the Discovery Agent?

The Discovery Agent is an AI assistant that helps users search and explore the contents of the Platform, such as digital products, applications, assets, organizations and subscriptions, and retrieve their details and artifacts, for example the OpenAPI definition of a REST API, through a conversation.

How do MCP Servers interact with the Platform?

MCP Servers are managed in the Platform as digital products: producers describe their tools, prompts and resources, publish them in the Active Catalog and govern them through their lifecycle and visibility. Consumers find in the catalog the information needed to integrate an MCP server into their agentic projects, such as its configuration and card, and can try it from the Try It tab.

Subscriptions and Integrations

How do applications subscribe to a Digital Product?

Applications can request Digital product access through the subscription process, which may require admin approval depending on the Product approval settings.

Can I restrict the IP addresses that call my APIs?

Yes. If enabled by the administrator, consumers declare the client IP addresses of their application when they request or update a subscription. The addresses are collected in the Network section of the Workspace, where users with the appropriate permissions approve or reject them on the lists associated with the API environments. The approval of the IP addresses is independent of the approval of the subscription.

Can the Platform integrate with external API gateways?

Yes, the Platform supports integrations with various API gateways like Boomi, 3Scale, and others, enabling seamless API management. Connectors are available if enabled for your installation.

How does the Platform support DevOps integration?

The Platform integrates with CI/CD pipelines, deployment automation tools, and governance frameworks, ensuring products follow structured lifecycle processes.

Documentation menu

Introduction

Table of Contents

General questions

What is the Platform and how does it work?

The Platform is a comprehensive Digital Product governance platform that helps organizations manage product lifecycles, enforce governance policies, and standardize Product access across different teams and business units.

Who can use the Platform?

The Platform is designed for developers, architects, digital product managers, and business users who need a structured way to manage digital product lifecycles and ensure compliance with security and governance policies.

How does the Platform enforce Digital Product governance?

The Platform enforces Digital Product governance through role-based access control (RBAC), lifecycle management policies, compliance tracking, and product standardization frameworks.

Roles and access

What are the default user roles in the Platform?

The Platform includes predefined roles such as Owner, Organization Admin, Group Admin, Contributor, Consumer, Guest and Visitor, each with specific permissions. What each type of user can see and do is configured by the administrator, according to the needs of each installation.

Can I create custom roles in the Platform?

Yes, administrators can create custom roles with fine-grained permissions, allowing organizations to define specific access controls for different lifecycle stages.

Digital Products

What's the difference between an API Asset and a Digital Product?

  • API Asset represents an individual technical service, such as a specific REST or SOAP service, that development teams register with the Platform to put under governance. Assets are not directly exposed to consumers.

  • Digital Product is what producers publish and consumers use: an API Product (often backed by one or more API Assets), an MCP server, an AI Agent or a custom type defined by the administrator. Digital products follow a lifecycle, have their own documentation and visibility, and are shown in the Active Catalog.

So API Assets are the granular technical components, while digital products are the higher-level offering made available for consumption. Typically development teams register Assets, while product managers curate the digital products that are published.

What is the Active Catalog in the Platform?

The Active Catalog is the single place where users find all the digital products and API Assets they are allowed to see. It can be filtered by type (API, MCP, AI Agent and other types), viewed as cards or as a table, and is the starting point for discovering digital products, reading their documentation and subscribing to them.

How does the Platform handle API versioning?

The Platform allows versioning to ensure backward compatibility. When updating an API, a new version can be created while maintaining support for previous versions.

AI and Agent

MCP servers, AI Agents and the AI assistants of the Platform are available only if enabled for your installation.

What is the difference between an Agent and Agentic AI?

  • Agent AI is an individual AI model or system that can perceive, reason, and take actions autonomously to achieve its goals. Agent AIs operate independently based on their training.

  • Agentic AI refers to the broader concept and field of building AI systems with agentic properties - the ability to act as autonomous agents with their own goals, decision making, and interactions with the environment.

So an Agent is a specific implementation, while Agentic AI is the general approach of creating AI systems that behave as agents. In the Platform, AI Agents can be described and published as digital products, so that they can be discovered and reused.

What is the Discovery Agent?

The Discovery Agent is an AI assistant that helps users search and explore the contents of the Platform, such as digital products, applications, assets, organizations and subscriptions, and retrieve their details and artifacts, for example the OpenAPI definition of a REST API, through a conversation.

How do MCP Servers interact with the Platform?

MCP Servers are managed in the Platform as digital products: producers describe their tools, prompts and resources, publish them in the Active Catalog and govern them through their lifecycle and visibility. Consumers find in the catalog the information needed to integrate an MCP server into their agentic projects, such as its configuration and card, and can try it from the Try It tab.

Subscriptions and Integrations

How do applications subscribe to a Digital Product?

Applications can request Digital product access through the subscription process, which may require admin approval depending on the Product approval settings.

Can I restrict the IP addresses that call my APIs?

Yes. If enabled by the administrator, consumers declare the client IP addresses of their application when they request or update a subscription. The addresses are collected in the Network section of the Workspace, where users with the appropriate permissions approve or reject them on the lists associated with the API environments. The approval of the IP addresses is independent of the approval of the subscription.

Can the Platform integrate with external API gateways?

Yes, the Platform supports integrations with various API gateways like Boomi, 3Scale, and others, enabling seamless API management. Connectors are available if enabled for your installation.

How does the Platform support DevOps integration?

The Platform integrates with CI/CD pipelines, deployment automation tools, and governance frameworks, ensuring products follow structured lifecycle processes.

Documentation menu

Introduction

Table of Contents

General questions

What is the Platform and how does it work?

The Platform is a comprehensive Digital Product governance platform that helps organizations manage product lifecycles, enforce governance policies, and standardize Product access across different teams and business units.

Who can use the Platform?

The Platform is designed for developers, architects, digital product managers, and business users who need a structured way to manage digital product lifecycles and ensure compliance with security and governance policies.

How does the Platform enforce Digital Product governance?

The Platform enforces Digital Product governance through role-based access control (RBAC), lifecycle management policies, compliance tracking, and product standardization frameworks.

Roles and access

What are the default user roles in the Platform?

The Platform includes predefined roles such as Owner, Organization Admin, Group Admin, Contributor, Consumer, Guest and Visitor, each with specific permissions. What each type of user can see and do is configured by the administrator, according to the needs of each installation.

Can I create custom roles in the Platform?

Yes, administrators can create custom roles with fine-grained permissions, allowing organizations to define specific access controls for different lifecycle stages.

Digital Products

What's the difference between an API Asset and a Digital Product?

  • API Asset represents an individual technical service, such as a specific REST or SOAP service, that development teams register with the Platform to put under governance. Assets are not directly exposed to consumers.

  • Digital Product is what producers publish and consumers use: an API Product (often backed by one or more API Assets), an MCP server, an AI Agent or a custom type defined by the administrator. Digital products follow a lifecycle, have their own documentation and visibility, and are shown in the Active Catalog.

So API Assets are the granular technical components, while digital products are the higher-level offering made available for consumption. Typically development teams register Assets, while product managers curate the digital products that are published.

What is the Active Catalog in the Platform?

The Active Catalog is the single place where users find all the digital products and API Assets they are allowed to see. It can be filtered by type (API, MCP, AI Agent and other types), viewed as cards or as a table, and is the starting point for discovering digital products, reading their documentation and subscribing to them.

How does the Platform handle API versioning?

The Platform allows versioning to ensure backward compatibility. When updating an API, a new version can be created while maintaining support for previous versions.

AI and Agent

MCP servers, AI Agents and the AI assistants of the Platform are available only if enabled for your installation.

What is the difference between an Agent and Agentic AI?

  • Agent AI is an individual AI model or system that can perceive, reason, and take actions autonomously to achieve its goals. Agent AIs operate independently based on their training.

  • Agentic AI refers to the broader concept and field of building AI systems with agentic properties - the ability to act as autonomous agents with their own goals, decision making, and interactions with the environment.

So an Agent is a specific implementation, while Agentic AI is the general approach of creating AI systems that behave as agents. In the Platform, AI Agents can be described and published as digital products, so that they can be discovered and reused.

What is the Discovery Agent?

The Discovery Agent is an AI assistant that helps users search and explore the contents of the Platform, such as digital products, applications, assets, organizations and subscriptions, and retrieve their details and artifacts, for example the OpenAPI definition of a REST API, through a conversation.

How do MCP Servers interact with the Platform?

MCP Servers are managed in the Platform as digital products: producers describe their tools, prompts and resources, publish them in the Active Catalog and govern them through their lifecycle and visibility. Consumers find in the catalog the information needed to integrate an MCP server into their agentic projects, such as its configuration and card, and can try it from the Try It tab.

Subscriptions and Integrations

How do applications subscribe to a Digital Product?

Applications can request Digital product access through the subscription process, which may require admin approval depending on the Product approval settings.

Can I restrict the IP addresses that call my APIs?

Yes. If enabled by the administrator, consumers declare the client IP addresses of their application when they request or update a subscription. The addresses are collected in the Network section of the Workspace, where users with the appropriate permissions approve or reject them on the lists associated with the API environments. The approval of the IP addresses is independent of the approval of the subscription.

Can the Platform integrate with external API gateways?

Yes, the Platform supports integrations with various API gateways like Boomi, 3Scale, and others, enabling seamless API management. Connectors are available if enabled for your installation.

How does the Platform support DevOps integration?

The Platform integrates with CI/CD pipelines, deployment automation tools, and governance frameworks, ensuring products follow structured lifecycle processes.