Pular para o conteúdo

Conectar a VTEX

Gerar a chave de API com as permissões certas, conectar, e instalar os dois códigos que o carrinho abandonado exige.

O resultado é a loja VTEX aparecendo como Ativo na lista de integrações, com clientes, pedidos e produtos sincronizando sozinhos.

Onde fica: Integrações — procure por VTEX e clique em Instalar.

Antes de começar

  • Acesso ao Admin da VTEX com permissão para gerenciar chaves de API — normalmente o usuário Master da conta.
  • O nome da conta VTEX, que aparece na URL do Admin: em minhaloja.myvtex.com, a conta é minhaloja.
  • Na Bevean, permissão para gerenciar integrações.

Passo 1: gerar a chave de API na VTEX

A VTEX autentica integrações com um par de credenciais — App Key e App Token.

  1. Abra as chaves de API

    No Admin da VTEX, clique no avatar do seu perfil e vá em Configurações da contaChaves de API, na aba Geradas.

  2. Gere uma chave nova

    Clique em + Gerar chave e preencha a identificação — use algo como "Bevean", para reconhecer depois.

  3. Copie a App Key

    Ela aparece na hora, nessa mesma tela.

  4. Copie o App Token pelo link de acesso único

    O token não é exibido direto: a VTEX dá um link que só pode ser aberto uma vez e expira em 24 horas. Abra o link e copie o token antes de sair da página.

Atenção:

Perdeu o token? Só gerando outra chave

Tanto o link quanto o App Token são de exibição única. Se o token se perder antes de você colar na Bevean, não há como recuperá-lo — é preciso gerar uma chave nova e descartar a anterior.

Passo 2: dar as permissões à chave

Uma chave recém-criada não tem permissão nenhuma. É o erro mais comum: as credenciais estão certas, a conexão falha, e o motivo é a chave não estar vinculada a um perfil de acesso.

Ainda em Configurações da conta, associe a chave a um perfil de acesso — existente ou criado para a Bevean — com estes acessos de leitura:

Acesso na VTEXPara que a Bevean usa
MasterData — Clientes e EndereçosImportar a base de clientes. É o que a Bevean testa ao conectar.
ListOrders e OMSViewerImportar os pedidos.
Feed v3 and Hook AdminAcompanhar os pedidos novos pelo feed.
Catalog › ContentImportar produtos, SKUs e categorias.
Pricing › Price ListLer os preços dos produtos.
Manage benefits and ratesCriar cupons a partir da Bevean, quando você usa cashback ou cupom em campanha.

Passo 3: conectar na Bevean

Na tela da integração, preencha os três campos e clique em Conectar:

CampoO que preencher
AccountO nome da conta VTEX, sem espaços e sem o .myvtex.com.
ApiKeyA App Key gerada no passo 1.
ApiTokenO App Token gerado no passo 1.

Ao conectar, a Bevean faz uma chamada de teste à VTEX. Dando certo, a integração passa a Ativo e começa a importar clientes, pedidos e produtos.

Se a conexão falhar

VerifiqueDetalhe
A chave tem perfil de acesso?Sem perfil vinculado, a chave não retorna dado nenhum — mesmo com credencial correta.
O Account está limpo?Sem espaços e sem o sufixo .myvtex.com.
A chave e o token vieram inteiros?Copiar e colar costuma trazer espaço no fim.
O token ainda é válido?Se o link de acesso único expirou sem ser aberto, o token nunca chegou a existir para você.

Carrinho abandonado: precisa do tracker

A VTEX não entrega carrinho abandonado pela API, então esse dado só existe se você instalar o tracker da Bevean. E são dois códigos diferentes, em dois lugares diferentes — a tela da integração gera os dois para você copiar.

  1. Gere os códigos

    Na integração já conectada, use o botão que cria a chave pública e monta os dois códigos do tracker.

  2. Instale o código da vitrine

    Vai no Google Tag Manager da loja, como tag HTML personalizada, disparando em todas as páginas. Publique o container depois.

  3. Instale o código do checkout

    No painel da VTEX, em CheckoutCódigo, abra o arquivo checkout6-custom.js e cole o código do checkout — que é JavaScript puro, sem a tag de script.

Atenção:

Sem a etapa do checkout, o carrinho abandonado não funciona

O código da vitrine sozinho registra navegação e produto visto, mas não o carrinho. É a etapa do checkout6-custom.js que habilita o carrinho abandonado.

Informação:

Lojas antigas podem usar um Trigger de Master Data

Antes do tracker, o carrinho abandonado da VTEX era configurado por um Trigger no Master Data que chamava um endereço da Bevean. Esse caminho continua funcionando para quem já o tem montado.

Para instalar agora, use o tracker: é o caminho que a própria tela da integração ensina.

Os links que a Bevean monta nas mensagens usam o domínio configurado na integração. Sem isso preenchido, eles caem no endereço padrão da VTEX (suaconta.vtexcommercestable.com.br) — funciona, mas não é o domínio da sua loja. Vale conferir esse campo depois de conectar.

Atualizado em

Central de Ajuda — tutoriais e respostas sobre a plataforma.

Digite ao menos duas letras para buscar.