Configurando integração VTEX

Saiba como configurar a conexão da Inngage com as APIs VTEX
Written by Inngage
Updated 1 month ago

A Inngage possui integração nativa com a plataforma de e-commerce Vtex, permitindo a listagem de pedidos e clientes. Para habilitar esta integração, você precisa criar uma credencial de API na Vtex para que seja utilizada pela plataforma Inngage.

Parte 1: Criar API Key na VTEX

  1. Acesse sua conta VTEX: Utilize o usuário master de sua conta.
  2. Menu Segurança: No menu, procure por "Segurança" e clique em "Gerar appKey e appToken".
  3. Descrição da chave: Insira uma descrição para a chave da API (ex: "Inngage CRM").
  4. Gerar tokens: Clique em "Gerar novos tokens".
  5. Copiar token: O token será exibido. Copie para usar no Inngage.

Documentação VTEX: Consulte a documentação da VTEX para obter mais informações sobre a criação de chaves de API.

Parte 2: Definição de permissões na VTEX

Por padrão, credenciais de API são geradas sem qualquer permissão na Vtex. Para conceder permissões, você deve associar a chave gerada à perfis de acesso, de acordo com as etapas abaixo:

  1. Copiar chave de API: Na seção "Segurança", copie a chave de API (appKey) que está na coluna "Chave de acesso".
  2. Gestão de contas: Acesse "Gestão de contas" e clique em "Usuários".
  3. Localizar chave: Encontre a chave de acesso copiada no passo anterior.
  4. Atribuir perfis:  É necessário liberar o acesso a recursos específicos de cada um dos produtos conforme a integração desejada. Abaixo encontra-se a lista dos recursos esperados para cada uma das entidades de integração com a Inngage:
  •  Produto

Catalog - Produtos

  • Recursos

Collection  - Read Collections

  • Produto

OMS - Pedidos e respectivos clientes

  •  Recursos

OMS Access

- View order

- Order feed subscription

- Feed v3 and Hook view only

- Subscription view only

  • Produto

Master Data - Contatos

  • Recursos

Generic resources

 - Read-only form access

Produto

Dynamic Storage - Contatos

  • Recursos

Dynamic storage generic resources

- Read only documents

Data entity

- List data entity

- View data entity details

  • Triggers

 - List trigger

- View trigger details

Documentação de Perfis de acesso da VTEX: Clique aqui.

Parte 4: Configuração da integração na Inngage

Para ativar a integração, envie para o seu executivo de contas as credenciais e os parâmetros abaixo:

  1. Ativar integração: Na plataforma Inngage vá até App Store e escolha a opção VTEX.
  2. Preencher dados: Insira as credenciais e parâmetros solicitados:
    • Chave de API (appKey)
    • Token (token de aplicativo)
    • Nome da conta (accountName)
    • Ambiente (vtexcommercestable ou vtexcommercebeta)

Para saber mais sobre os parâmetros consulte a documentação.

Did this answer your question?