Integrar com gift card

Pagamentos

VTEX Team

VTEX Team

Última atualização

O gift card ou vale, além de ser configurado pelo admin, pode ser usado com um programa de fidelidade externo que a loja utilize e que deseja conectar com o sistema de vales da VTEX.

Neste formato, a loja já possui um provedor externo que gerencia sua relação de créditos/pontos sob uma base de clientes participantes de, por exemplo, um sistema de fidelidade. Ex.: uma loja que, de acordo com o histórico de compras de seus clientes, gera créditos/pontos que podem ser convertidos em um valor nominal para ser utilizado no ato da compra e abater parte do valor do pedido.

Entenda o fluxo

O sistema de fidelidade (provedor) do lojista precisará desenvolver a comunicação para o recebimento de algumas chamadas de API que faremos durante o processo de compra. Isto é, como um middleware que irá receber as chamadas, interpretá-las em seu sistema e traduzi-las novamente para o retorno ao sistema da VTEX aplicar o valor de desconto no pedido. Para isso é preciso:

  1. Desenvolver a comunicação que irá receber as chamadas. Documentação com as APIs que serão trabalhadas: VTEX Gift Card System - API documentation
  2. Estruturada esta comunicação, será necessário nos disponibilizar um endpoint onde realizaremos as respectivas chamadas dessas APIs acima indicadas. Exemplo de Endpoint: http://providerxyz.com.br/fidelidade. Ou seja, quando no processo de compra, na parte onde fazemos as chamadas para a Consulta de Descontos, será monta a seguinte URL: . A seguinte lógica é usada: Endpoint + API [com o request contendo dados do cliente e dos produtos], onde a API varia de acordo com a fase do processo de consulta de créditos/pontos.
  3. Iremos cadastrar em nosso sistema o respectivo Endpoint do Sistema de Fidelidade e o mesmo será utilizado sempre que houver um fechamento de compra. Caso identificada uma relação de créditos/pontos com o Sistema de Fidelidade, a comunicação já terá sido realizado e o processo seguirá com base também nessa forma de pagamento.
  4. Implantada a comunicação, após o cliente indicar seu email na transição do Carrinho para o Checkout, é realizada a primeira consulta ao Sistema de Fidelidade implantado. Esta primeira chamada irá apenas levar os dados do cliente, aguardando uma afirmação ou uma negação sobre o este possuir créditos/pontos.
  5. Com o retorno sendo positivo desde o Sistema de Fidelidade, será solicitado que o cliente faça o seu login na Loja, para garantir que a transação de créditos/pontos com o sistema externo não seja feito por um terceiro.
  6. Com o processo de login sendo também positivo, é enviado, por uma outra chamada de API, o “Carrinho” para o Sistema de Fidelidade. Isto é, enviamos os dados dos Produtos e os valores que estão sendo adquiridos. Nisto, o Sistema de Fidelidade irá absorver esses dados, aplicar internamente sua lógica de créditos/pontos.Este irá retorná-los para a VTEX em um valor nominal para aplicar como desconto e abater no valor do Pedido. Essa ação irá realizar internamente a criação de uma vale contento o valor desse retorno do provider e disponibilizar para o cliente sua aplicação – utilizando a lógica de Vale acima descrita.
  7. O pedido sendo fechado com sucesso, enviaremos a transação – a confirmação do fechamento a compra – e o Sistema de Fidelidade irá fazer o devido débito de pontos desde sua interface.
  8. Caso a transação não seja realizada com sucesso ou sofra haja algum problema em seu processamento, realizaremos uma nova chamada indicando o cancelamento da utilização dos créditos anteriormente retornados para serem usados no pedido.