Skip to content

Commit 01faad2

Browse files
committed
Merge branch 'review-v2-2'
2 parents a4299a4 + 4c09f40 commit 01faad2

1 file changed

Lines changed: 39 additions & 4 deletions

File tree

INSTALL.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,52 @@ Go to the [Adobe developer console](https://developer.adobe.com/console) portal
1414
- I/O management API
1515
- Download the [workspace configuration JSON](https://developer.adobe.com/commerce/extensibility/events/project-setup/#download-the-workspace-configuration-file) file and save it as `workspace.json` in the `./scripts/onboarding/config` folder because you will use it to configure Adobe IO Events in commerce afterward.
1616

17-
### Configure a new Integration in commerce ![Compatibility](https://img.shields.io/badge/PaaS%20Only-0000FF)
17+
### Supported Auth types
18+
19+
With the new announcement of **Adobe Commerce as a Cloud Service** (ACCS), requests to Commerce will now use different authentication strategies depending on the flavor you're using:
20+
21+
- If you're using the traditional Adobe Commerce Platform (PaaS) offering, you'll need to authenticate via OAuth1, like you've been doing until now.
22+
23+
- If you're using the new cloud service (SaaS) offering, you'll need to authenticate your requests using [Adobe Identity Management System](https://experienceleague.adobe.com/en/docs/experience-manager-learn/foundation/authentication/adobe-ims-authentication-technical-video-understand) (IMS).
24+
25+
#### ![Compatibility](https://img.shields.io/badge/PaaS%20Only-0000FF) Commerce OAuth1 - Configure a new Integration in Commerce
1826
Configure a new Integration to secure the calls to Commerce from App Builder using OAuth by following these steps:
1927
- In the Commerce Admin, navigate to System > Extensions > Integrations.
2028
- Click the `Add New Integration` button. The following screen displays
21-
![Alt text](docs/new-integration.png "New Integration")
29+
![New Integration Screen](docs/new-integration.png "New Integration")
2230
- Give the integration a name. The rest of the fields can be left blank.
2331
- Select API on the left and grant access to all the resources.
24-
![Alt text](docs/integration-all-apis-access.png "New Integration")
32+
![API Access Grant Screen](docs/integration-all-apis-access.png "New Integration")
2533
- Click Save.
2634
- In the list of integrations, activate your integration.
27-
- To configure the module, you will need the integration details (consumer key, consumer secret, access token, and access token secret).
35+
- To configure the starter kit, you will need the integration details (consumer key, consumer secret, access token, and access token secret).
36+
37+
Store the credentials in the `.env` file, these are the minimum required values:
38+
```dotenv
39+
COMMERCE_CONSUMER_KEY=
40+
COMMERCE_CONSUMER_SECRET=
41+
COMMERCE_ACCESS_TOKEN=
42+
COMMERCE_ACCESS_TOKEN_SECRET=
43+
```
44+
45+
#### ![Compatibility](https://img.shields.io/badge/SaaS%20Only-06402B) IMS OAuth - Add the OAuth Server to Server credentials to the environment
46+
Configure a new IMS OAuth Server to Server following this [documentation](https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/implementation/#setting-up-the-oauth-server-to-server-credential/)
47+
48+
Store the credentials in the `.env` file:
49+
```dotenv
50+
# The following values can be copied from the Credential details page in AppBuilder under Organization > Project > Workspace > OAuth Server-to-Server
51+
# Client ID
52+
OAUTH_CLIENT_ID=
53+
# Client Secret (Retrieve Client Secret)
54+
OAUTH_CLIENT_SECRET=
55+
# Technical Account ID
56+
OAUTH_TECHNICAL_ACCOUNT_ID=
57+
# Technical Account Email
58+
OAUTH_TECHNICAL_ACCOUNT_EMAIL=
59+
# Organization ID
60+
OAUTH_ORG_ID=
61+
OAUTH_SCOPES=AdobeID, openid, read_organizations, additional_info.projectedProductContext, additional_info.roles, adobeio_api, read_client_secret, manage_client_secrets, event_receiver_api
62+
```
2863

2964
### Install Commerce Eventing module (only required when running Adobe Commerce versions 2.4.4 or 2.4.5) ![Compatibility](https://img.shields.io/badge/PaaS%20Only-0000FF)
3065
Install Adobe I/O Events for Adobe Commerce module in your commerce instance following this [documentation](https://developer.adobe.com/commerce/extensibility/events/installation/)

0 commit comments

Comments
 (0)