Como integrar com a Vindi?
Como configurar 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 Gateway de pagamentos, como demonstrado na imagem abaixo:
Dentro da Vindi
Para fazer a integração, você terá que executar algumas tarefas quando chegar à tela onde tem o campo Token da API. Veja:
• Primeiramente, entre em sua conta da Vindi. Logo após, no painel a sua esquerda, clique em Configurações:
• Em sua tela, procure por Integrações e clique em Chaves de API:
• Após o clique, você será redirecionado para esta página, onde poderá cadastrar uma nova Chave de acesso; veja:
• Para cadastrar uma Chave de acesso, clique no botão Nova chave no canto superior direito:
• Logo após, no campo Descrição, digite a descrição que deseja. No campo Tipo, deixe selecionado como Chave privada:
• Depois, clique em Criar Chave de acesso:
• Após o clique, sua chave será criada. Agora, basta copiar e colar dentro do Notificações Inteligentes no campo Token API:
Atenção! A integração ainda não está terminada!
Volte em sua conta na Vindi e, no painel localizado à sua esquerda, clique em Configurações:
Em sua tela, procure por Integrações e clique em Webhooks:
Para cadastrar um Webhook, clique no botão Novo webhook no canto superior direito:
Após o clique, você será redirecionado para esta página, onde poderá cadastrar um novo Webhook; veja:
No campo URL, coloque a URL da integração da Vindi que você criou no Notificações Inteligentes:
Caso não saiba onde pegar a URL no Notificações Inteligentes, acesse este artigo e siga o passo a passo.
No campo Eventos, selecione todas opções, como demonstra a imagem:
No campo Status, deixe-o sempre como Ativo:
Antes de finalizar o processo, você poderá testar seu webhook. Para isso, clique em Testar, que fica localizado no canto superior esquerdo:
Agora, para finalizar sua integração, clique em Criar Webhook:
Pronto! Sua integração foi feita com sucesso! Agora vamos começar a receber os eventos e consequentemente enviar as notificações.
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 ele 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
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 Gateway de pagamentos, como demonstrado na imagem abaixo:
Dentro da Vindi
Para fazer a integração, você terá que executar algumas tarefas quando chegar à tela onde tem o campo Token da API. Veja:
• Primeiramente, entre em sua conta da Vindi. Logo após, no painel a sua esquerda, clique em Configurações:
• Em sua tela, procure por Integrações e clique em Chaves de API:
• Após o clique, você será redirecionado para esta página, onde poderá cadastrar uma nova Chave de acesso; veja:
• Para cadastrar uma Chave de acesso, clique no botão Nova chave no canto superior direito:
• Logo após, no campo Descrição, digite a descrição que deseja. No campo Tipo, deixe selecionado como Chave privada:
• Depois, clique em Criar Chave de acesso:
• Após o clique, sua chave será criada. Agora, basta copiar e colar dentro do Notificações Inteligentes no campo Token API:
Atenção! A integração ainda não está terminada!
Volte em sua conta na Vindi e, no painel localizado à sua esquerda, clique em Configurações:
Em sua tela, procure por Integrações e clique em Webhooks:
Para cadastrar um Webhook, clique no botão Novo webhook no canto superior direito:
Após o clique, você será redirecionado para esta página, onde poderá cadastrar um novo Webhook; veja:
No campo URL, coloque a URL da integração da Vindi que você criou no Notificações Inteligentes:
Caso não saiba onde pegar a URL no Notificações Inteligentes, acesse este artigo e siga o passo a passo.
No campo Eventos, selecione todas opções, como demonstra a imagem:
No campo Status, deixe-o sempre como Ativo:
Antes de finalizar o processo, você poderá testar seu webhook. Para isso, clique em Testar, que fica localizado no canto superior esquerdo:
Agora, para finalizar sua integração, clique em Criar Webhook:
Pronto! Sua integração foi feita com sucesso! Agora vamos começar a receber os eventos e consequentemente enviar as notificações.
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 ele 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.
Mapeamento de eventos da Vindi
Fatura avulsa paga, o tipo do evento tem que ser bill_paid e não pode ter nada relacionado a uma assinatura;
Fatura de assinatura paga, o tipo do evento tem que ser bill_paid e tem que está relacionado a uma assinatura;
Nota fiscal emitida, o tipo do evento tem que ser invoice_issued;
Assinatura cancelada, o tipo do evento tem que ser subscription_canceled e tem que está relacionado a uma assinatura;
Assinatura criada, o tipo do evento tem que ser subscription_created e tem que está relacionado a uma assinatura;
Assinatura reativada, o tipo do evento tem que ser subscription_reactivated e tem que está relacionado a uma assinatura;
Cobrança de assinatura emitida, o tipo do evento tem que ser charge_created e tem que está relacionado a uma assinatura;
Cobrança de assinatura rejeitada, o tipo do evento tem que ser charge_rejected e tem que está relacionado a uma assinatura;
Cobrança de assinatura estornada, o tipo do evento tem que ser charge_refunded e tem que está relacionado a uma assinatura;Clique na imagem para aumentar
Atualizado em: 01/12/2023
Obrigado!