Tutoriais e Soluções
Gerenciamento de pedidos
Estoque e entrega
Pagamentos
Catálogo
Preços
Taxas e Promoções
Insights
Master Data
Central de Mensagens
Políticas Comerciais
CMS
Checkout
Sugestões
Sellers
Integrações
Apps
Autenticações
Gerenciamento da conta
Faturas
Controle de Crédito
Omnichannel
VTEX IO
Projetos & Integrações

Criar appKey e appToken para autenticar integrações

Breno Barreto
Breno Barreto
Atualizado por último
27/03/2019

Toda integração com APIs VTEX precisa se autenticar por meio de appKey e appToken.

Apenas o usuário Master da loja tem permissão para manipular tokens. O usuário Master é aquele cujo e-mail consta na seção Contato da tela Contas, no License Manager.

Para gerar essas chaves, siga os passos abaixo:

  1. No menu lateral do novo admin, clique em Gerenciamento da conta e, depois, em Contas.
  2. No campo Buscar, digite o nome da sua conta e aperte Enter.
  3. Ao clicar no nome da sua conta, você será redirecionado para a página Editar conta.
  4. Na seção Segurança, clique em Gerar appKey e appToken.
  5. Insira um nome para o par de appKey e appToken que você está criando.
  6. Clique em Gerar novos tokens.
  7. No campo que é exibido em seguida, fica o token. Por uma questão de segurança, ele é exibido apenas uma vez. Copie esse token e guarde-o em local seguro.
Atenção: todo par de appKey e appToken, quando é criado, nasce sem estar vinculado a um perfil de acessso. Então, depois de criá-lo, é necessário vinculá-lo ao perfil de acesso desejado.

Para isso, siga os passos abaixo:

  1. Na seção Segurança da aba Contas, copie a appKey desejada, que se encontra na coluna Chave de aplicação.
  2. Ainda no License Manager, acesse a aba Usuários e faça uma busca pela chave que você copiou.
  3. Entre no usuário encontrado e associe-o aos perfis desejados. Essa appKey será capaz de autenticar integrações com os módulos e funcionalidades aos quais o perfil escolhido dá acesso.

Após realizar estes procedimentos, autentique-se na API utilizando os headers X-VTEX-API-appKey e X-VTEX-API-appToken da seguinte forma:

  1. Utilize o X-VTEX-API-appKey para a Chave de aplicação informada no License Manager
  2. Utilize o X-VTEX-API-appToken para o Token que foi gerado no License Manager

Em diferentes sistemas, providos por terceiros ou não, normalmente o appKey corresponde ao usuário e o appToken à senha.

Ainda possui dúvidas?
Pergunte à comunidade
Encontre soluções e compartilhe ideias na comunidade VTEX.
Fale com nossos experts
Entre em contato caso você tenha algo específico a perguntar sobre a plataforma.
  • EN
  • ES
VTEX website