Install Adobe Commerce Admin UI SDK

This topic describes the basic steps to install the Admin UI SDK.

Prerequisites

Adobe Commerce

• Adobe Commerce on cloud infrastructure or on premises: 2.4.5+
• PHP 8.1+
• Adobe Identity Management Service (IMS) for Adobe Commerce

Adobe App Builder

The Adobe App Builder Getting Started guide lists the latest software requirements for creating App Builder apps.

Installation steps

You can install the Admin UI SDK on Adobe Commerce on cloud infrastructure and on-premises instances.

Enable Adobe IMS for Commerce

You must implement Adobe Identity Management Service (IMS) for Adobe Commerce to use the Admin UI SDK. Configure the Commerce Admin Integration with Adobe ID describes this process.

Adobe Commerce on cloud infrastructure

This method installs the SDK on a cloud instance.

1. On your local workstation, change to the Cloud project root directory.

2. Update your composer.json file:

   Copy
   composer require "magento/commerce-backend-sdk": ">=1.0"
   Copied to your clipboard
   composer require "magento/commerce-backend-sdk": ">=1.0"

3. Update dependencies and install the extension:

   Copy
   composer update
   Copied to your clipboard
   composer update

   The composer update command updates all dependencies. If you do not want to update all dependencies at the same time, use this command instead:

   Copy
   composer update magento/commerce-backend-sdk
   Copied to your clipboard
   composer update magento/commerce-backend-sdk

4. Commit and push your changes.

On-premises

This method installs the SDK on an On-premises instance.

1. Add the SDK module to the require section of the composer.json file:

   Copy
   composer require "magento/commerce-backend-sdk": ">=1.0"
   Copied to your clipboard
   composer require "magento/commerce-backend-sdk": ">=1.0"

2. Update dependencies and install the extension:

   Copy
   composer update
   Copied to your clipboard
   composer update

   The composer update command updates all dependencies. If you do not want to update all dependencies at the same time, use this command instead:

   Copy
   composer update magento/commerce-backend-sdk
   Copied to your clipboard
   composer update magento/commerce-backend-sdk

3. Upgrade Adobe Commerce:

   Copy
   bin/magento setup:upgrade
   Copied to your clipboard
   bin/magento setup:upgrade

4. Refresh indexes:

   Copy
   bin/magento indexer:reindex
   Copied to your clipboard
   bin/magento indexer:reindex

5. Clear the cache:

   Copy
   bin/magento cache:clean
   Copied to your clipboard
   bin/magento cache:clean

6. Commit your changes.

7. Update your on-premises instance to ensure the committed code is deployed.

Update the Commerce Admin UI SDK

Use the following procedure to update patch versions of the SDK, such as from V1.0.0 to V1.1.0.

1. Run the following command to update the SDK:

   Copy
   composer update magento/commerce-backend-sdk
   Copied to your clipboard
   composer update magento/commerce-backend-sdk

2. Run the following commands to upgrade Adobe Commerce and clear the cache.

   Copy
   bin/magento setup:upgrade && bin/magento indexer:reindex && bin/magento cache:clean
   Copied to your clipboard
   bin/magento setup:upgrade && bin/magento indexer:reindex && bin/magento cache:clean

3. If you are updating from V1.x to V2.0, refer to Migrate your extension point for additional instructions.

Last updated 9/4/2024

Was this helpful?

Yes

No