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. You can change roles and access levels later by editing the key.
Active	Yes	Toggle on or off (default: off)
Retrieve key only once	No	With this on, the key is shown only right after creation and cannot be retrieved again

3. Click Save.

After creation, the generated API key appears in the API Key field. Click the eye icon to reveal it and the copy button to copy it.

warning

With Retrieve key only once on, the key is shown only right after you create it. Copy it and store it somewhere safe before you close the dialog. You can still rename the key, change its roles and switch it off, but you cannot see the key itself again. If you lose it, create a new key and delete the old one.

Create a REST API key

1. On the REST tab, click New REST API Key.
2. Enter a Name (required), set the Active toggle and decide whether to switch on Retrieve key only once.
3. Click Save.

After creation, the Client Id and Client Secret fields appear. Click the eye icon to reveal them and the copy button to copy the values.

warning

With Retrieve key only once on, the client secret is shown only right after you create the key. Copy it and store it somewhere safe before you close the dialog. You can still rename the key and switch it off, but the secret is not shown again. If you lose it, create a new key and delete the old one.

Edit an API key

Click any row to open the edit dialog. For GraphQL keys you can also change the roles and access levels here, for example to tighten what an existing key can do or to extend it when an integration needs more.

Delete API keys

1. Select one or more keys using the checkboxes.
2. Click Delete.
3. Confirm the deletion.

warning

Deleting a key is permanent and any integration still using it stops working. If you only want to stop a key from working for now, switch off its Active toggle instead. You can switch that back on.

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