Merge pull request #296 from AdobeDocs/update-endpoint-template

Update data-ingestion-schema-v1.yaml

Author: meker12

src/_includes/authentication/get-new-bearer-token.md

@@ -5,18 +5,18 @@ curl --request POST \
   --url 'https://ims-na1.adobelogin.com/ims/token/v3' \
   --header 'Content-Type: application/x-www-form-urlencoded' \
   --data 'grant_type=client_credentials' \
-  --data 'client_id={{client-id-value}}' \
-  --data 'client_secret={{client-secret-value}}' \
+  --data 'client_id={{clientId}}' \
+  --data 'client_secret={{clientSecret}}' \
   --data 'scope=openid,AdobeID,profile,email,commerce.aco.ingestion'
 ```
 
 Replace the following placeholders with your credentials:
 
-- `<client_id>`: The client ID generated for your Adobe developer project
-- `<client_secret>`: The client secret generated for your Adobe developer project
+- `{{clientId}}`: The client ID generated for your Adobe developer project
+- `{{clientSecret}}`: The client secret generated for your Adobe developer project
 
 You can get these credentials from the Adobe Developer Console project details page. If you don't have access to the developer console, contact your system administrator for assistance.
 
 <InlineAlert variant="info" slots="text" />
 
-This token request provisions the required scopes for Adobe Commerce Optimizer data ingestion as listed in the `scope` parameter. For information on managing, refreshing, and revoking bearer tokens, see the [User Authentication Implementation Guide](https://developer.adobe.com/developer-console/docs/guides/authentication/UserAuthentication/) in the *Adobe Developer Console documentation*.
+This token request provisions the required scopes for Adobe Commerce Optimizer data ingestion as listed in the `scope` parameter. For information on managing, refreshing, and revoking bearer tokens, see [User Authentication](https://developer.adobe.com/commerce/webapi/rest/authentication/user/) in the *Adobe Commerce REST Guide*.

src/_includes/authentication/get-tenant-id.md

@@ -1,19 +1,15 @@
-From Cloud Manager, you can find your instance ID in the instance details for your Commerce Optimizer project.
+From Cloud Manager, you can find the endpoint URLs and tenant ID (instance ID) in the instance details for your Commerce Optimizer project.
 
 1. Log in to your [Adobe Experience Cloud](https://experience.adobe.com/) account.
 
 1. Under **Quick access**, click **Commerce** to open the Commerce Cloud Manager.
 
    The Commerce Cloud Manager displays a list of instances that are available in your Adobe IMS organization.
 
-1. To get the instance ID, click the information icon next to the Adobe Commerce Optimizer instance name.
+1. To get the base URLs and instance ID, click the information icon next to the Adobe Commerce Optimizer instance name.
 
-   ![Access URLs for Commerce Optimizer UI, REST, and GraphQL APIs](../../pages/_images/reporting/aco-instance-details.png)
-
-   The instance details page opens, displaying the instance ID and other instance information. The instance ID is displayed in the `Instance ID` field.
-
-You can also find the instance ID from the access URL for the Adobe Commerce Optimizer application interface, the value is in the path, for example `/in:XDevkG9W6UbwgQmPn995r3/`.
+   ![Access URLs for Commerce Optimizer UI, REST, and GraphQL APIs](../../pages/_images/merchandising/aco-instance-details.png)
 
 <InlineAlert variant="info" slots="text" />
 
-If you don't have access to the Commerce Cloud Manager, contact your system administrator.
+If you don't have access to Cloud Manager, you can also find the region and tenant ID from the access URL for the Adobe Commerce Optimizer application interface.

src/_includes/authentication/initial-auth-for-api-access.md

@@ -2,10 +2,12 @@ To get API authentication credentials and tokens, create an Adobe developer proj
 
 <InlineAlert variant="info" slots="text" />
 
-To create Projects for enterprise organizations, you must have a system administrator or developer role with access to the **Adobe Commerce as a Cloud Service – Backend - Commerce Cloud Manager** product. For information on managing developers from the Admin console, see [Managing developers](https://helpx.adobe.com/enterprise/using/manage-developers.html) in the *Adobe Enterprise & Teams Administration Guide*.
+Creating projects for enterprise organizations requires a system administrator or developer role with access to the **Adobe Commerce as a Cloud Service – Backend - Commerce Cloud Manager** product. For information on managing developers from the Admin console, see [Managing developers](https://experienceleague.adobe.com/en/docs/commerce/optimizer/user-management) in the *Adobe Commerce Optimizer Guide*.
 
 1. Log in to the [Adobe Developer Console](https://developer.adobe.com/console).
 
+   You can also access the Developer Console from the **Get Credentials** section of the [Data Ingestion API Reference](https://developer.adobe.com/commerce/services/reference/rest/). If you use this method, you are automatically directed to the correct organization. You can complete the process to create credentials and generate an access token from there.
+
 1. Select the Experience Cloud Organization for the integration.
 
 1. Create an API project.
@@ -22,9 +24,7 @@ To create Projects for enterprise organizations, you must have a system administ
 
 1. Copy the Client ID and the Client Secret values to a secure location.
 
-   - Use the Client ID and Client Secret to refresh expired bearer tokens [using curl].
-
-   - Include the Client ID in the `x-api-key` header to authenticate API requests.
+   You use these values to refresh expired bearer tokens.
 
 1. Get the bearer access token.
 

src/_includes/graphql/endpoints.md

@@ -9,15 +9,15 @@
 
 |  Environment | Endpoint |
 | ------------ | --------:|
-| Testing | `https://na1-sandbox.api.commerce.adobe.com/{{tenant-id}}/graphql` |
-| Production (Not available yet) | `https://na1.api.commerce.adobe.com/{{tenant-id}}/graphql` |
+| Testing | `https://na1-sandbox.api.commerce.adobe.com/{{tenantId}}/graphql` |
+| Production (Not available yet) | `https://na1.api.commerce.adobe.com/{{tenantId}}/graphql` |
 
 **URL structure for SaaS endpoints**
 
 ```text
-https://<region>-<environment-type>.api.commerce.adobe.com/<tenantId>/graphql
+https://{{region}}-{{environment-type}}.api.commerce.adobe.com/{{tenantId}}/graphql
 ```
 
