Criando chave API na VTEX: guia completo

1. Acesse sua conta VTEX:

• Faça login na sua conta VTEX com seu usuário e senha.

2. Crie uma função de usuário para a Revie

• Na barra superior do Admin VTEX, clique no avatar do seu perfil (marcado com a inicial do seu email), selecione Configuração da conta e depois Funções de Usuário
• Clique no botão Função
• Para criar uma função personalizada, clique em Selecionar função, e seleciona Custom na lista de funções disponíveis.

3. Atribuir permissões à função personalizada

• Clique no menu de opções Selecione um produto, selecione Cataloge adicione as seguintes permissões:

• Para o recurso Marketing, atribua as seguintes permissões:

• Agora, clique no botão Configure outro produto

• Clique no menu de opções Selecione um produto, selecione OMS e adicione as seguintes permissões:

• Por último, clique em salvar

4. Criar Chaves de API

• Na barra superior do Admin VTEX, clique no avatar do seu perfil (marcado com a inicial do seu e-mail), selecione Configuração da conta e depois Chaves de API.

• Na página de Chaves de API, clique no botão Gerenciar minhas chaves

• Clique no botão Gerar nova para adicionar uma nova aplicação.

• Preencha o campo Etiqueta com uma descrição da finalidade da chave de API. Por exemplo: Revie

• Clique em, + Adicionar funções, selecione a função que criamos no passo anterior e clique em Adicionar função.

• Clique no botão Gerar

• Mantenha a API Key e o API Token gerados protegidos em um lugar seguro.

5. Por favor, forneça a URL da VTEX e as credenciais para que possamos integrar com a Revie.

• Para completar a integração, envie as informações para a nossa equipe de suporte utilizando o seguinte formato:

Actualizado em: 31/07/2025