docs: added publishable API keys documentation pages #2972
Merged
Conversation
This file contains 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
|
fPolic
reviewed
Jan 9, 2023
Co-authored-by: Frane Polić <16856471+fPolic@users.noreply.github.com>
olivermrbl
reviewed
Jan 10, 2023
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
olivermrbl
approved these changes
Jan 10, 2023
|
|
||
| Currently, publishable API keys can only be associated with sales channels. | ||
|
|
||
| Using the Admin APIs, you can manage your Publishable API Keys. |
There was a problem hiding this comment.
suggestion(non-blocking): Omit this as this is trivial
Suggested change
| Using the Admin APIs, you can manage your Publishable API Keys. |
|
|
||
| Taking Sales Channels as an example, you have to pass the Sales Channel’s ID as a query parameter to all the necessary endpoints, such as the List Products endpoint. | ||
|
|
||
| As this approach can be error-prone, Publishable API Keys solve this problem. |
There was a problem hiding this comment.
suggestion(non-blocking):
Suggested change
| As this approach can be error-prone, Publishable API Keys solve this problem. | |
| This is a tedious and error-prone process, which is why we introduce Publishable API Keys. |
| }) | ||
| ``` | ||
|
|
||
| Then, the API key will be passed in the header parameter `x-publishable-api-key` of every request. |
There was a problem hiding this comment.
suggestion(non-blocking):
Suggested change
| Then, the API key will be passed in the header parameter `x-publishable-api-key` of every request. | |
| This will add the API key as a header, `x-publishable-api-key`, on all requests. |
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes DOCS-437, DOCS-438, DOCS-440, DOCS-441