-- `<region>` is the cloud region where your instance is deployed.
-- `<environment-type>` is the environment type, such as `sandbox`. If the environment is production, this value is omitted.
-- `<tenantId>` is the unique identifier for your organization's specific instance within the Adobe Experience Cloud.
+- `{{region}}` is the cloud region where your instance is deployed.
+- `{{environment-type}}` is the environment type, such as `sandbox`. If the environment is production, this value is omitted.
+- `{{tenantId}}` is the unique identifier for your organization's specific instance within the Adobe Experience Cloud.

src/data/navigation/sections/optimizer.js

@@ -16,45 +16,49 @@ module.exports = [
               title: "Get started",
               path: "/optimizer/data-ingestion/using-the-api.md"
             },
-            {
-              title: "API Reference",
-              path: "https://developer.adobe.com/commerce/services/reference/rest/",
-              EventTarget: "_top"
-            }
-          ]
-        },
-        {
-          title: "Retrieve catalog data",
-          path: "/optimizer/merchandising-services/",
-          header: "true",
-          pages: [
-            {
-              title: "Get started",
-              path: "/optimizer/merchandising-services/using-the-api.md"
-            },
-            {
-              title: "Use cases",
-              path: "/optimizer/merchandising-services/use-cases.md"
-            },
-            {
-              title: "Limitations",
-              path: "/optimizer/merchandising-services/limitations.md"
-            },
-            {
-              title: "Monitor and troubleshoot",
-              path: "/optimizer/merchandising-services/troubleshooting.md"
+           {
+              title: "Test API operations",
+              path: "/optimizer/data-ingestion/api-testing.md"
             },
             {
               title: "API Reference",
-              path: "https://developer.adobe.com/commerce/services/reference/graphql/",
+              path: "https://developer.adobe.com/commerce/services/reference/rest/",
               EventTarget: "_top"
             }
           ]
         },
-        {
-          title: "Tutorial",
-          path: "/optimizer/ccdm-use-case.md"
-        }
+      {
+        title: "Retrieve catalog data",
+        path: "/optimizer/merchandising-services/",
+        header: "true",
+        pages: [
+          {
+            title: "Get started",
+            path: "/optimizer/merchandising-services/using-the-api.md"
+          },
+          {
+            title: "Use cases",
+            path: "/optimizer/merchandising-services/use-cases.md"
+          },
+          {
+            title: "Limitations",
+            path: "/optimizer/merchandising-services/limitations.md"
+          },
+          {
+            title: "Monitor and troubleshoot",
+            path: "/optimizer/merchandising-services/troubleshooting.md"
+          },
+          {
+            title: "API Reference",
+            path: "https://developer.adobe.com/commerce/services/reference/graphql/",
+            EventTarget: "_top"
+          }
+        ]
+      },
+      {
+        title: "Tutorial",
+        path: "/optimizer/ccdm-use-case.md"
+      }
     ]
   }
-];
+]

…mages/reporting/aco-instance-details.png …s/merchandising/aco-instance-details.pngsrc/pages/_images/reporting/aco-instance-details.png renamed to src/pages/_images/merchandising/aco-instance-details.png src/pages/_images/reporting/aco-instance-details.png renamed to src/pages/_images/merchandising/aco-instance-details.png

