Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
8aafa44
add server var for tenant ID
jeff-matthews Jul 17, 2025
fe2993e
optimize security schemes
jeff-matthews Jul 17, 2025
dc22fe3
get credential for openapi specs
jeff-matthews Jul 18, 2025
f8cd006
fix: replaced ACCS with ACO
jeff-matthews Jul 18, 2025
5ce556d
fix: long description
jeff-matthews Jul 18, 2025
1e72f8b
Revert "fix: long description"
jeff-matthews Jul 18, 2025
36be64e
move original spec to static dir
jeff-matthews Jul 18, 2025
3686ac9
added stage project template ID for testing
jeff-matthews Jul 28, 2025
314eef9
Merge branch 'develop' into test-playground
jeff-matthews Jul 28, 2025
d15772b
Merge branch 'develop' into test-playground
jeff-matthews Jul 29, 2025
58c908b
Delete src/pages/optimizer/data-ingestion/api-reference.md
meker12 Aug 1, 2025
a8bd9f0
Delete src/pages/optimizer/merchandising-services/api-reference.md
meker12 Aug 1, 2025
4fd9a65
Merge branch 'main' into test-playground
jeff-matthews Aug 4, 2025
c6dff73
Merge branch 'main' into test-playground
jeff-matthews Aug 4, 2025
ed4a06c
remove unnecessary heading
jeff-matthews Aug 4, 2025
769963d
initial attempt at guidance for retrieving tenant ID
jeff-matthews Aug 4, 2025
b2dacea
refine help message for finding tenant ID
jeff-matthews Aug 4, 2025
8f64dc6
remove server description
jeff-matthews Aug 4, 2025
7b05fe1
add styling to tenant ID help
jeff-matthews Aug 4, 2025
c70576d
replaced securitySchemes w/ parameters for better UX
jeff-matthews Aug 4, 2025
0800f79
Revert "replaced securitySchemes w/ parameters for better UX"
jeff-matthews Aug 4, 2025
4dd1cef
change target server to stage
jeff-matthews Aug 4, 2025
7b4aa3c
separate bearer auth security from API key and IMS org ID parameters
jeff-matthews Aug 4, 2025
19395dd
replace security scheme with parameters again
jeff-matthews Aug 4, 2025
d7491f0
fix: use consistent case
jeff-matthews Aug 4, 2025
440d895
removed api key and IMS org ID headers
jeff-matthews Aug 5, 2025
23481c0
replace credential detail with tenant ID guidance
jeff-matthews Aug 5, 2025
77a5f4e
test: access token heading
jeff-matthews Aug 5, 2025
dc663f5
fix: add scopes
jeff-matthews Aug 5, 2025
d53a698
fix: restore client ID and IMS org ID (partially)
jeff-matthews Aug 5, 2025
7aa102c
fix: add orderby for client Id and IMS org ID
jeff-matthews Aug 5, 2025
31ccb32
clarify token use
jeff-matthews Aug 5, 2025
452ba01
clarify copy token
jeff-matthews Aug 5, 2025
1a13e23
fix: access token return console error
jeff-matthews Aug 5, 2025
68ee975
fix: credential return for client id
jeff-matthews Aug 5, 2025
4fe3751
simplfy component text
jeff-matthews Aug 5, 2025
0a409bc
fix: remove br tags that render as plaintext
jeff-matthews Aug 5, 2025
c178ae7
wordsmithing
jeff-matthews Aug 5, 2025
f0b77d0
separate tenant ID from client and org ID
jeff-matthews Aug 5, 2025
5b2b42f
Apply suggestions from code review
jeff-matthews Aug 6, 2025
df810ee
Apply suggestions from code review
jeff-matthews Aug 6, 2025
232373a
normalize review suggestions for new and return
jeff-matthews Aug 6, 2025
a014f2a
fix: editorial
jeff-matthews Aug 6, 2025
009df3b
fix: case
jeff-matthews Aug 6, 2025
1db7b80
Apply suggestions from code review
jeff-matthews Aug 6, 2025
3707fee
fix: normalize return credential block with review suggestions
jeff-matthews Aug 6, 2025
01fdc04
fix: normalize return credential block with review suggestions
jeff-matthews Aug 6, 2025
e100548
fix: remove redundant sentence
jeff-matthews Aug 6, 2025
e5696e5
Merge pull request #273 from AdobeDocs/test-playground
jeff-matthews Aug 6, 2025
c1960e8
fix: set default content type
jeff-matthews Aug 7, 2025
033a166
Merge pull request #285 from AdobeDocs/updates-for-prod
jeff-matthews Aug 7, 2025
ceb39f9
feat: replace staging template ID and server URL with production sandbox
jeff-matthews Aug 7, 2025
b19e8d2
Merge pull request #286 from AdobeDocs/replace-stage-with-prod
jeff-matthews Aug 7, 2025
27f946a
fix: normalize references to tenant ID (instance ID)
jeff-matthews Aug 7, 2025
364112c
Merge pull request #287 from AdobeDocs/tenant-vs-instance
jeff-matthews Aug 7, 2025
297d457
fix: captialization
jeff-matthews Aug 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/_includes/authentication/get-tenant-id.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
From Cloud Manager, you can find your tenant ID in the instance detailLs for your Commerce Optimizer project.
From Cloud Manager, you can find your instance ID in the instance detailLs 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 tenant ID, click the information icon next to the Adobe Commerce Optimizer instance name.
1. To get the 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 tenant ID and other instance information. The tenant ID is displayed in the `Instance ID` field.
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 tenant ID from the access URL for the Adobe Commerce Optimizer application interface, the value is in the path, for example `/in:XDevkG9W6UbwgQmPn995r3/`.
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/`.

<InlineAlert variant="info" slots="text" />

Expand Down
26 changes: 0 additions & 26 deletions src/openapi/.redocly.yaml

This file was deleted.

173 changes: 173 additions & 0 deletions src/pages/credential/GetCredentialOAuthS2s.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
import React from 'react'
import { GetCredential } from '@adobe/gatsby-theme-aio/src/components/GetCredential';
import commerce from "./images/commerce.svg";

const GetCredentialOAuthS2s = () => {

return (

<GetCredential className="getCredentialContainer" templateId="6887db9dbaf36ca1f2c4539b" productName='Adobe Commerce Optimizer' >

<GetCredential.SignIn title="Get credentials" paragraph="After signing in, you can create credentials that can be used to call the Catalog Data Ingestion REST API." buttonText="Sign in" />

<GetCredential.Form title="Get credentials" paragraph="Create credentials that you can use to call the Catalog Data Ingestion REST API. You also need the sandbox instance ID to call the API." className="formClass">

<GetCredential.Form.CredentialName label="Credential name" description="The credential name must be unique, use alphanumeric characters, and between 6 and 45 characters long. A project will be automatically created with the same name in Adobe Developer Console." range="45" />

<GetCredential.Form.Products label="Included products and services">
<GetCredential.Form.Product label="Adobe Commerce Optimizer" icon={commerce} />
</GetCredential.Form.Products>

<GetCredential.Form.AdobeDeveloperConsole label='By checking this box, you agree to' linkText="Adobe Developer Terms of Use" href="https://wwwimages2.adobe.com/content/dam/cc/en/legal/servicetou/Adobe-Developer-Additional-Terms_en-US_20230822.pdf" />

<GetCredential.Form.Side>
<div style={{ display: "flex", gap: "32px", flexDirection: "column" }}>
<div style={{ display: "flex", gap: "16px", flexDirection: "column" }}>
<h3 className="spectrum-Heading spectrum-Heading--sizeS side-header">
OAuth server-to-server credential
</h3>
<p className="spectrum-Body spectrum-Body--sizeM">
This credential allows you to use industry standard OAuth2.0 libraries to generate access tokens using the OAuth 2.0 client credentials grant type.
</p>
<p className="spectrum-Body spectrum-Body--sizeM">
This credential only provides an access token. It does not return the instance ID associated with your Adobe Commerce Optimizer sandbox environment, which is required for API calls. In addition to the access token, you must manually copy and paste a instance ID from the Commerce Cloud Manager into the <code>tenantID</code> field in the <strong>Try it</strong> panel below. See the <a href="https://developer.adobe.com/commerce/services/optimizer/data-ingestion/using-the-api/">Get started</a> documentation for help finding your instance ID.
</p>
</div>
<div style={{ display: "flex", gap: "16px", flexDirection: "column" }}>
<h3 className="spectrum-Heading spectrum-Heading--sizeS side-header">
Learn more
</h3>
<a style={{ color: "#0265DC" }} href="https://developer.adobe.com/commerce/services/optimizer/data-ingestion/authentication/">
Authentication documentation
</a>
</div>
</div>
</GetCredential.Form.Side>

</GetCredential.Form>

<GetCredential.UnknownError helpLink="https://some_help_link" helpLinkText="Get Help" className="unKnownError" />

<GetCredential.Card title="Your credential is ready to use" developerConsoleManage="Manage on Developer Console" className="card_developer_console" devConsoleDirection="/console" isCollapsable="true">

<GetCredential.Card.Side>
<div style={{ display: "flex", gap: "32px", flexDirection: "column" }}>
<div style={{ display: "flex", gap: "16px", flexDirection: "column" }}>
<h3 className="spectrum-Heading spectrum-Heading--sizeS side-header">
OAuth server-to-server credential
</h3>
<p className="spectrum-Body spectrum-Body--sizeM">
This credential allows you to use industry standard OAuth2.0 libraries to generate access tokens using the OAuth 2.0 client credentials grant type.
</p>
</div>
<div style={{ display: "flex", gap: "16px", flexDirection: "column" }}>
<h3 className="spectrum-Heading spectrum-Heading--sizeS side-header">
Learn more
</h3>
<a style={{ color: "#0265DC" }} href="https://developer.adobe.com/commerce/services/optimizer/data-ingestion/authentication/">
Authentication documentation
</a>
</div>
</div>
</GetCredential.Card.Side>

<GetCredential.Card.Products label="Included products and services">
<GetCredential.Card.Product label="Adobe Commerce Optimizer" icon={commerce} />
</GetCredential.Card.Products>

<GetCredential.Card.ProjectsDropdown label="Projects" subHeading="Only your projects that contain credentials are shown" />

<GetCredential.Card.ManageDeveloperConsole label="Manage all your projects and credentials on Adobe Developer Console" direction='/console' />

<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.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)" />
<GetCredential.Card.CredentialDetails.ImsOrgID heading="Organization ID (x-gw-ims-org-id)" />
<GetCredential.Card.CredentialDetails.Scopes heading="Scopes" scope="openid,session,AdobeID,read_organizations,additional_info.projectedProductContext" />
</GetCredential.Card.CredentialDetails>

</GetCredential.Card>

<GetCredential.Return title="Previously created projects" paragraph="Select a project and access your existing credentials for Adobe Commerce Optimizer." className="card_developer_console" isCollapsable="true">

<GetCredential.Return.Side>
<GetCredential.Return.Side.Custom>
<div style={{ display: "flex", gap: "30px", flexDirection: "column", width: "100%" }}>
<h3 className='spectrum-Heading spectrum-Heading--sizeM'>Welcome back</h3>
<p className="spectrum-Body spectrum-Body--sizeM">You can either re-use an existing credential or create a new credential.</p>
</div>
</GetCredential.Return.Side.Custom>
<GetCredential.Return.Side.NewCredential heading="Need another credential?" buttonLabel="Create new credential" />
</GetCredential.Return.Side>

<GetCredential.Return.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.Return.CredentialDetails.ClientId heading="Client ID (x-api-key)" />
<GetCredential.Return.CredentialDetails.ImsOrgID heading="Organization ID (x-gw-ims-org-id)" />
<GetCredential.Return.CredentialDetails.Scopes heading="Scopes" scope="openid,session,AdobeID,read_organizations,additional_info.projectedProductContext" />
</GetCredential.Return.CredentialDetails>

<GetCredential.Return.ProjectsDropdown label="Projects" subHeading="Only your projects that contain credentials are shown" />

<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.DevConsoleLink heading="Developer Console project" />

<GetCredential.Return.Products label="Included products and services">
<GetCredential.Return.Product label="Adobe Commerce Optimizer" icon={commerce} />
</GetCredential.Return.Products>

</GetCredential.Return>

<GetCredential.RequestAccess
title="Get credentials"
paragraph="Create unique credentials that you will use to call multiple APIs from your application."
>
<GetCredential.RequestAccess.EdgeCase>
<GetCredential.RequestAccess.EdgeCase.NoProduct title="Your organization does not have access to Adobe Commerce Optimizer." />
<GetCredential.RequestAccess.EdgeCase.Type1User title="You do not have access to Adobe Commerce Optimizer. Please use another organization and try again." />
<GetCredential.RequestAccess.EdgeCase.NotMember title="You do not have access to Adobe Commerce Optimizer. Please use another organization and try again." />
</GetCredential.RequestAccess.EdgeCase>

<GetCredential.RequestAccess.RestrictedAccess
title="Restricted Access"
buttonLabel="Request access"
>
<GetCredential.RequestAccess.RestrictedAccess.Products label="Included products and services">
<GetCredential.RequestAccess.RestrictedAccess.Products.Product
icon={commerce}
label="Adobe Commerce Optimizer"
/>
</GetCredential.RequestAccess.RestrictedAccess.Products>
</GetCredential.RequestAccess.RestrictedAccess>
<GetCredential.RequestAccess.RequestAccessSide>
<div style={{ display: "flex", gap: "32px", flexDirection: "column" }}>
<div style={{ display: "flex", gap: "16px", flexDirection: "column" }}>
<h3 className="spectrum-Heading spectrum-Heading--sizeS side-header">
OAuth server-to-server credential
</h3>
<p className="spectrum-Body spectrum-Body--sizeM">
This credential allows you to use industry standard OAuth2.0 libraries to generate access tokens using the OAuth 2.0 client credentials grant type.
</p>
</div>
<div style={{ display: "flex", gap: "16px", flexDirection: "column" }}>
<h3 className="spectrum-Heading spectrum-Heading--sizeS side-header">
Learn more
</h3>
<a style={{ color: "#0265DC" }} href="https://developer.adobe.com/commerce/webapi/rest/authentication/">
Authentication documentation
</a>
</div>
</div>
</GetCredential.RequestAccess.RequestAccessSide>
</GetCredential.RequestAccess>
</GetCredential>

)
}

export default GetCredentialOAuthS2s;
1 change: 1 addition & 0 deletions src/pages/credential/images/commerce.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/pages/optimizer/admin/using-the-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The URL structure is:
&NewLine; <!--Add space between the collapsible section and the previous paragraph-->

<details>
<summary><b>Get your tenant ID</b></summary>
<summary><b>Get your instance ID</b></summary>

import GetTenantId from '/src/_includes/authentication/get-tenant-id.md'

Expand Down
9 changes: 0 additions & 9 deletions src/pages/optimizer/data-ingestion/api-reference.md

This file was deleted.

2 changes: 1 addition & 1 deletion src/pages/optimizer/data-ingestion/using-the-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The URL structure is:
&NewLine; <!--Add space between the collapsible section and the previous paragraph-->

<details>
<summary><b>Get your tenant ID</b></summary>
<summary><b>Get your instance ID</b></summary>

import GetTenantId from '/src/_includes/authentication/get-tenant-id.md'

Expand Down
11 changes: 0 additions & 11 deletions src/pages/optimizer/merchandising-services/api-reference.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When building dynamic storefronts with the Merchandising GraphQL API, it's essen

## Common Issues

- **Authentication Errors**: Verify that the tenant ID used in the endpoint URL to ensure it matches the tenant ID in your Adobe Commerce Optimizer instance.
- **Authentication Errors**: Verify that the instance ID used in the endpoint URL to ensure it matches the instance ID in your Adobe Commerce Optimizer instance.
- **Missing Data**: Ensure products are properly ingested via the Data Ingestion API. You can check the synchronization status for product data from the [Data Sync page](https://experienceleague.adobe.com/en/docs/commerce/optimizer/setup/data-sync) in Adobe Commerce Optimizer.
- **Performance Issues**: Optimize queries and implement caching.
- **Rate Limiting**: Monitor API usage and implement proper throttling.
Expand Down
8 changes: 4 additions & 4 deletions src/pages/optimizer/merchandising-services/using-the-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Use the Merchandising API to retrieve product data from your Commerce catalogs a

Before using the Merchandising API, ensure you have:

- **Adobe Commerce Optimizer Access**: Active subscription and the tenant ID associated with your Adobe Commerce Optimizer instance
- **Adobe Commerce Optimizer Access**: Active subscription and the instance ID associated with your Adobe Commerce Optimizer instance
- **Catalog Data**: Products and pricing data ingested via the [Data Ingestion API](../data-ingestion/index.md)
- **Catalog Views**: Configured views and policies in Adobe Commerce Optimizer
- **Authentication Setup**: Proper headers configured for API requests
Expand Down Expand Up @@ -48,7 +48,7 @@ The URL structure is:
&NewLine; <!--Add space between the collapsible section and the previous paragraph-->

<details>
<summary><b>Get your tenant ID</b></summary>
<summary><b>Get your instance ID</b></summary>

import GetTenantId from '/src/_includes/authentication/get-tenant-id.md'

Expand Down Expand Up @@ -100,9 +100,9 @@ Get the values for catalog view, policy, catalog source locale, and price book d

To get started with the Merchandising API, follow these steps to make your first request:

1. Get values for the tenant ID and required headers.
1. Get values for the instance ID and required headers.

- `tenantId`: Your unique tenant ID for Adobe Commerce Optimizer
- `tenantId`: Your unique instance ID for Adobe Commerce Optimizer
- `AC-View-ID`: Catalog view ID from Adobe Commerce Optimizer
- `AC-Source-Locale`: Locale for data filtering (for example, `en-US`, `en-GB`)

Expand Down
6 changes: 4 additions & 2 deletions src/pages/reference/rest/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ keywords:
layout: none
---

# API Reference
import GetCredentialOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.js'

<RedoclyAPIBlock src="https://raw.githubusercontent.com/AdobeDocs/commerce-services/refs/heads/main/src/openapi/data-ingestion-schema-v1.yaml" scrollYOffset={64} hideTryItPanel="true" nativeScrollbars="true" />
<GetCredentialOAuthS2s />

<RedoclyAPIBlock src='/commerce/services/rest/data-ingestion-schema-v1.yaml' hideLoading />
File renamed without changes.
Loading