Sitecore Marketplace SDK for JavaScript
The open-source Marketplace SDK lets developers build Marketplace applications. These are JavaScript or TypeScript apps that extend and customize Sitecore products and give Sitecore users new capabilities tailored to their needs.
The Marketplace SDK offers two main functionalities, delivered in distinct packages:
-
Interactions between your app and Sitecore - the required
clientpackage connects your app to Sitecore, allowing the two to securely communicate. For example, it enables your app to appear in and interact with SitecoreAI extension points such as the SitecoreAI Page builder. -
Interactions with SitecoreAI APIs - the optional
xmcpackage gives your app API access to SitecoreAI. The package provides type-safe interfaces for interacting with SitecoreAI APIs from the client side and from the server side, if your app needs it. -
Interactions with AI skills APIs - the optional
aipackage gives your app API access to AI skills. AI skills APIs provide LLM-powered capabilities grounded in SitecoreAI data. The package provides type-safe interfaces for interacting with AI skills APIs from the client side and from the server side, if your app needs it.
Development tasks with the Marketplace SDK
Before you start using the Marketplace SDK, decide what to build, then plan and design your app. During planning, you also choose your app architecture and authorization, which affects how you work with the SDK. Next, create, configure, and install your custom or public app in the Cloud Portal. After completing these steps, you're ready to start development.
You can start development in any of the following ways:
-
Complete one of the SDK quick starts depending on your app architecture and authorization.
-
Use the Sitecore Marketplace SDK Starter Kit, which provides a preconfigured project structure. For more information, refer to the Sitecore Developer Portal.
-
Explore sample applications created by Sitecore.
The most common development tasks you perform with the Marketplace SDK include the following:
-
Initialize the
clientpackage - after you finish initialization, you can open your app in Sitecore so the two can securely communicate. -
Optionally, initialize other packages - for example, if your app needs access to SitecoreAI APIs, initialize
xmc. If your app needs access to AI skills APIs, initializeai. -
Make queries - retrieve data from Sitecore to your app. For example, retrieve data about your application, page variants, the hierarchy of an SitecoreAI site, and more.
Note -
Make mutations - change data in Sitecore from your app. For example, create content using the GraphQL API, update an SitecoreAI site, delete a site language, and more.
Note -
Subscribe to events - receive real-time updates in your app as the data in Sitecore changes. For example, get an update when the SitecoreAI Page builder user opens a different page.
After development, return to the Cloud Portal to finish setting up your custom or public app.