Merge branch 'master' into develop

This commit is contained in:
olivermrbl
2023-01-11 16:46:32 +01:00
44 changed files with 1103 additions and 224 deletions
+42 -36
View File
@@ -12314,7 +12314,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId,
medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId,
{
sales_channel_ids: [
{
@@ -12330,7 +12330,7 @@ paths:
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \
--header 'Authorization: Bearer {api_token}' \
@@ -12398,7 +12398,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId,
medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId,
{
sales_channel_ids: [
{
@@ -12414,7 +12414,7 @@ paths:
label: cURL
source: >
curl --location --request DELETE
'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \
--header 'Authorization: Bearer {api_token}' \
@@ -12475,19 +12475,26 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.create()
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
medusa.admin.publishableApiKeys.create({
title
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
- lang: Shell
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-keys' \
--header 'Authorization: Bearer {api_token}'
--header 'Authorization: Bearer {api_token}' \
-d '{ "created_by": "user_123" }'
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Web API Key"
}'
security:
- api_token: []
- cookie_auth: []
@@ -12560,7 +12567,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.list()
.then(({ publishable_api_keys }) => {
.then(({ publishable_api_keys, count, limit, offset }) => {
console.log(publishable_api_keys)
})
- lang: Shell
@@ -12622,15 +12629,16 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.delete(key_id)
.then(({ id, object, deleted }) => {
console.log(id)
})
medusa.admin.publishableApiKeys.delete(publishableApiKeyId)
.then(({ id, object, deleted }) => {
console.log(id)
})
- lang: Shell
label: cURL
source: >
curl --location --request DELETE
'https://medusa-url.com/admin/publishable-api-key/{id}' \
'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
--header 'Authorization: Bearer {api_token}'
security:
@@ -12682,19 +12690,18 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.retrieve(pubKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
- lang: Shell
label: cURL
source: >
curl --location --request GET
'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'
security:
- api_token: []
- cookie_auth: []
@@ -12752,14 +12759,14 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.listSalesChannels()
.then(({ sales_channels, limit, offset, count }) => {
console.log(sales_channels)
.then(({ sales_channels }) => {
console.log(sales_channels.length)
})
- lang: Shell
label: cURL
source: >
curl --location --request GET
'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels'
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels'
\
--header 'Authorization: Bearer {api_token}'
@@ -12815,7 +12822,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.revoke()
medusa.admin.publishableApiKeys.revoke(publishableApiKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
@@ -12823,12 +12830,10 @@ paths:
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke'
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke'
\
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123", "revoked_by": "user_123" }'
security:
- api_token: []
- cookie_auth: []
@@ -12886,24 +12891,25 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.update(publishable_key_id, {
medusa.admin.publishableApiKeys.update(publishableApiKeyId, {
title: "new title"
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
- lang: Shell
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-key/{id}' \
'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "updated title"
"title": "new title"
}'
security:
- api_token: []
+42 -36
View File
@@ -12314,7 +12314,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId,
medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId,
{
sales_channel_ids: [
{
@@ -12330,7 +12330,7 @@ paths:
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \
--header 'Authorization: Bearer {api_token}' \
@@ -12398,7 +12398,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId,
medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId,
{
sales_channel_ids: [
{
@@ -12414,7 +12414,7 @@ paths:
label: cURL
source: >
curl --location --request DELETE
'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \
--header 'Authorization: Bearer {api_token}' \
@@ -12475,19 +12475,26 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.create()
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
medusa.admin.publishableApiKeys.create({
title
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
- lang: Shell
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-keys' \
--header 'Authorization: Bearer {api_token}'
--header 'Authorization: Bearer {api_token}' \
-d '{ "created_by": "user_123" }'
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Web API Key"
}'
security:
- api_token: []
- cookie_auth: []
@@ -12560,7 +12567,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.list()
.then(({ publishable_api_keys }) => {
.then(({ publishable_api_keys, count, limit, offset }) => {
console.log(publishable_api_keys)
})
- lang: Shell
@@ -12622,15 +12629,16 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.delete(key_id)
.then(({ id, object, deleted }) => {
console.log(id)
})
medusa.admin.publishableApiKeys.delete(publishableApiKeyId)
.then(({ id, object, deleted }) => {
console.log(id)
})
- lang: Shell
label: cURL
source: >
curl --location --request DELETE
'https://medusa-url.com/admin/publishable-api-key/{id}' \
'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
--header 'Authorization: Bearer {api_token}'
security:
@@ -12682,19 +12690,18 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.retrieve(pubKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
- lang: Shell
label: cURL
source: >
curl --location --request GET
'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'
security:
- api_token: []
- cookie_auth: []
@@ -12752,14 +12759,14 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.listSalesChannels()
.then(({ sales_channels, limit, offset, count }) => {
console.log(sales_channels)
.then(({ sales_channels }) => {
console.log(sales_channels.length)
})
- lang: Shell
label: cURL
source: >
curl --location --request GET
'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels'
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels'
\
--header 'Authorization: Bearer {api_token}'
@@ -12815,7 +12822,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.revoke()
medusa.admin.publishableApiKeys.revoke(publishableApiKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
@@ -12823,12 +12830,10 @@ paths:
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke'
'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke'
\
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123", "revoked_by": "user_123" }'
security:
- api_token: []
- cookie_auth: []
@@ -12886,24 +12891,25 @@ paths:
// must be previously logged in or use api token
medusa.admin.publishableApiKey.update(publishable_key_id, {
medusa.admin.publishableApiKeys.update(publishableApiKeyId, {
title: "new title"
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
- lang: Shell
label: cURL
source: >
curl --location --request POST
'https://medusa-url.com/admin/publishable-api-key/{id}' \
'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "updated title"
"title": "new title"
}'
security:
- api_token: []
@@ -1,9 +1,9 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKey.update(publishable_key_id, {
medusa.admin.publishableApiKeys.update(publishableApiKeyId, {
title: "new title"
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
@@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.list()
.then(({ publishable_api_keys }) => {
.then(({ publishable_api_keys, count, limit, offset }) => {
console.log(publishable_api_keys)
})
@@ -1,7 +1,9 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKey.create()
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
medusa.admin.publishableApiKeys.create({
title
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKey.delete(key_id)
.then(({ id, object, deleted }) => {
console.log(id)
})
medusa.admin.publishableApiKeys.delete(publishableApiKeyId)
.then(({ id, object, deleted }) => {
console.log(id)
})
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKey.retrieve(pubKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
medusa.admin.publishableApiKeys.retrieve(publishableApiKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKey.revoke()
medusa.admin.publishableApiKeys.revoke(publishableApiKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
@@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.listSalesChannels()
.then(({ sales_channels, limit, offset, count }) => {
console.log(sales_channels)
.then(({ sales_channels }) => {
console.log(sales_channels.length)
})
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.removeSalesChannels(publishableApiKeyId, {
medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId, {
sales_channel_ids: [
{
id: channel_id
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.publishableApiKeys.addSalesChannels(publishableApiKeyId, {
medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId, {
sales_channel_ids: [
{
id: channel_id
@@ -1,6 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{id}' \
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "updated title"
"title": "new title"
}'
@@ -1,3 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Web API Key"
}'
@@ -1,2 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{id}' \
curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-key/{pka_id}' \
--header 'Authorization: Bearer {api_token}'
@@ -1,3 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123' \
curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123" }'
@@ -1,3 +1,2 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/pubkey_123/revoke' \
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/revoke' \
--header 'Authorization: Bearer {api_token}'
-d '{ "created_by": "user_123", "revoked_by": "user_123" }'
@@ -1,2 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/pk_123/sales-channels' \
curl --location --request GET 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/sales-channels' \
--header 'Authorization: Bearer {api_token}'
@@ -1,4 +1,4 @@
curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
curl --location --request DELETE 'https://medusa-url.com/admin/publishable-api-keys/{pka_id}/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
@@ -1,4 +1,4 @@
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/afasf/batch' \
curl --location --request POST 'https://medusa-url.com/admin/publishable-api-keys/{pak_id}/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
@@ -122,6 +122,9 @@ medusa.admin.customers.create({
fetch(`<SERVER_URL>/admin/customers`, {
method: "POST",
credentials: "include",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
email,
password,
@@ -191,6 +194,9 @@ medusa.admin.customers.update(customerId, {
fetch(`<SERVER_URL>/admin/customers/${customerId}`, {
method: "POST",
credentials: "include",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
first_name,
}),
@@ -0,0 +1,531 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Manage Publishable API Keys
In this document, youll learn how to manage the publishable API keys using the admin APIs.
## Overview
Publishable API keys allow you to associate a set of resources with an API key. You can then pass that API key in storefront requests to guarantee that processed or returned data is within the scope you defined when creating the API key.
Currently, publishable API keys can only be associated with sales channels.
Using the Admin APIs, you can manage your Publishable API Keys.
:::note
Publishable API keys are only for client-side use. They can be publicly accessible in your code, as they are not authorized for the Admin API.
:::
### Scenario
You want to use or implement the following admin functionalities:
- Manage publishable keys including listing, creating, updating, and deleting them.
- Manage sales channels associated with a publishable API key including listing, adding, and deleting them from the publishable API key.
---
## Prerequisites
### Medusa Components
It is assumed that you already have a Medusa server installed and set up. If not, you can follow the [quickstart guide](../../quickstart/quick-start.mdx) to get started.
### JS Client
This guide includes code snippets to send requests to your Medusa server using Medusas JS Client, JavaScripts Fetch API, or cURL.
If you follow the JS Client code blocks, its assumed you already have [Medusas JS Client](../../js-client/overview.md) installed and have [created an instance of the client](../../js-client/overview.md#configuration).
### Authenticated Admin User
You must be an authenticated admin user before following along with the steps in the tutorial.
You can learn more about [authenticating as an admin user in the API reference](/api/admin/#section/Authentication).
---
## List Publishable API Keys
You can retrieve a list of publishable API keys by sending a request to the [List Publishable API Keys](/api/admin/#tag/PublishableApiKey/operation/GetPublishableApiKeys) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.list()
.then(({ publishable_api_keys, count, limit, offset }) => {
console.log(publishable_api_keys)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```ts
fetch(`<SERVER_URL>/admin/publishable-api-keys`, {
credentials: "include",
})
.then((response) => response.json())
.then(({ publishable_api_keys, count, limit, offset }) => {
console.log(publishable_api_keys)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X GET '<SERVER_URL>/admin/publishable-api-keys' \
-H 'Authorization: Bearer <API_TOKEN>'
```
</TabItem>
</Tabs>
This request does not require any path parameters. You can pass it optional query parameters related to expanding fields and pagination, which you can check out in the [API reference](/api/admin/#tag/PublishableApiKey/operation/GetPublishableApiKeys).
This request returns the following data in the response:
- `publishable_api_keys`: An array of publishable API keys.
- `limit`: The maximum number of keys that can be returned.
- `offset`: The number of keys skipped in the result.
- `count`: The total number of keys available.
:::note
You can learn more about pagination in the [API reference](/api/admin/#section/Pagination).
:::
---
## Create a Publishable API Key
You can create a publishable API key by sending a request to the [Create Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKeys) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.create({
title: "Web API Key",
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```ts
fetch(`<SERVER_URL>/admin/publishable-api-keys`, {
method: "POST",
credentials: "include",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
title: "Web API Key",
}),
})
.then((response) => response.json())
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X POST '<SERVER_URL>/admin/publishable-api-keys' \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
"title": "Web API Key"
}'
```
</TabItem>
</Tabs>
This request requires a body parameter `title`, which is the title of the Publishable API Key.
It returns the created publishable API key in the response.
---
## Update a Publishable API Key
You can update a publishable API keys details by sending a request to the [Update Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKysPublishableApiKey) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.update(publishableApiKeyId, {
title: "Web API Key",
})
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```ts
fetch(`<SERVER_URL>/admin/publishable-api-keys/${publishableApiKeyId}`, {
method: "POST",
credentials: "include",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
title: "Web API Key",
}),
})
.then((response) => response.json())
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X POST '<SERVER_URL>/admin/publishable-api-keys/<PUBLISHABLE_API_KEY>' \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
"title": "Web API Key"
}'
```
</TabItem>
</Tabs>
This request requires the ID of the publishable API key as a path parameter. In its body, it optionally accepts the new `title` of the publishable API key.
This request returns the update publishable API key object in the response.
---
## Revoke a Publishable API Key
Revoking a publishable API key does not remove it, but does not allow using it in future requests.
You can revoke a publishable API key by sending a request to the [Revoke Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKeysPublishableApiKeyRevoke) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.revoke(publishableApiKeyId)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```ts
fetch(
`<SERVER_URL>/admin/publishable-api-keys/${publishableApiKeyId}/revoke`,
{
method: "POST",
credentials: "include",
}
)
.then((response) => response.json())
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X POST '<SERVER_URL>/admin/publishable-api-keys/<PUBLISHABLE_API_KEY>/revoke' \
-H 'Authorization: Bearer <API_TOKEN>'
```
</TabItem>
</Tabs>
This request requires the ID of the publishable API key as a path parameter. It returns the updated publishable API key in the response.
---
## Delete a Publishable API Key
You can delete a publishable API key by sending a request to the [Delete Publishable API Key](/api/admin/#tag/PublishableApiKey/operation/DeletePublishableApiKeysPublishableApiKey) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.delete(publishableApiKeyId)
.then(({ id, object, deleted }) => {
console.log(id)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```ts
fetch(`<SERVER_URL>/admin/publishable-api-keys/${publishableApiKeyId}`, {
method: "DELETE",
credentials: "include",
})
.then((response) => response.json())
.then(({ id, object, deleted }) => {
console.log(id)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X DELETE '<SERVER_URL>/admin/publishable-api-keys/<PUBLISHABLE_API_KEY>' \
-H 'Authorization: Bearer <API_TOKEN>'
```
</TabItem>
</Tabs>
This request requires the ID of the publishable API key as a path parameter.
It returns the following data in the response:
- `id`: The ID of the deleted publishable API key.
- `object`: A string indicating the type of object deleted. By default, its value is `publishable_api_key`.
- `deleted`: A boolean value indicating whether the publishable API key was deleted or not.
---
## Manage Sales Channels of Publishable API Keys
This section covers how to manage sales channels in a publishable API key. This doesnt affect sales channels and their data, only its association with the publishable API key.
### List Sales Channels of a Publishable API Key
You can retrieve the list of sales channels associated with a publishable API key by sending a request to the [List Sales Channels](/api/admin/#tag/PublishableApiKey/operation/GetPublishableApiKeySalesChannels) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.listSalesChannels(publishableApiKeyId)
.then(({ sales_channels }) => {
console.log(sales_channels)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
<!-- eslint-disable max-len -->
```ts
fetch(
`<SERVER_URL>/admin/publishable-api-keys/${publishableApiKeyId}/sales-channels`,
{
credentials: "include",
}
)
.then((response) => response.json())
.then(({ sales_channels }) => {
console.log(sales_channels)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X GET '<SERVER_URL>/admin/publishable-api-keys/<PUBLISHABLE_API_KEY>/sales-channels' \
-H 'Authorization: Bearer <API_TOKEN>'
```
</TabItem>
</Tabs>
This request requires the ID of the publishable API key as a path parameter.
It returns an array of sales channels associated with the publishable API key in the response.
### Add Sales Channels to Publishable API Key
You can add a sales channel to a publishable API key by sending a request to the [Add Sales Channels](/api/admin/#tag/PublishableApiKey/operation/PostPublishableApiKeySalesChannelsChannelsBatch) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.addSalesChannelsBatch(
publishableApiKeyId,
{
sales_channel_ids: [
{
id: salesChannelId,
},
],
}
)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
<!-- eslint-disable max-len -->
```ts
fetch(
`<SERVER_URL>/admin/publishable-api-keys/${publishableApiKeyId}/sales-channels/batch`,
{
method: "POST",
credentials: "include",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
sales_channel_ids: [
{
id: salesChannelId,
},
],
}),
}
)
.then((response) => response.json())
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X POST '<SERVER_URL>/admin/publishable-api-keys/<PUBLISHABLE_API_KEY>/sales-channels/batch' \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
"sales_channel_ids": [
{
"id": "<SALES_CHANNEL_ID>"
}
]
}'
```
</TabItem>
</Tabs>
This request requires passing the ID of the publishable API key as a path parameter.
In its body parameters, its required to pass the `sales_channel_ids` array parameter. Each item in the array is an object containing an `id` property, with its value being the ID of the sales channel to add to the publishable API key.
You can add more than one sales channel in the same request by passing each of them as an object in the array.
This request returns the updated publishable API key in the response.
### Delete Sales Channels from a Publishable API Key
You can delete a sales channel from a publishable API key by sending a request to the [Delete Sales Channels](/api/admin/#tag/PublishableApiKey/operation/DeletePublishableApiKeySalesChannelsChannelsBatch) endpoint:
<Tabs groupId="request-type" wrapperClassName="code-tabs">
<TabItem value="client" label="Medusa JS Client" default>
```ts
medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(
publishableApiKeyId,
{
sales_channel_ids: [
{
id: salesChannelId,
},
],
}
)
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
<!-- eslint-disable max-len -->
```ts
fetch(
`<SERVER_URL>/admin/publishable-api-keys/${publishableApiKeyId}/sales-channels/batch`,
{
method: "DELETE",
credentials: "include",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
sales_channel_ids: [
{
id: salesChannelId,
},
],
}),
}
)
.then((response) => response.json())
.then(({ publishable_api_key }) => {
console.log(publishable_api_key.id)
})
```
</TabItem>
<TabItem value="curl" label="cURL">
```bash
curl -L -X DELETE '<SERVER_URL>/admin/publishable-api-keys/<PUBLISHABLE_API_KEY>/sales-channels/batch' \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
--data-raw '{
"sales_channel_ids": [
{
"id": "<SALES_CHANNEL_ID>"
}
]
}'
```
</TabItem>
</Tabs>
This request requires the ID of the publishable API key as a path parameter.
In its body parameters, its required to pass the `sales_channel_ids` array parameter. Each item in the array is an object containing an `id` property, with its value being the ID of the sales channel to delete from the publishable API key.
You can delete more than one sales channel in the same request by passing each of them as an object in the array.
This request returns the updated publishable API key in the response.
---
## See Also
- [Publishable API key overview](../backend/publishable-api-keys/index.md)
- [Publishable API key admin API reference](/api/admin/#tag/PublishableApiKey)
@@ -60,27 +60,7 @@ A basic Medusa server installed with the `medusa new` command has dependencies s
}
```
For a plugin, a lot of these dependencies are not necessary or should be labeled as [peer dependencies](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#peerdependencies). Therefore, its important to make changes to the dependencies of your plugin.
The recommended change is the following:
```json title=package.json
"peerDependencies": {
"@medusajs/medusa": "^1.3.1",
"medusa-interfaces": "^1.3.0",
"typeorm": "^0.2.36"
},
"devDependencies": {
"@babel/cli": "^7.14.3",
"@babel/core": "^7.14.3",
"@babel/preset-typescript": "^7.14.5",
"babel-preset-medusa-package": "^1.1.19",
}
```
The packages `@medusajs/medusa` and `medusa-interfaces` act as peer dependencies. Theyll be installed while you develop your package, and they are required when your plugin is installed in another NPM project.
You remove the packages `medusa-fulfillment-manual`, `medusa-payment-manual`, and `medusa-payment-stripe` as they are fulfillment and payment plugins necessary for a Medusa server, but not for a plugin.
For a plugin, some dependencies are not necessary. You can remove the packages `medusa-fulfillment-manual`, `medusa-payment-manual`, and `medusa-payment-stripe` as they are fulfillment and payment plugins necessary for a Medusa server, but not for a plugin.
Additionally, you remove `@medusajs/medusa-cli` as you dont need to use the Medusa CLI while developing a plugin.
@@ -0,0 +1,111 @@
# Publishable API Keys Overview
In this document, youll learn about Publishable API Keys and their usage.
## Introduction
While using Medusas APIs, you might have to pass some query parameters for certain resources with every or most requests.
Taking Sales Channels as an example, you have to pass the Sales Channels ID as a query parameter to all the necessary endpoints, such as the List Products endpoint.
This is a tedious and error-prone process. This is where Publishable API Keys are useful.
Publishable API Keys can be used to scope API calls with an API key, determining what resources are retrieved when querying the API. Currently, they can be associated only with Sales Channels.
For example, you can associate an API key with a B2B channel, then, on the storefront, retrieve only products available in that channel using the API key.
---
## PublishableApiKey Entity Overview
The `PublishableApiKey` entity represents a publishable API key that is stored in the database. Some of its important attributes include:
- `id`: The ID of the publishable API key. This is the API key youll use in your API requests.
- `created_by`: The ID of the user that created this API key.
- `revoked_by`: The ID of the user that revoked this API key. A revoked publishable API key cannot be used in requests.
---
## Relation to Other Entities
### Sales Channels
A publishable API key can be associated with more than one sales channel, and a sales channel can be associated with more than one publishable API key.
The relation is represented by the entity `PublishableApiKeySalesChannel`.
---
## Using Publishable API Keys in Requests
:::note
Publishable API keys are only for client-side use. They can be publicly accessible in your code, as they are not authorized for the Admin API.
:::
### Using Medusa JS Client
When using [Medusas JS Client](../../../js-client/overview.md), you can pass it to the client only once when you create the instance of the client:
```ts
const medusa = new Medusa({
maxRetries: 3,
baseUrl: "https://api.example.com",
publishableApiKey,
})
```
This will add the API key as in the header parameter `x-publishable-api-key` on all requests.
You can also use the `setPublishableKey` method to set it at a later point:
```ts
const medusa = new Medusa({
// ...
})
// at a later point
medusa.setPublishableKey(publishableApiKey)
```
### Using Medusa React
You can pass the publishable API key to the `MedusaProvider` component:
```tsx
const App = () => {
return (
<MedusaProvider
queryClientProviderProps={{ client: queryClient }}
baseUrl="http://localhost:9000"
// ...
publishableApiKey={publishableApiKey}
>
<MyStorefront />
</MedusaProvider>
)
}
```
Then, the API key will be passed in the header parameter `x-publishable-api-key` of every request.
### Using Other Methods
For other ways of sending requests to your Medusa server, such as using the Fetch API, you must pass `x-publishable-api-key` in the header of every request. Its value is the publishable API keys `id`.
```ts
fetch(`<SERVER_URL>/store/products`, {
credentials: "include",
headers: {
"x-publishable-api-key": publishableApiKey,
},
})
```
---
## See Also
- [How to manage publishable keys as an admin](../../admin/manage-publishable-api-keys.mdx)
- [Publishable API keys admin API reference](/api/admin/#tag/PublishableApiKey)
@@ -2,17 +2,6 @@
In this document, youll learn about Sales Channels and how they can be used in Medusa.
:::note
The Sales Channels feature is currently in beta mode and guarded by a feature flag. To use Sales Channels either:
1. Enable the `MEDUSA_FF_SALES_CHANNELS` environment variable;
2. Or enable the `sales_channels` key in the Medusa server's settings.
You can learn more about enabling it in the [feature flags](../feature-flags/toggle.md) documentation.
:::
## Introduction
Sales Channels allow you to separate between the different channels you sell products in. For example, you can have a sales channel for your website and another for your mobile apps.
@@ -0,0 +1,53 @@
---
description: 'Actions Required for v.1.7.3'
---
# v1.7.3
Version 1.7.3 of Medusa changes the feature flag value for Sales Channels and Publishable API Keys.
## Overview
Sales Channels and Publishable API Keys were introduced in previous versions of Medusa, but guarded by [feature flags](../feature-flags/toggle.md) This meant that developers had to manually enable them to use them.
Version 1.7.3 of Medusa keeps the feature flags for these two features, but theyre now enabled by default. This requires running the necessary migrations to ensure your server works as expected.
---
## Actions Required
### Run Migrations
After updating your Medusa server and before running it, run the following command to run the latest migration:
```bash
medusa migrations run
```
### Run Migration Script for Sales Channels
With the introduction of Sales Channels, products are now associated with them. To avoid inconsistencies with how products are linked to Sales Channels, its strongly recommended to run a migration script before running the Medusa server.
Start by adding the following environment variables:
```bash
TYPEORM_CONNECTION=postgres
TYPEORM_URL=<DATABASE_URL>
TYPEORM_LOGGING=true
TYPEORM_ENTITIES=./node_modules/@medusajs/medusa/dist/models/*.js
TYPEORM_MIGRATIONS=./node_modules/@medusajs/medusa/dist/migrations/*.js
```
Make sure to replace `<DATABASE_URL>` with the connection URL of your database.
Then, run the following command in the root of your Medusa server:
```bash
node ./node_modules/@medusajs/medusa/dist/scripts/sales-channels-migration.js
```
---
## Disabling Feature Flags
Although this version enables Sales Channels and Publishable API Keys by default, you can still turn them off using feature flags. Learn more in [this documentation](../feature-flags/toggle.md#disable-feature-flags)
@@ -11,6 +11,15 @@ In your storefront, you can filter products by sales channels. You can also asso
This guide explains how to perform these operations using the Storefront APIs.
### Alternative Approach: Publishable API keys
This guide covers how to pass the sales channel ID into different requests to retrieve or process data associated with the sales channel.
An alternative approach is to use Publishable API keys. You can learn how to use them in the following documents:
- [Using publishable API keys in requests](../backend/publishable-api-keys/index.md)
- Managing publishable API keys using [admin APIs](../admin/manage-publishable-api-keys.mdx) or using [Medusa Admin](../../user-guide/settings/publishable-api-keys.mdx)
---
## Prerequisites
+19 -19
View File
@@ -20,7 +20,7 @@ Learn about Medusa basic features and kickstart your ecommerce project.
<DocCardList colSize={4} items={[
{
type: 'link',
href: '/quickstart/quick-start',
href: '/usage/create-medusa-app',
label: 'Quickstart Guide',
customProps: {
image: '/img/quickstart-icon.svg',
@@ -30,32 +30,20 @@ Learn about Medusa basic features and kickstart your ecommerce project.
},
{
type: 'link',
href: '/tutorial/set-up-your-development-environment',
label: 'Set up Dev Environment',
href: '/introduction#features',
label: 'Features',
customProps: {
themedImage: {
light: '/img/dev-env-icon.svg',
dark: '/img/dev-env-icon-dark.svg'
},
description: 'Prepare your setup for advanced development.'
}
},
{
type: 'link',
href: '/usage/configurations',
label: 'Configure your Server',
customProps: {
themedImage: {
light: '/img/server-icon.svg',
dark: '/img/server-icon-dark.svg'
},
description: 'Explore Medusa\'s configurations.'
description: 'Learn about Medusa\'s features'
}
},
{
type: 'link',
href: '/starters/nextjs-medusa-starter',
label: 'Next.js Starter',
label: 'Next.js Storefront',
customProps: {
themedImage: {
light: '/img/nextjs-icon.svg',
@@ -67,7 +55,7 @@ Learn about Medusa basic features and kickstart your ecommerce project.
{
type: 'link',
href: '/starters/gatsby-medusa-starter',
label: 'Gatsby Starter',
label: 'Gatsby Storefront',
customProps: {
themedImage: {
light: '/img/gatsby-icon.svg',
@@ -79,7 +67,7 @@ Learn about Medusa basic features and kickstart your ecommerce project.
{
type: 'link',
href: '/admin/quickstart',
label: 'Admin Quickstart Guide',
label: 'Admin Quickstart',
customProps: {
themedImage: {
light: '/img/admin-icon.svg',
@@ -87,6 +75,18 @@ Learn about Medusa basic features and kickstart your ecommerce project.
},
description: 'Install Medusa\'s Admin to manage your store.'
}
},
{
type: 'link',
href: '/user-guide',
label: 'User Guide',
customProps: {
themedImage: {
light: '/img/user-guide.svg',
dark: '/img/user-guide-dark.svg'
},
description: 'Take a look at the features available in Medusa Admin'
}
}
]} />
+8
View File
@@ -39,3 +39,11 @@ Your customers use the Storefront to view products and make orders. Medusa provi
- [Bulk Import](./user-guide/products/import.mdx): Bulk import strategies for different entities including [products](./advanced/admin/import-products.mdx) and [price lists](./advanced/admin/import-prices.mdx).
- [Bulk Export](./user-guide/products/export.mdx): Bulk export strategies for different entities including [products](./user-guide/products/export.mdx) and [orders](./user-guide/orders/export.mdx).
- Complete Customization Capabilities: Aside from all the features that Medusa provides, it is completely customizable providing capabilities to create custom [endpoints](./advanced/backend/endpoints/add.md), [services](./advanced/backend/services/create-service.md), [subscribers](./advanced/backend/subscribers/create-subscriber.md), [batch job strategies](./advanced/backend/batch-jobs/create.md), and much more!
---
## See Also
- [Quickstart guide](./quickstart/quick-start.mdx)
- [Install the Next.js Storefront](./starters/nextjs-medusa-starter.mdx)
- [Install Medusa Admin](./admin/quickstart.mdx)
+6 -5
View File
@@ -80,8 +80,9 @@ const medusa = new Medusa({
})
```
| Option | Default | Description |
| ------------ | ------------------------- | --------------------------------------------------------- |
| `maxRetries` | `0` | The amount of times a request is retried. |
| `baseUrl` | `'http://localhost:9000'` | The url to which requests are made to. |
| `apiKey` | `''` | Optional api key used for authenticating admin requests . |
| Option | Default | Description |
| ------------------- | ------------------------- | --------------------------------------------------------- |
| `maxRetries` | `0` | The amount of times a request is retried. |
| `baseUrl` | `'http://localhost:9000'` | The url to which requests are made to. |
| `apiKey` | `''` | Optional api key used for authenticating admin requests . |
| `publishableApiKey` | `''` | Optional publishable API key used for storefront requests.|
+44 -16
View File
@@ -1,24 +1,51 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Feedback from '@site/src/components/Feedback';
# Use create-medusa-app
# Install Medusa with create-medusa-app
In this document, youll learn how to use `create-medusa-app` to create a Medusa project with the three main components of Medusa.
## Overview
As explained in the [Introduction guide](../introduction.md), Medusa is composed of three different components: the headless server, the storefront, and the admin dashboard.
Medusa is composed of three different components: the headless server, the storefront, and the admin dashboard.
Medusa provides the necessary tools and resources to set up the three components separately. This ensures that developers have full freedom to choose their tech stack, as they can choose any framework for the storefront and admin dashboard.
However, if youre interested in using Medusas starters for the three components, you can easily make use of the `create-medusa-app` command instead of creating each separately.
However, if youre interested in using Medusas starters for the three components, you can make use of the `create-medusa-app` command instead of creating each separately.
When you run the `create-medusa-app` command, youll install a Medusa server, a Medusa admin, and optionally a storefront at the same time.
:::note
If you instead want to quickly install and setup only a Medusa server, follow [this quickstart guide](../quickstart/quick-start.mdx).
:::
---
## Prerequisites
### Node.js
Medusa supports Node versions 14 and 16. You can check which version of Node you have by running the following command:
```bash noReport
node -v
```
You can install Node from the [official website](https://nodejs.org/en/).
### Git
Git is required for this setup. You can find instructions on how to install it from the [Set up your dev environment documentation](../tutorial/0-set-up-your-development-environment.mdx#git).
---
## How to Create a Medusa Project
A Medusa project is composed of the server, storefront, and admin.
In your terminal, run the following command:
<Tabs groupId="npxyarn" wrapperClassName='code-tabs'>
@@ -44,9 +71,9 @@ Youll then be asked to enter the name of the directory you want the project t
### Choose Medusa Server Starter
Next, youll be asked to choose the Medusa starter. The Medusa Server is created from a starter template. By default, it is created from the `medusa-starter-default` template.
Next, youll be asked to choose the Medusa server starter. The Medusa Server is created from a starter template. By default, it is created from the `medusa-starter-default` template.
You can either pick the default Medusa starter, the Contentful starter or enter a starter URL by choosing `Other`:
You can either pick the default Medusa server starter, the Contentful starter or enter a starter URL by choosing `Other`:
```bash noReport
? Which Medusa starter would you like to install? …
@@ -57,12 +84,6 @@ You can either pick the default Medusa starter, the Contentful starter or enter
The server will be installed under the `backend` directory under the project directory. An SQLite database will be created inside that directory as well with demo data seeded into it.
:::tip
You can learn more about the Contentful starter in the [Contentful Integration documentation](../add-plugins/contentful/index.md).
:::
### Choose Storefront Starter
After choosing the Medusa starter, youll be asked to choose the storefront starter. You can choose one of the starters in the list included or choose `None` to skip installing a storefront:
@@ -107,6 +128,13 @@ yarn start
The commands will differ based on your choices in previous prompts.
<Feedback
event="survey_create-medusa-app"
question="Did you set up Medusa successfully?"
positiveQuestion="Is there anything that should improved?"
negativeQuestion="Please describe the issue you faced."
/>
---
## Project Directory Structure
@@ -116,14 +144,14 @@ Inside the root project directory which was specified at the beginning of the in
```bash noReport
/my-medusa-store
/storefront // Medusa storefront starter
/backend // Medusa starter as a backend option
/admin // Medusa admin panel
/backend // Medusa server
/admin // Medusa admin
```
---
## Whats Next
- [Deploy the Medusa server](../deployments/server/index.mdx)
- [Deploy the Medusa admin](../deployments/admin/index.mdx)
- [Deploy the storefront](../deployments/storefront/index.mdx)
- [Check out Medusa's features](../introduction.md#features)
- [Learn about server configurations](./configurations.md)
- [Set up your environment for advanced development](../tutorial/0-set-up-your-development-environment.mdx)
@@ -0,0 +1,116 @@
---
sidebar_position: 4
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Publishable API Keys
In this document, youll learn how to manage publishable API keys in Medusa Admin.
## Overview
Publishable API keys are used by developers or technical teams. They are used to define the resources that an API key is associated with and can access.
Then, this publishable API key is used in storefront development to retrieve or process data based on the scope of the publishable API key.
Currently, publishable API keys can only be used with sales channels.
---
## Create Publishable API Key
To create a publishable API key:
1. Go to Settings → API key management.
2. Click on the “Create API key” button at the top right.
3. In the new form that opens:
1. Enter a name for the API key in the Title field.
2. You can optionally add sales channels. To do that:
1. Click on the “Add sales channels” button.
2. Click on the checkbox next to the sales channels you want to add.
3. Click on the “Save and close” button.
4. Once youre done, click on the “Publish API key” button.
---
## Copy Token of API Key
To copy the token of an API key:
1. Go to Settings → API key management.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to the API key you want to copy.
3. Click on “Copy token” from the dropdown.
---
## Edit API Key Details
To edit the details of an API key:
1. Go to Settings → API key management.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to the API key you want to edit.
3. Click on “Edit API key details” from the dropdown.
4. Change the title of the API Key in the side window that opens.
5. Click on the “Save and close” button.
---
## Manage Sales Channels of a Publishable API Key
:::info
Making any changes in the sales channels here does not affect the sales channel itself or any of its data. This only impacts the relation between sales channels and publishable API keys.
:::
You can add or delete sales channels from a publishable API key. Adding a sales channel makes it accessible using the publishable API key. Removing a sales channel from a publishable API key removes the API keys access to the sales channel.
To manage sales channels of a publishable API key:
1. Go to Settings → API key management.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to the API key you want to manage its sales channels.
3. Click on “Edit sales channels” from the dropdown.
4. In the side window that opens:
1. To add a sales channel to the publishable API key:
1. Click on the “Add channels” button.
2. Click on the checkbox next to the sales channels you want to add.
3. Once done, click on the “Add and go back” button to add the sales channels and continue editing, or click on the “Add and close” to add the sales channels and close the side menu.
2. To delete a sales channel from the publishable API key:
1. Click on the checkbox next to the sales channels you want to delete.
2. Click on the “Remove” button.
5. Once youre done editing, click on the Close button.
---
## Revoke Publishable API Key
:::warning
Revoking a publishable API key does not remove it, but the API key cant be used in development anymore. It can't be undone.
:::
To revoke a publishable API key:
1. Go to Settings → API key management.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to the API key you want to revoke.
3. Click on “Revoke token” from the dropdown.
4. Confirm revoking the publishable API key by clicking the “Yes, revoke” button in the pop-up.
---
## Delete Publishable API Key
:::warning
Deleting a publishable API key completely removes it and the API key cant be used in development anymore. It can't be undone.
:::
To delete a publishable API key:
1. Go to Settings → API key management.
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to the API key you want to delete.
3. Click on “Delete API key” from the dropdown.
4. Confirm deleting the publishable API key by clicking the “Yes, delete” button in the pop-up.