A nossa WebAPI de Fidelidade tem como principal objetivo disponibilizar para nossos lojistas e parceiros uma estrutura de extensibilidade que os permitam se conectar a diferentes programas de fidelidade ou benefícios externos através do Linx Commerce, de modo que todas as lojas possam contar com diferentes benefícios de fidelidade, como:
- Cupons;
- Promoções;
- Cashbacks;
- Descontos.
Através desta funcionalidade iremos disponibilizar uma nova estrutura de conexão aos lojistas e parceiros para que se integrem com nossa plataforma, possibilitando um ecossistema infinito de integrações através do Store Front (interface de interação entre o lojista e o consumidor, o front de loja).
Na imagem abaixo é possível ter melhor compreensão do fluxo de dados da WebAPI de Fidelidade, entendendo o momento em que ocorrem as Consultas, Aplicações e Cancelamentos durante o fluxo de compra e como ocorrerá a conexão entre o front-end (WebAPI) com o back-end, assim como o back-end se comunicará com o parceiro através da API.
Desta maneira a WebAPI permitirá que todo e qualquer lojista do Linx Commerce use diversas chaves de identificação, para realizar a busca por benefícios em diferentes programas de fidelidade, assim como:
- Produtos e Carrinhos;
- Meios de Pagamentos;
- Meios de Entregas;
- CPF do consumidor.
Cada chave de identificação se torna uma propriedade que pode ser usada para consultar se há algum benefício para o respectivo no programa de fidelidade escolhido pelo lojista.
Para melhor compreensão do fluxo para a implementação da nossa WebAPI de Fidelidade, dividimos as documentações em três grandes tópicos, sendo eles: WebAPI, API e Admin.
Abaixo será possível ter uma visão mais completa sobre o que onde um dos tópicos vai ajudar durante o desenvolvimento e "linkar" as respectivas documentações.
1. O primeiro tópico é a WebAPI, nele é possível que o lojista ou parceiro que deseja realizar o desenvolvimento, consiga acessar os exemplos de Consultas, Consumos e Cancelamentos em que o front-end realizará no back-end para o tratamento das informações.
Abaixo os principais links da documentação:
- WebAPI - Consulta (Item);
- WebAPI - Consulta (Pedido, Itens, Fretes, Pagamentos e Cashback);
- WebAPI - Aplicação (Pedido, Itens, Fretes e Pagamentos);
- WebAPI - Cashback (Aplicação e Remoção).
2. O segundo tópico é a API, nele será possível que o lojista ou parceiro que deseja realizar o desenvolvimento, consiga acessar os exemplos de Consultas, Consumos e Cancelamentos em que o back-end realizará na API externa para o tratamento das informações.
Abaixo os principais links da documentação:
3. O terceiro e último tópico é o Admin, nele será possível que o lojista ou parceiro que já realizou o desenvolvimento, consiga agora cadastrar um parceiro promocional em sua loja (via Admin), neste tópico também será possível entender alguns fluxos de pós venda, como nossa tela de extrato promocional no detalhe do pedido.
Abaixo os principais links da documentação:
- Admin - Cadastro de benefício externo;
- Admin - Extrato promocional externo;
- Admin - Fila de Notificação (benefícios utilizados).
OBS¹: Todas as documentações da WebAPI também estarão disponíveis no Swagger (em Basket) para acessá-lo, insita "web-api/docs/index#/" após a "/" na url do seu domínio (ex: https://minhaloja.core.dcg.com.br/web-api/docs/index#/):
OBS²: Para auxiliar no desenvolvimento, vamos disponibilizar um Dicionário de Dados que pode ser acessado por este LINK e uma Collection no Postman com todas as chamadas necessárias para lhe auxiliar nesta jornada:
Benefits.postman_collection_v2.json
OBS³: Por fim, além de todo o material já mencionado nos links anteriores, também disponibilizamos uma série de vídeos institucionais para apoiar durante a jornada de desenvolvimento em todas as etapas! Os mesmos estão disponíveis em "Vídeos institucionais".
Para eventuais dúvidas, nosso time de relacionamento ao cliente estará 100% a disposição para lhe auxiliar tanto no processo de configuração quanto as dúvidas que surgirem durante a utilização da nova funcionalidade.