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.
Criação da credencial de API
Siga os passos abaixo para criar sua credencial de API na Vtex:
-
Acesse a conta da Vtex com o usuário master (cujo e-mail está identificado na página de contato da conta).
- Navegue no menu Segurança (Security) e clique em Gerar appKey e app Token (Generate appKey and appToken).
- Digite uma descrição para a chave de API (ex., Inngage CRM) e clique em Gerar novos tokens (Generate new Tokens).
- O token será exibido conforme a seguir. Você deve copiá-lo para ser utilizado no Inngage.
Maiores informações a respeito da criação de chaves de API podem ser obtidas na própria documentação da Vtex.
Definição de permissões
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:
- Ainda na seção Segurança (Security), copie a chave de API (appKey) que está localizada na coluna Access key.
- Navegue na seção Gestão de contas (Account management) e clique no item Usuários (Users) e localize a chave de acesso copiada no passo anterior.
- Clique no nome do usuário e escolha os perfis de acesso.
Perfis de acesso
É 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 q 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
Para saber mais sobre os perfis de acesso da Vtex, consulte a documentação.
Cadastro no Inngage
Para ativar a integração, envie para o seu executivo de contas as credenciais e os parâmetros abaixo:
appkey
token
accountName
environment (vtexcommercestable ou vtexcommercebeta)
Para saber mais sobre os parâmetros, consulte a documentação.
