Skip to main content

How to get API key from VTEX

VTEX offers a series of open APIs so that retailers and partners can make highly customizable integrations with our systems. Most of these APIs are private and, as such, require you to provide a pair of credentials before you can access them. These credentials are:

  • An appKey
  • An appToken

They work as a pair of ID and password and must be created inside your store’s administration panel. To create a pair of credentials, the Master user should follow these steps:

Step 1: Log in to your VTEX store’s admin panel. From the left-hand menu, click on the Apps icon and select Application Keys.

VTEX Application Keys

Step 2: Click the Manage My Keys button, then select Generate New. You should come up with a new name for the app at this step. 

Step 3: Next, click Add Roles and choose the highest role available. In this example, we select Owner (Admin Super), which is recommended since the store owner has all the necessary permissions for data export/import. 

VTEX owner role

Step 4: Click the Generate button, and after a few seconds, the system will display your Application Key and Application Token. These credentials are shown only once, so be sure to copy them and save them to a text file on your computer.

Planning a DIY Salesforce Commerce Cloud Migration? Expose All The Hidden Costs, Straight from the Experts!
Uncover All Hidden Costs of DIY SFCC Migration