Important

This feature is currently in Early Availability (EA) status. For more information, see our product lifecycle phases.

Getting Started

The platform extensions system is a powerful feature that allows 3rd party developers to build custom UI applications and embed them inside the marketplace. This documentation provides a comprehensive guide to building and uploading platform extensions to the platform. It includes step-by-step instructions, best practices, troubleshooting guidance, and examples.

What is a platform extension?

A platform extension is a front-end application that is built using the platform extensions system. platform extensions are built using web technologies such as React, CSS, and JavaScript. They can be embedded within our platform and interact with the marketplace APIs.

• It can be a single-page or a multi-pages application.
• It has a path (example: /app/my-extension)
• It can be linked to the marketplace navigation.
• You can control who can access it.

For more information on platform extensions, refer to extension reference architecture.

Core Technologies

1. React
2. Styled Components
3. Webpack - Module Federation

Prerequisites

Before you begin, you must have the following:

• Access to your marketplace with the role Marketplace Manager
• Be comfortable with the command line, and have Node.js 16+ installed

Steps to get started

1. Install the toolkit.
2. Create a new extension.
3. Work locally on your new extension.
4. When ready, upload and publish your extension.

Next Steps

Discover the extensive possibilities offered by extensions, which harness the combined strength of the platform's marketplace APIs and the diverse ecosystem of npm packages. This enables the creation of custom UI applications that integrate seamlessly with the marketplace.