Adobe Commerce Admin UI SDK overview

The Adobe Commerce Admin UI SDK enables an App Builder developer to extend the Commerce Admin to include custom menus and pages. These Admin customizations were traditionally defined in a PHP module. The principles of Out-of-Process development require a more modern approach. The Admin UI SDK provides the merchant with the means to use the Admin to configure and interact with an app developed in App Builder.

Many types of apps will use this SDK. It represents a one-to-many approach for supporting Out of Process UI Extensibility. Application developers, internal adopters, and merchants using Out of Process Extensibility no longer have to rely on purely headless applications. Instead, they can now build and use secure and authenticated UIs directly from the Commerce Admin panel.

Architecture

The following diagram shows the architecture of the Admin UI SDK.

The SDK contains two main components that are necessary for development:

• The CommerceBackendUix module is a traditional in-process Commerce PHP module that allows Out of Process extensions to inject menus and pages into the Admin.

• uix defines a React app that renders the custom Admin content.

Adobe Identity Management Service (IMS) manages authentication. The merchant adds their IMS org information into a configuration panel in Commerce. Once this information added, the merchant's App Builder app can securely communicate with the merchant's instance and render the app UI.

The following sequence diagram illustrates the authentication process.

Code samples

The Adobe Commerce Samples repository contains samples for different extension points of the Adobe Commerce Admin UI SDK. Use these samples to gain insight on how the Admin SDK injects menus and pages into the Admin.

Last updated 6/26/2024

Was this helpful?

Yes

No