generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 23
Data Ingestion REST API playground (staging) #273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 12 commits
Commits
Show all changes
48 commits
Select commit
Hold shift + click to select a range
8aafa44
add server var for tenant ID
jeff-matthews fe2993e
optimize security schemes
jeff-matthews dc22fe3
get credential for openapi specs
jeff-matthews f8cd006
fix: replaced ACCS with ACO
jeff-matthews 5ce556d
fix: long description
jeff-matthews 1e72f8b
Revert "fix: long description"
jeff-matthews 36be64e
move original spec to static dir
jeff-matthews 3686ac9
added stage project template ID for testing
jeff-matthews 314eef9
Merge branch 'develop' into test-playground
jeff-matthews d15772b
Merge branch 'develop' into test-playground
jeff-matthews 58c908b
Delete src/pages/optimizer/data-ingestion/api-reference.md
meker12 a8bd9f0
Delete src/pages/optimizer/merchandising-services/api-reference.md
meker12 4fd9a65
Merge branch 'main' into test-playground
jeff-matthews c6dff73
Merge branch 'main' into test-playground
jeff-matthews ed4a06c
remove unnecessary heading
jeff-matthews 769963d
initial attempt at guidance for retrieving tenant ID
jeff-matthews b2dacea
refine help message for finding tenant ID
jeff-matthews 8f64dc6
remove server description
jeff-matthews 7b05fe1
add styling to tenant ID help
jeff-matthews c70576d
replaced securitySchemes w/ parameters for better UX
jeff-matthews 0800f79
Revert "replaced securitySchemes w/ parameters for better UX"
jeff-matthews 4dd1cef
change target server to stage
jeff-matthews 7b4aa3c
separate bearer auth security from API key and IMS org ID parameters
jeff-matthews 19395dd
replace security scheme with parameters again
jeff-matthews d7491f0
fix: use consistent case
jeff-matthews 440d895
removed api key and IMS org ID headers
jeff-matthews 23481c0
replace credential detail with tenant ID guidance
jeff-matthews 77a5f4e
test: access token heading
jeff-matthews dc663f5
fix: add scopes
jeff-matthews d53a698
fix: restore client ID and IMS org ID (partially)
jeff-matthews 7aa102c
fix: add orderby for client Id and IMS org ID
jeff-matthews 31ccb32
clarify token use
jeff-matthews 452ba01
clarify copy token
jeff-matthews 1a13e23
fix: access token return console error
jeff-matthews 68ee975
fix: credential return for client id
jeff-matthews 4fe3751
simplfy component text
jeff-matthews 0a409bc
fix: remove br tags that render as plaintext
jeff-matthews c178ae7
wordsmithing
jeff-matthews f0b77d0
separate tenant ID from client and org ID
jeff-matthews 5b2b42f
Apply suggestions from code review
jeff-matthews df810ee
Apply suggestions from code review
jeff-matthews 232373a
normalize review suggestions for new and return
jeff-matthews a014f2a
fix: editorial
jeff-matthews 009df3b
fix: case
jeff-matthews 1db7b80
Apply suggestions from code review
jeff-matthews 3707fee
fix: normalize return credential block with review suggestions
jeff-matthews 01fdc04
fix: normalize return credential block with review suggestions
jeff-matthews e100548
fix: remove redundant sentence
jeff-matthews File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| 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="6887db51a6867b6202ef2f9c" productName='Adobe Commerce Optimizer' > | ||
|
|
||
| <GetCredential.SignIn title="Get credentials" paragraph="After signing in, you can create credentials that can be used to call the Commerce APIs." buttonText="Sign in" /> | ||
|
|
||
| <GetCredential.Form title="Get credentials" paragraph="Create credentials that you can use to call the Commerce APIs." 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> | ||
| </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.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/webapi/rest/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>After copying the access token, you must prepend the token with <code>Bearer</code> to use it with API calls.</small></span></>)} /> | ||
|
|
||
|
|
||
| <GetCredential.Card.CredentialDetails heading={(<>Credential details<br/><br/> <span style="font-weight:normal"><small>You can use the following credential details to try out the Adobe Commerce Optimizer REST API below.<ul><li>Client ID: Your public identifier for accessing the API. This acts as an API key when used with the Commerce APIs, and corresponds with the <code>x-api-key</code> header.</li><li>Organization ID: The ID of the organization you're using with the Commerce APIs. This corresponds with the <code>x-gw-ims-org-id</code> header.</li></ul></small></span></>)} orderBy="ClientId,ImsOrgID"> | ||
| <GetCredential.Card.CredentialDetails.ClientId heading="Client ID (x-api-key)" /> | ||
| <GetCredential.Card.CredentialDetails.ImsOrgID heading="Organization 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>You can use the following credential details to try out the Adobe Commerce Optimizer REST API below.<ul><li>Client ID: Your public identifier for accessing the API. This acts as an API key when used with the Platform APIs, and corresponds with the <code>x-api-key</code> header.</li><li>Organization ID: The ID of the organization you're using with the Commerce APIs. This corresponds with the <code>x-gw-ims-org-id</code> header.</li></ul></small></span></>)} orderBy="ClientId,ImsOrgID"> | ||
jeff-matthews marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| <GetCredential.Return.CredentialDetails.ClientId heading="Client ID (x-api-key)" /> | ||
| <GetCredential.Return.CredentialDetails.ImsOrgID heading="Organization 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>After copying the access token, you must prepend the token with <code>Bearer</code> to use it with API calls.</small></span></>)} /> | ||
jeff-matthews marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <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; | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
src/pages/optimizer/merchandising-services/api-reference.md
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.