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.

Each API integration used to connect your VTEX account with external systems will require creating an API key For each key, an API token acts as a password for using that credential.

These authentication credentials ensure secure access to the data you want to share with these integrations without exposing your account to unauthorized users or applications.

For an API key to successfully make API requests to your account, it must be active and have roles specifying the account resources it can access.

The API Keys page in the VTEX Admin allows you to manage the API keys with access to your store. See the guides below for more details on the available actions and information on this page:

• Settings: Allows you to set the default duration of API keys generated in your account.
• Generated keys: Allows you to manage API keys created and managed by your VTEX account.
• External keys: Allows you to manage API keys created and managed by other VTEX accounts, with access to specific resources in your account.

To manage API keys, you must have the User Administrator - RESTRICTED role or a custom role with the following resources:

• View API Keys (view, filter, search for, and sort external and generated API keys)
• Edit API Keys (create, delete, change status and add or remove API key permissions)
• Renew API token (view and renew generated key tokens)
• Edit API Keys settings (configure the duration for generated key tokens)

Learn more about each resource in License Manager resources.