Como integrar com a Vtex?
Atenção! Não integramos com a versão Vtex IO
Como funciona o processo de integração
A integração com a VTex é dividida entre duas partes e é necessário que você realize ambos os procedimentos, está bem?
Dessa forma:
Busque as chaves de acesso e, em seguida;
Faça a configuração no Notificações Inteligentes.
Busque as chaves de acesso
Para fazer a configuração, acesse sua conta da VTex e clique em Configurações da Conta:
Clique em Gerenciamento da Conta e, em seguida, em Conta:
Agora, clique em Gerar access key e secret:
Você vai receber uma chave e uma Token por e-mail. Depois de recebidos, salve os dados em lugar seguro, ok?
Atenção, para poder utilizar todas funcionalidades disponíveis na integração com a Vtex, você deverá vincular um Usuário com perfil de administrador a esta chave. Caso não saiba como vincular ou não tenha um Usuário com esta permissão, siga os passos abaixo:
Para criação de novas Chaves de aplicações, edição das mesmas e vinculação a usuários, siga o passo a passo disponível neste Link: Chaves de aplicação;
Para criação de novos Usuários ou edição dos mesmos, siga o passo a passo disponível neste Link: Gerenciar Usuários.
Como criar a integração?
Dentro do Notificações Inteligentes
Para criar a integração, acesse a sua conta do Notificações Inteligentes e clique em Lojas:
Na página, clique em Criar loja:
Em seguida, na opção Descrição, é possível dar um apelido para a integração criada:
Na Plataforma, selecione a opção com o nome da integração, na categoria E-Commerce, como demonstrado na imagem abaixo:
Dentro da VTex
Agora, pegue sua Token, que foi criada na VTex, e cole no campo Token da API:
Em seguida, copie a chave que recebeu no email e cole no campo Chave de API:
No campo Nome da conta, coloque o nome da sua conta:
Então, clique em Configurar para finalizar a integração.
Pronto! Sua integração foi feita com sucesso! Agora vamos começar a receber os eventos e, consequentemente, enviar as notificações.
Estou recebendo a mensagem de erro:
Verifique se os dados fornecidos estão de acordo com a nossa documentação e se a Token da API fornecida possui todas as permissões disponibilizadas pela plataforma. Caso o erro persista, entre em contato com o suporte da plataforma VTex.
Isso acontece por causa da falta de permissões à chave fornecida, você já configurou ela? Volte no passo de configurar as permissões de sua chave do nosso manual e corrija as permissões dadas para as chaves criadas.
Como sei que deu certo?
Quer conferir se a integração do Notificações Inteligentes foi feita de maneira certa? Então, veja como você pode fazer a confirmação, seguindo estas etapas:
Verifique o checklist dentro da sua loja
Temos um checklist que te ajuda a entender se todas as configurações necessárias para o envio das notificações foram feitas.
Você consegue ter um exemplo do checklist logo abaixo:
Se todas as opções estiverem na cor verde, quer dizer que você fez todos os passos. Então, provavelmente, as notificações já devem estar sendo enviadas.
Acompanhe a tela de relatórios
Na tela de relatórios, seja da integração ou da instância, você consegue ter uma ideia geral das notificações que estão sendo enviadas.
Caso não saiba onde fica esta tela, acesse este artigo para saber como verificar os relatórios.
Verifiquei todos os passos acima e mesmo assim acredito que não esteja funcionando
Nesse caso, temos um checklist mais detalhado que você consegue ver aqui.
Quando as notificações serão disparadas?
Como essa é uma integração instantânea, assim que a plataforma nos enviar as informações, iremos processar e agendar a mensagem na fila de envios. Caso você não saiba o que é uma fila de envios, clique aqui.
Quais são as notificações disponíveis?
Todas as notificações listadas na tabela abaixo estão disponíveis e funcionando. Antes de você conhecê-las, entenda como cada uma delas funciona.
Veja, então, o que significa cada coluna das notificações disponíveis:
Prioridade no caminho feliz: se esta função estiver disponível, ela vai indicar a ordem de envio das mensagens seguindo a lógica do chamado “caminho feliz”. Você pode ler mais sobre ele aqui;
Nome da notificação: é o nome que damos para a notificação dentro do nosso painel;
Como reconhecemos o evento: em algumas integrações, deixamos documentada a maneira como elas são reconhecidas pelo nosso sistema. Isso acontece porque algumas delas podem ser personalizadas. Mas, se o reconhecimento não estiver disponível, pode ficar tranquilo, pois isso não afeta qualquer usabilidade do sistema.
Clique na imagem para aumentar
Como funciona o processo de integração
A integração com a VTex é dividida entre duas partes e é necessário que você realize ambos os procedimentos, está bem?
Dessa forma:
Busque as chaves de acesso e, em seguida;
Faça a configuração no Notificações Inteligentes.
Busque as chaves de acesso
Para fazer a configuração, acesse sua conta da VTex e clique em Configurações da Conta:
Clique em Gerenciamento da Conta e, em seguida, em Conta:
Agora, clique em Gerar access key e secret:
Você vai receber uma chave e uma Token por e-mail. Depois de recebidos, salve os dados em lugar seguro, ok?
Atenção, para poder utilizar todas funcionalidades disponíveis na integração com a Vtex, você deverá vincular um Usuário com perfil de administrador a esta chave. Caso não saiba como vincular ou não tenha um Usuário com esta permissão, siga os passos abaixo:
Para criação de novas Chaves de aplicações, edição das mesmas e vinculação a usuários, siga o passo a passo disponível neste Link: Chaves de aplicação;
Para criação de novos Usuários ou edição dos mesmos, siga o passo a passo disponível neste Link: Gerenciar Usuários.
Como criar a integração?
Dentro do Notificações Inteligentes
Para criar a integração, acesse a sua conta do Notificações Inteligentes e clique em Lojas:
Na página, clique em Criar loja:
Em seguida, na opção Descrição, é possível dar um apelido para a integração criada:
Na Plataforma, selecione a opção com o nome da integração, na categoria E-Commerce, como demonstrado na imagem abaixo:
Dentro da VTex
Agora, pegue sua Token, que foi criada na VTex, e cole no campo Token da API:
Em seguida, copie a chave que recebeu no email e cole no campo Chave de API:
No campo Nome da conta, coloque o nome da sua conta:
Então, clique em Configurar para finalizar a integração.
Pronto! Sua integração foi feita com sucesso! Agora vamos começar a receber os eventos e, consequentemente, enviar as notificações.
Estou recebendo a mensagem de erro:
Verifique se os dados fornecidos estão de acordo com a nossa documentação e se a Token da API fornecida possui todas as permissões disponibilizadas pela plataforma. Caso o erro persista, entre em contato com o suporte da plataforma VTex.
Isso acontece por causa da falta de permissões à chave fornecida, você já configurou ela? Volte no passo de configurar as permissões de sua chave do nosso manual e corrija as permissões dadas para as chaves criadas.
Como sei que deu certo?
Quer conferir se a integração do Notificações Inteligentes foi feita de maneira certa? Então, veja como você pode fazer a confirmação, seguindo estas etapas:
Verifique o checklist dentro da sua loja
Temos um checklist que te ajuda a entender se todas as configurações necessárias para o envio das notificações foram feitas.
Você consegue ter um exemplo do checklist logo abaixo:
Se todas as opções estiverem na cor verde, quer dizer que você fez todos os passos. Então, provavelmente, as notificações já devem estar sendo enviadas.
Acompanhe a tela de relatórios
Na tela de relatórios, seja da integração ou da instância, você consegue ter uma ideia geral das notificações que estão sendo enviadas.
Caso não saiba onde fica esta tela, acesse este artigo para saber como verificar os relatórios.
Verifiquei todos os passos acima e mesmo assim acredito que não esteja funcionando
Nesse caso, temos um checklist mais detalhado que você consegue ver aqui.
Quando as notificações serão disparadas?
Como essa é uma integração instantânea, assim que a plataforma nos enviar as informações, iremos processar e agendar a mensagem na fila de envios. Caso você não saiba o que é uma fila de envios, clique aqui.
Quais são as notificações disponíveis?
Todas as notificações listadas na tabela abaixo estão disponíveis e funcionando. Antes de você conhecê-las, entenda como cada uma delas funciona.
Veja, então, o que significa cada coluna das notificações disponíveis:
Prioridade no caminho feliz: se esta função estiver disponível, ela vai indicar a ordem de envio das mensagens seguindo a lógica do chamado “caminho feliz”. Você pode ler mais sobre ele aqui;
Nome da notificação: é o nome que damos para a notificação dentro do nosso painel;
Como reconhecemos o evento: em algumas integrações, deixamos documentada a maneira como elas são reconhecidas pelo nosso sistema. Isso acontece porque algumas delas podem ser personalizadas. Mas, se o reconhecimento não estiver disponível, pode ficar tranquilo, pois isso não afeta qualquer usabilidade do sistema.
Clique na imagem para aumentar
Atualizado em: 31/10/2023
Obrigado!