This feature is in closed beta, so only selected clients can access it now. If you are interested in implementing it in the future, please contact our Support team.

External API keys are credentials generated in and managed by other VTEX accounts. By adding roles to API keys — which are equivalent to usernames — provided by third parties, you can allow them to access specific resources in your account.

The External tab lists the API keys created by your account.

The page displays the following information in a table:

This page allows you to:

• Add external keys
• Edit external keys
• Remove external keys

To add an external key to your account, follow the steps below:

1. In the top bar of the VTEX Admin, click your profile avatar — indicated by the first letter of your email — and then click Account Settings > API Keys.

2. Click the External tab.

3. Click Add Key.

4. Complete the Key identification field with a name to identify the API key.

5. Select the roles that will be associated with the key. By default, no role is pre-selected.

   Select only the roles required for the integration that will use the API key. Unrestricted use of overly permissive roles increases the risk of store attacks through leaked login credentials.

6. Click Add.

Follow the steps below to change an external API key:

1. In the top bar of the VTEX Admin, click your profile avatar — indicated by the first letter of your email — and then click Account Settings > API Keys.
2. Click the External tab.
3. In the row of the desired API key, click the kebab menu (⋮) and then Edit.
4. Change the selection of roles associated with the API key.
5. Click Save.

To remove an external API key, follow the instructions below:

1. In the top bar of the VTEX Admin, click your profile avatar — indicated by the first letter of your email — and then click Account Settings > API Keys.
2. Click the External tab.
3. In the row of the desired API key, click the kebab menu (⋮) and then Remove
4. Click Remove to confirm.

• API Keys (Beta)
• Configuring the duration of API keys (Beta)
• Generated keys (Beta)