API Keys

This page explains how to create and manage GraphQL and REST API keys for external system integrations.

Before you begin

• You need the API Key role to view this page.
• You need Owner access on the API Key role to create or delete keys.

View API keys

Go to Admin > API Key Management. The page has two tabs: GraphQL and REST.

GraphQL tab

Column	Description
Name	API key name (sortable)
Active	Whether the key is active (sortable)
Channel	Associated sales channel
Date Created	When created (sortable)
Date Updated	When last modified (sortable)

REST tab

Column	Description
Name	API key name (sortable)
Active	Whether the key is active (sortable)
Date Created	When created (sortable)
Date Updated	When last modified (sortable)

Create a GraphQL API key

1. On the GraphQL tab, click New GraphQL API Key.
2. Fill in the details:

Field	Required	Description
Name	Yes	Key name
Channel	No	Associate with a specific sales channel
Roles	No	Add one or more roles with access levels. Each role has a Role Definition (Product Data, Logistics, Configuration, Order Data, Pricing, Role & permission, Shop & channel, User) and an Access level (Viewer, Editor or Owner). Click Add Role to add more. Roles cannot be changed after creation.
Active	Yes	Toggle on or off (default: off)

3. Click Save.

After creation, the generated API key appears in the API Key field. It is hidden by default. Click the eye icon to reveal it and use the copy button to copy it to your clipboard.

Create a REST API key

1. On the REST tab, click New REST API Key.
2. Enter a Name (required) and set the Active toggle.
3. Click Save.

After creation, the Client Id and Client Secret fields appear. Both are hidden by default. Click the eye icon to reveal them and use the copy button to copy the values.

Edit an API key

Click any row to open the edit dialog. For GraphQL keys, roles cannot be changed after creation.

Delete API keys

1. Select one or more keys using the checkboxes.
2. Use the delete action.
3. Confirm the deletion.

Filter API keys

Filter	Type	Description
Is Active	Radio	Active or Inactive
Date Created	Date range	Filter by creation date
Date Updated	Date range	Filter by modification date

Related pages

• Backoffice Users - manage admin users and permissions
• Attributes - define custom attributes