@@ -81,7 +81,7 @@ const GetCredentialOAuthS2s = () => {
 
         <GetCredential.Card.DevConsoleLink heading="Developer Console Project" />
 
-        <GetCredential.Card.AccessToken helpText="" buttonLabel="Generate and copy token" heading={(<>Access token<br/><br/> <span style="font-weight:normal"><small>Paste the access token into the <strong>Authorization</strong> header in the <strong>Try it</strong> panel below. Then, add the <a href="https://developer.adobe.com/commerce/services/optimizer/data-ingestion/using-the-api/#base-url">instance ID</a> to the <strong>instance ID</strong> field. You only need to do this once; future requests reuse the values automatically.</small></span></>)}/>
+        <GetCredential.Card.AccessToken helpText="" buttonLabel="Generate and copy token" heading={(<>Access token<br/><br/> <span style="font-weight:normal"><small>Paste the access token into the <strong>Authorization</strong> header in the <strong>Try it</strong> panel below. Then, add the <a href="https://developer.adobe.com/commerce/services/optimizer/data-ingestion/using-the-api/#base-url">instance ID</a> to the <strong>tenantID</strong> field. You only need to do this once; future requests reuse the values automatically.</small></span></>)}/>
 
         <GetCredential.Card.CredentialDetails heading={(<>Credential details<br/><br/> <span style="font-weight:normal"><small>The following Client ID and Organization ID are used to generate the access token:</small></span></>)} orderBy="ClientId,ImsOrgID">
           <GetCredential.Card.CredentialDetails.ClientId heading="Client ID (x-api-key)" />
@@ -113,7 +113,7 @@ const GetCredentialOAuthS2s = () => {
 
         <GetCredential.Return.ManageDeveloperConsole label="Manage all your projects and credentials on Adobe Developer Console" direction='/console/projects' />
 
-        <GetCredential.Return.AccessToken helpText="" buttonLabel="Generate and copy token" heading={(<>Access token<br/><br/> <span style="font-weight:normal"><small>Paste the access token into the <strong>Authorization</strong> header in the <strong>Try it</strong> panel below. Then, add the <a href="https://developer.adobe.com/commerce/services/optimizer/data-ingestion/using-the-api/#base-url">instance ID</a> to the <strong>instance ID</strong> field. You only need to do this once; future requests reuse the values automatically.</small></span></>)} />
+        <GetCredential.Return.AccessToken helpText="" buttonLabel="Generate and copy token" heading={(<>Access token<br/><br/> <span style="font-weight:normal"><small>Paste the access token into the <strong>Authorization</strong> header in the <strong>Try it</strong> panel below. Then, add the <a href="https://developer.adobe.com/commerce/services/optimizer/data-ingestion/using-the-api/#base-url">instance ID</a> to the <strong>tenantID</strong> field. You only need to do this once; future requests reuse the values automatically.</small></span></>)} />
 
         <GetCredential.Return.DevConsoleLink heading="Developer Console project" />
 

src/pages/credential/GetCredentialOAuthS2s.js

@@ -20,5 +20,5 @@ The [_Adobe Commerce Event SDK_](../shared-services/storefront-events/sdk/) prov
 
 ## Related information
 
-* [Introduction to Live Search](https://experienceleague.adobe.com/docs/commerce-merchant-services/live-search/overview.html?lang=en)
+* [Introduction to Live Search](https://experienceleague.adobe.com/en/docs/commerce/live-search/overview)
 * [GraphQL queries](https://developer.adobe.com/commerce/webapi/graphql/schema/live-search/)

src/pages/live-search/index.md

@@ -44,9 +44,9 @@ import GetTenantId from '/src/_includes/authentication/get-tenant-id.md'
 
 Every API request must include a bearer token in the request header:
 
-`Authorization: Bearer {access token}`
+`Authorization: Bearer {{accessToken}}`
 
-The bearer token is generated using the credentials from the Adobe developer project for the API integration. The token is valid for 24 hours. When it expires, use the Adobe developer project credentials to [generate a new one](#generate-a-new-access-token).
+The bearer token is generated using the credentials from the Adobe developer project for the API integration. The token is valid for 24 hours. When it expires, use the Adobe developer project credentials to generate a new one.
 
 <br></br>
 
@@ -72,7 +72,7 @@ Include the following headers in GraphQL requests.
 | Header Name   | Required |Description |
 |---------------|----------|------------|
 | `Content-Type` | Yes     | Specifies the media type of the resource. Accepted value: `application/json`. |
-| `Authorization: Bearer {access token}`     | Yes      | Bearer token generated from IMS credentials. See [Authentication](#authentication).  |
+| `Authorization: Bearer {{accessToken}}`     | Yes      | Bearer token generated from IMS credentials.|
 
 ## Request template
 
@@ -82,8 +82,8 @@ Use the following template to submit requests using [curl](https://curl.se/), re
 curl --request POST \
   --url https://na1-sandbox.api.commerce.adobe.com/{{tenantId}}/admin/graphql \
   --header "Content-Type: application/json" \
-  --header "Authorization: Bearer {access token}" \
-  --data "{apiPayload}"
+  --header "Authorization: Bearer {{accessToken}}" \
+  --data "{{apiPayload}}"
 ```
 
 For sample requests, see the [tutorial](../ccdm-use-case.md).