Skip to content

Commit cf870a9

Browse files
committed
integration starter kit updates
1 parent b76a963 commit cf870a9

File tree

1 file changed

+67
-2
lines changed

1 file changed

+67
-2
lines changed

src/pages/starter-kit/integration/create-integration.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,26 @@ To download a `.json` file containing your workspace configuration:
9393

9494
The `<Workspace-name>.json` file downloads automatically. In this example, the file is named `977AmethystGazelle-1340225-Stage.json`. Rename the file `workspace.json` and save it in the `scripts/onboarding/config/` directory of the starter kit.
9595

96-
#### Create an integration in Adobe Commerce
96+
#### PaaS or SaaS
97+
98+
The integration starter kit is designed to work with all Adobe Commerce versions, but only one at a time. This means that you can use either Adobe Commerce on Cloud / on Premises (PaaS) or Adobe Commerce as a Cloud Service (SaaS). By default, the starter kit will check for PaaS authentication first using **OAuth1**, before it checks for SaaS authentication using **IMS**.
99+
100+
* For PaaS configurations, refer to [Create an integration in Adobe Commerce (PaaS only)](#create-an-integration-in-adobe-commerce-paas-only) and make sure your environment variables `COMMERCE_XXXX` are set correctly in the `.env` file.
101+
102+
* For SaaS configurations, refer to [Create an integration in Adobe Commerce as a Cloud Service](#create-an-integration-in-adobe-commerce-as-a-cloud-service) and make sure the environment variables file does not contain `COMMERCE_XXXX` variables.
103+
104+
<InlineAlert variant="info" slots="text"/>
105+
106+
`app.config.yaml` has both sets of environment variables declared. These determine the runtime action context. This file works regardless of offering, so you do not need to modify it.
107+
108+
#### Create an integration in Adobe Commerce (PaaS only)
97109

98110
A Commerce integration generates the consumer key, consumer secret, access token, and access token secret that are required to connect to the starter kit. It also identifies the available API resources that are needed for the integration.
99111

112+
<InlineAlert variant="info" slots="text"/>
113+
114+
This section applies to Adobe Commerce on-premises and Adobe Commerce on cloud infrastructure (PaaS) customers only. For Adobe Commerce as a Cloud Service (SaaS) customers, see [Create an integration in Adobe Commerce as a Cloud Service](#create-an-integration-in-adobe-commerce-as-a-cloud-service).
115+
100116
Use the following steps to create and activate an integration.
101117

102118
1. From the Admin, go to **System** > Extensions > **Integrations**.
@@ -121,6 +137,34 @@ Use the following steps to create and activate an integration.
121137

122138
You will need the integration details (consumer key, consumer secret, access token, and access token secret) to configure the starter kit. Copy these values to a safe place and click **Done**.
123139

140+
#### Create an integration in Adobe Commerce as a Cloud Service
141+
142+
To configure authentication for Adobe Commerce as a Cloud Service (SaaS), you need to add OAuth server-to-server credentials to your environment.
143+
144+
<InlineAlert variant="info" slots="text"/>
145+
146+
This section applies to Adobe Commerce as a Cloud Service (**SaaS**) customers only. For Adobe Commerce on-premises and Adobe Commerce on cloud infrastructure (**PaaS**) customers, see [Create an integration in Adobe Commerce](#create-an-integration-in-adobe-commerce-paas-only).
147+
148+
1. In the [Adobe Developer Console](https://developer.adobe.com/console):
149+
150+
1. Navigate to your project or create a new one.
151+
152+
1. Add the **I/O Management API** t enable server-to-server authentication capabilities. For more information, refer to [server-to-server authentication](https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/implementation#setting-up-the-oauth-server-to-server-credential/).
153+
154+
1. Store the credentials from Adobe Developer Console in the integration starter kit's `.env` file. The following values are required:
155+
156+
```text
157+
OAUTH_CLIENT_ID=<string> # Your client ID
158+
OAUTH_CLIENT_SECRET=<string> # Your client secret
159+
OAUTH_SCOPES=<array> # ['scope1', 'scope2']
160+
```
161+
162+
The following values are optional:
163+
164+
```dotenv
165+
OAUTH_HOST=<string> # default: https://ims-na1.adobelogin.com
166+
```
167+
124168
#### Install Adobe I/O Events for Adobe Commerce (Commerce 2.4.4 and 2.4.5 only)
125169

126170
If you are running Adobe Commerce 2.4.6 or higher, the modules that enable eventing are installed automatically. Skip to the next step. If you are running Commerce 2.4.4 or 2.4.5, you must install modules to enable eventing, as described in [Install Adobe I/O Events for Adobe Commerce](../../events/installation.md).
@@ -145,7 +189,28 @@ Use the following steps to download and configure the Adobe Commerce integration
145189
cd <download-directory> && cp env.dist .env
146190
```
147191

148-
1. Fill in the values in the `.env` file. The file describes where you can find the values for each environment variable.
192+
1. Fill in the values in the `.env` file. The file describes where you can find the values for each environment variable. The following values are required:
193+
194+
```terminal
195+
COMMERCE_CONSUMER_KEY=
196+
COMMERCE_CONSUMER_SECRET=
197+
COMMERCE_ACCESS_TOKEN=
198+
COMMERCE_ACCESS_TOKEN_SECRET=
199+
```
200+
201+
When configuring the `COMMERCE_BASE_URL` environment variable, the format differs between [PaaS and SaaS](#paas-or-saas):
202+
203+
For PaaS (On-Premise/Cloud):
204+
205+
* `COMMERCE_BASE_URL` must include your base site URL + `/rest/`
206+
* Example: `https://<environment-name>.us-4.magentosite.cloud/rest/`
207+
208+
For SaaS (Adobe Commerce as a Cloud Service):
209+
210+
* `COMMERCE_BASE_URL` must be the REST API endpoint provided by Adobe Commerce
211+
* Example: `https://na1-sandbox.api.commerce.adobe.com/<tenant-id>/`
212+
213+
Make sure to use your actual environment name or tenant ID in the URL. The examples above use placeholder values.
149214

150215
#### Configure the starter kit
151216

0 commit comments

Comments
 (0)