Configure a public app

After registering a public app, you must configure it.

To configure a public app:

  1. In the Cloud Portal, click App studio > Studio, then click the app you want to configure.

  2. On the Configuration tab, in the Extension points section, select at least one area in the SitecoreAI user interface where you want to display your app. You can change this selection any time as your app requirements change.

  3. For every enabled extension point, review or, optionally, customize the Route URL. The route URL represents a URL path in your application that the extension point is associated with.

    Important

    When you build your app using the Marketplace SDK in a later step, make sure to associate the same route URLs with a component of your app.

  4. If you add more than one instance of the same extension point, review or, optionally, customize the Display name. The display name appears in the user interface as the extension point title.

  5. In the API access section, select the APIs your app needs to access, if any. You can change this selection any time as your app requirements change.

  6. In the Permissions section, enable pop-ups and clipboard access if your app requires them. You can change this selection any time as your app requirements change.

  7. In the Deployment URL field, enter the localhost address where you'll develop your app. The deployment URL is the URL Sitecore uses to display your app. You'll change this to a production URL after development, when you finish configuration.

    Typical localhost address for React (Vite) apps: http://localhost:5173

    Typical localhost address for Next.js apps: http://localhost:3000

    Important

    If you decided to use custom authorization, set the deployment URL to the custom DNS you previously set up. For example, https://myapp.local:3000.

    When you build your app using the Marketplace SDK in a later step, make sure to start the app on the same address that you specify as the deployment URL.

  8. Make a note of your Marketplace app ID. You'll use this later, during development.

  9. If you decided to use custom authorization, create client credentials for your app.

  10. On the Overview tab, in the App logo field, upload your app logo.

    If you don't have a logo yet, use the following, temporary logo:

    https://cdn-1.webcatalog.io/catalog/sitecore/sitecore-icon.png?v=1731337318728

Next, install the app for local development.

Auth0 authorization flow for Marketplace applications that replaces the built-in authorization managed by the Marketplace SDK. Required if your app needs to make server-side API calls to SitecoreAI APIs.

Do you have some feedback for us?

If you have suggestions for improving this article,