ContextQMD
Back to Medusa

{metadata.title}

www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx

2.14.26.0 KB
Original Source

import { Table } from "docs-ui" import { EllipsisHorizontal } from "@medusajs/icons"

export const metadata = { title: Manage Publishable API Keys in Medusa Admin, }

{metadata.title}

In this guide, you'll learn how to create and manage publishable API keys in the Medusa Admin.

<Note>

This guide is mainly useful for developers and technical teams building customizations for a Medusa application.

</Note>

What is a Publishable API Key?

A publishable API key is a client key scoped to one or more sales channels. When you build a storefront, you must pass a publishable API key in the request headers indicating the sales channel to scope the request to. This impacts the products retrieved, available stock quantities, and other data.

To learn how to pass the publishable API key in request headers, refer to the API Reference.

View Publishable API Keys

To view the publishable API keys in the Medusa Admin, go to Settings -> Publishable API Keys.

Here, you can see a list of all the publishable API keys you have set up in your store. You can also search, filter, and sort the API keys to find the one you are looking for.

Create Publishable API Key

To create a new publishable API key:

  1. Go to Settings -> Publishable API Keys.
  2. Click the Create button in the main section's header.
  3. In the form that opens, enter the publishable API key's title.
  4. Once you're done, click the Save button.

View Publishable API Key Details

To view the details of a publishable API key:

  1. Go to Settings -> Publishable API Keys.
  2. Click on a publishable API key from the list.

This opens the publishable API key's details page where you can also manage the API key.

Publishable API Key Status

You can see the status of the publishable API key in the header of the first section in the details page. A publishable API key's status can be:

<Table> <Table.Header> <Table.Row> <Table.HeaderCell>Status</Table.HeaderCell> <Table.HeaderCell>Description</Table.HeaderCell> </Table.Row> </Table.Header> <Table.Body> <Table.Row> <Table.Cell>Active</Table.Cell> <Table.Cell>The API key is active and can be used in requests.</Table.Cell> </Table.Row> <Table.Row> <Table.Cell>Revoked</Table.Cell> <Table.Cell>The API key has been revoked and can't be used in requests.</Table.Cell> </Table.Row> </Table.Body> </Table>

Copy Publishable API Key

To copy a publishable API key:

  1. Go to the publishable API key's details page.
  2. In the first section, click on the truncated key to copy it to your clipboard.

Edit Publishable API Key

To edit a publishable API key:

  1. Go to the publishable API key's details page.
  2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
  3. Choose "Edit" from the dropdown.
  4. In the side window that opens, you can edit the publishable API key's title.
  5. Once you're done, click the Save button.

Manage Publishable API Key's Sales Channels

You can manage the sales channels of a publishable API key in its details page. By adding sales channels to the publishable API key, it becomes part of the scope in requests made with the key.

Add Sales Channels

To add a sales channel to a publishable API key:

  1. Go to the publishable API key's details page.
  2. Click the "Add" button in the "Sales Channels" section's header.
  3. In the list that opens, check the sales channels you want to add the API key to.
  4. Once you're done, click the Save button.

Remove Sales Channels

To remove a sales channel from a publishable API key:

  1. Go to the publishable API key's details page.
  2. Check the checkbox next to the sales channel you want to remove in the "Sales Channels" section.
  3. Press <Kbd>R</Kbd> or click the Remove button at the bottom center of the page.
  4. Confirm removing the sales channels by clicking the Continue button.

Revoke Publishable API Key

<Note type="warning">

Revoking a publishable API key is irreversible. You can't use the key in requests after revoking it or reactivate it.

</Note>

To revoke a publishable API key:

  1. Go to the publishable API key's details page.
  2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
  3. Choose "Revoke API key" from the dropdown.
  4. Confirm revoking the API key by clicking the "Revoke API key" button in the pop-up.

Delete Publishable API Key

<Note type="warning">

Deleting a publishable API key is irreversible.

</Note>

You can only delete a publishable API key after revoking it. To delete a publishable API key:

  1. Go to the publishable API key's details page.
  2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> in the first section's header.
  3. Choose "Delete" from the dropdown.
  4. Confirm deleting the API key by clicking the Delete button in the pop-up.