Skip to content

Commit 1db35f2

Browse files
authored
Merge pull request #592 from mkovdrysh/docs/add-commerce-sdk-best-practice
Add Adobe Commerce SDK best practice
2 parents 3808d8b + 902227d commit 1db35f2

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

src/pages/app-development/app-submission-guidelines.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,21 @@ The following best practices are not required for your app to be accepted, but t
169169
- [Integration starter kit](../starter-kit/integration/index.md)
170170
- [Checkout starter kit](../starter-kit/checkout/index.md)
171171

172+
- Adobe Commerce SDK
173+
- **Typed API clients**: Use packages from the [Adobe Commerce SDK](https://github.com/adobe/aio-commerce-sdk) family instead of writing custom HTTP/auth/eventing logic from scratch. These libraries provide typed clients, built-in authentication, and retry logic, and keep your code aligned with Adobe's recommended patterns:
174+
- `@adobe/aio-commerce-lib-auth` — authentication flows for Adobe IMS and Commerce integrations
175+
- `@adobe/aio-commerce-lib-api` — HTTP/API client builders for Adobe Commerce and Adobe I/O Events
176+
- `@adobe/aio-commerce-lib-events` — event-driven integrations between Commerce and Adobe I/O Events
177+
- `@adobe/aio-commerce-lib-webhooks` — utilities for the Adobe Commerce Webhooks API
178+
- `@adobe/aio-commerce-lib-core` — shared foundational utilities used across the family
179+
180+
Apps that adopt full App Management additionally require `@adobe/aio-commerce-lib-app` and `@adobe/aio-commerce-lib-config`, but the libraries above can be used independently for apps not yet using App Management.
181+
182+
- **App Management**: Use [App Management](../app-management/index.md) to define your configuration schema, event subscriptions, and Admin UI once in an `app.commerce.config` file, and let the system auto-generate the required runtime actions and Admin UI. This is the Adobe-endorsed approach for installing, configuring, and managing App Builder applications in Commerce, and removes the need for merchants to manually configure event providers, subscriptions, or environment variables.
183+
- Requires [Admin UI SDK](../admin-ui-sdk/index.md) version 3.3.1 or later.
184+
- Requires minimum library versions 1.0.0 or later for `@adobe/aio-commerce-lib-config`, `@adobe/aio-commerce-lib-app`, and `@adobe/aio-commerce-sdk`.
185+
- Not currently supported for local Commerce installations — requires a hosted (cloud or on-premises) environment.
186+
172187
- Script management
173188
- **Script validation**: Execute everything in `package.json` scripts section and ensure there are no errors.
174189
- **Script cleanup**: Ensure there are no unused or non-working scripts.

0 commit comments

Comments
 (0)