A integração entre OmniChat e VTEX permite que você se beneficie de todo o catálogo de produtos existentes no seu ecommerce, além das regras de logística, pagamento, promoções e outros.
Como ativar a integração
Para ativar a integração entre OmniChat e VTEX siga as etapas abaixo:
Na plataforma OmniChat, no menu lateral, acesso Configurações > Integrações.
No tela que será exibida, no menu de integração, acesse E-Commerce/ERP.
Clique na caixinha da integração VTEX.
Na tela de configuração, clique em Instalar.
Após seguir essas etapas irá aparecer o formulário de configuração da integração onde é necessário preencher algumas informações para que a OmniChat possa se conectar a sua loja VTEX.
Os campos que será necessário preencher são:
API Key
Nesse campo deve ser informado a chave de aplicação (API KEY) que deve ser gerado no admin da sua loja VTEX. Para saber como conseguir essa informação leia a sessão que fala sobre Como criar uma chave de aplicação na VTEX.
API Token
Nesse campo deve ser informa o token da chave de aplicação (API Token) que é gerado junto com a chave de aplicação no admin da sua loja VTEX. Para saber como conseguir essa informação leia a sessão que fala sobre Como criar uma chave de aplicação na VTEX.
AccountName
Nesse campo deve ser informado o nome de identificação da sua loja na VTEX. É o nome que aparece no inicio da URL do seu admin na VTEX.
Ex.: Se a URL do seu admin é https://minha-loja.myvtex.com/admin o seu account name é minha-loja.
Sales Channel
Nesse campo deve ser informado o ID da política comercial que você deseja utilizar para realizar as vendas na OmniChat. Para saber mais veja Política Comercial na VTEX.
Ecommerce URL
Nesse campo deve ser informado a URL da sua loja, a mesma que seus clientes utilizam para acessa-la. Ex.: https://www.minha-loja.com.br.
URL complementar do checkout
Esse campo não é obrigatório. Ele pode ser usado para enviar informações complementares na URL de checkout que é enviada para o comprador no final do fluxo de venda na OmniChat.
Por padrão a URL do checkout que é gerada tem esse formato:
https://www.minha-loja.com.br/checkout/?orderformid=8163e571a3d444a594fc0cede6a18850
Se o campo URL complementar for preenchido com &utm_campaing=vendaChat por exemplo, a URL do checkout passara a ter esse formato:
https://www.minha-loja.com.br/checkout/?orderformid=8163e571a3d444a594fc0cede6a18850&utm_campaing=vendaChat
Depois de preencher os campos necessários clique no botão Integrar.
Após essas etapas será iniciada a sincronização dos dados com sua Loja VTEX.
Como criar a chave de aplicação na VTEX
A integração entre a OmniChat e VTEX ocorre por meio de comunicação de um conjunto de APIs. Para que a OmniChat consiga se comunicar com sua loja é necessário criar uma chave de aplicação com algumas permissões especificas, que servirão para a OmniChat se autenticar na sua loja e poder usar essas APIs.
Lembre-se que a Chave de Aplicação que você irá gerar para a OmniChat precisa estar vinculada a um perfil de acesso que tenha algumas permissões especificas para que a integração funcione corretamente. Essas permissões são as seguintes:
OMS
Feed v3 and Hook Admin
Subscription view only
Notify payment
Notify invoice
View order
Notify refund
Cancel order
List Orders
Checkout
Order Full Access
Catalog
Product management
Dynamic Storage
Master Data administrator
Cria perfil de acesso na VTEX
Para criar uma perfil de acesso na VTEX siga as etapas abaixo:
No menu lateral acesso, Configurações da conta > Gerenciamento da conta > Perfis de acesso.
Clique em Novo perfil.
Preencha o nome do perfil, e em Produtos e recursos adicionar as permissões conforme listado acima.
Utilize o botão Configurar outro produto, até configurar todas as permissões necessárias.
Quando terminar, seu perfil de acesso estará criado e pronto para ser vinculado à sua chave de aplicação.
Caso precise de ajuda para criar ou alterar um perfil de acesso da Chave de Aplicação veja esse tutorial.
Criar chave de aplicação na VTEX
Para criar uma chave de acesso na VTEX siga as seguintes etapas:
No menu lateral acesse Configurações de conta > Gerenciamento de conta > Conta.
Na página quer irá abrir, vá até a área de Segurança. Então clique em Gerar chave de acesso e segredo.
Preencha o nome da Chave que deseja criar e clique em Gerar novo segredo.
Será exibido o segredo da sua chave, copie e guarde em segurança. Em seguida clique em Gerenciar acesso.
Na página que será carregada, clique em + adicionar perfis.
Pesquise o perfil criado para a integração OmniChat, selecione e clique em Adicionar Perfis.
Em seguida, clique em Salvar.
Caso precise de ajudar para criar uma Chave de aplicação na VTEX veja esse tutorial.
Deixe seu feedback avaliando esse documento! Isso nos ajudar a melhorar. Obrigado!