Integração Vindi - Assinatura [Interno]

O módulo de assinatura tem a finalidade de disponibilizar ao cliente final a possibilidade de fazer compras com recorrência, sem necessidade de passar pelo fluxo de compras do site. Ele faz apenas a contratação do plano e, a partir disso, os pedidos são criados automaticamente na Vnda.

Nesse cenário, quando o cliente clica no botão de assinatura do produto, ele é redirecionado para o checkout da Vindi, que faz a gestão das assinaturas (criação dos pedidos no admin e cobrança recorrente automática).

Nosso modelo de assinatura funciona através de planos com produtos ou kits definidos pelo seller. Ou seja, não é possível que o cliente monte um carrinho de sua escolha e faça a assinatura dele.

No módulo de assinatura, os pagamentos recorrentes são transacionados através da Vindi. Portanto, para usar este recurso, o seller precisa contratar o serviço de assinatura da Vindi.

A partir da planilha de estrutura de plano enviada pelo seller, precisamos criar os produtos, planos e formas de entrega dentro da Vindi.

Cadastre os produtos/kits disponíveis para assinatura no painel da Vindi em Configurações > Produtos, seguindo as instruções abaixo:

Ao concluir o cadastro, será exibido um ID na página do produto (parte superior direita da tela). Copie-o e clique em Editar.

No campo Código externo, que deixamos em branco anteriormente, cole o ID. Guarde o Código externo também, pois iremos usá-lo nos próximos passos.

Cadastre os planos de assinatura no painel da Vindi em Configurações > Planos, seguindo as instruções abaixo:

Ao concluir o cadastro, será exibido um ID na página do plano (parte superior direita da tela). Assim como Copie-o e clique em Editar.

No campo Código externo, que deixamos em branco anteriormente, cole o ID. Guarde o Código externo também, pois iremos usá-lo nos próximos passos.

As formas de entrega serão cadastradas como produtos dentro da Vindi, conforme abaixo:

Se o cliente quiser vender um produto exclusivamente por assinatura, primeiramente ele deverá cadastrar esse produto no admin. O SKU do produto na Vnda deverá corresponder ao ID do produto gerado na Vindi.

Para que possamos vincular o plano da Vindi ao produto na Vnda, será necessário habilitar um atributo chamado Plano Vindi. Para isso, acesse o admin da loja e vá em configurações (engrenagem) > seção Geral > Atributos.

Esse campo não deverá ficar visível na loja, então será necessário ajustar no front. Acione a equipe de devs para solicitar a ocultação do campo deste atributo na página de produto.

Com o campo do atributo disponível, preencha-o com o ID do plano gerado na Vindi.

Caso o cliente já tenha um produto cadastrado e queira disponibilizá-lo para assinatura, será necessário duplicar as variantes já existentes de forma que:
​1. uma versão da variante contenha o ID do plano no campo de atributo Plano Vindi;
​2. a outra versão contenha a palavra Compra no campo de atributo Plano Vindi.

Para a variante que contém o ID do plano, deverá ser cadastrado o ID do produto no lugar do SKU. Para a variante que contém a palavra Compra, o seller pode cadastrar o SKU que desejar.

Isso fará com que a variante esteja “conectada” ao botão de compra e também ao de assinatura.

Para exibição do botão de assinatura na página de produto, cadastre a tag assinatura no produto.

Para ativar a integração, é necessário gerar duas chaves dentro do painel da Vindi: uma privada e outra pública.

No painel da Vindi, acesse Configurações > Chaves de API. Crie a nova chave conforme abaixo:

Assim que a chave for gerada, salve-a como nota interna no ticket com a tratativa sobre assinatura. Essa informação pode ser necessária no futuro.

No painel da Vindi, acesse Configurações > Chaves de API. Crie a nova chave conforme abaixo:

Salve essa chave no ticket também. Não esqueça de especificar qual é a pública e qual é a privada.

Para ativar a integração com a Vindi, é necessário acessar o admin e, então, configurações (engrenagem) > seção Pagamentos > Vindi. Preencha as configurações da seguinte forma:

Ao salvar as configurações com o campo Vindi webhook secret em branco, será gerado o token para inserir no webhook dentro da Vindi. Para visualizá-lo, basta atualizar a página pelo navegador. Em seguida, salve o token em algum lugar.

Para que a Vnda receba os pedidos por assinatura posteriores, é preciso cadastrar o webhook no painel da Vindi em Configurações > Webhook.

O webhook deverá seguir o padrão abaixo:

https://URL_DA_LOJA/api/v2/orders/vindi?secret=TOKEN

O token do webhook é o que foi gerado aqui.

No campo Eventos, selecione a opção Fatura emitida e, em Status, selecione a opção Ativo.

Se a loja ainda estiver em Setup, não será possível cadastrar a URL com o domínio de produção. Nesse caso, utilize a URL do CDN. Não esqueça de alterar a URL durante o lançamento da loja.