🖥️Sugestão de Desenvolvimento

Antes de começar, é essencial que você tenha revisado nosso Fluxo Básico de Utilização e compreendido o funcionamento dos Tokens de API (tanto para lojas únicas quanto para filiais) e das chaves de identificação dos consumidores (CPF/CNPJ ou Telefone). Abaixo, descrevemos uma recomendação de desenvolvimento para integração com nossa API, focada em um processo faseado para facilitar a implementação.

Fase 1: Desenvolvimento Inicial da Integração (Versão 1)

Nesta etapa inicial, sugerimos que sua equipe foque na implementação das funcionalidades básicas do programa de fidelidade, que incluem as operações de vendas, cadastro de clientes e consulta de pontuações.

1. Consulta de Dados do Consumidor: Antes de realizar uma venda, é importante verificar se o cliente está cadastrado no programa de fidelidade e consultar sua pontuação e saldo de cashback atual. Para isso, utilize a API de consulta de consumidores. Documentação: Consultar Dados do Consumidor.

2. Cadastro de Consumidores: Caso o cliente não esteja cadastrado no programa de fidelidade, você pode cadastrá-lo através do nosso endpoint de cadastro de consumidores. Documentação: Cadastro de Cliente via API.

3. Pontuação de Consumidores: Ao realizar uma venda, é necessário enviar o valor pago pelo cliente para o nosso endpoint de pontuação. Documentação: Pontuar Consumidor.

Com essa fase concluída, seu cliente já terá automatizado uma parte significativa do processo de fidelidade, abrangendo vendas e o gerenciamento básico de clientes. Funcionalidades como resgates e estornos podem ser implementadas posteriormente, dependendo da demanda.

Fase 2: Expansão da Integração (Versão 2)

Nesta segunda etapa, sugerimos a implementação das funcionalidades de resgate de prêmios/cashback e estorno de vendas. Algumas destas operações utilizam o mesmo endpoint da fase anterior.

1. Consulta de Cashback e Prêmios: A consulta ao saldo de cashback e prêmios disponíveis para resgate é feita através do mesmo endpoint de consulta de consumidores já implementado. Documentação: Consultar Dados do Consumidor.

2. Estorno de Pontos:

   • Estorno Parcial: Para casos em que o cliente devolve apenas parte dos produtos comprados. Documentação: Estorno de Pontos Avulsos.

   • Estorno Total: Realizado no mesmo endpoint de pontuação, utilizando parâmetros específicos para estorno e verificador (que deve ser informado na venda original). Documentação: Pontuar Consumidor.

3. Resgate de Prêmios: O resgate de prêmios pode ser feito através do nosso endpoint específico, onde o cliente cadastra os prêmios na plataforma, com um identificador que será usado na API para indicar o prêmio a ser resgatado. Documentação: Resgate de Prêmios.

4. Resgate de Cashback: Realizado através do nosso endpoint dedicado. Documentação: Resgate de Cashback.

Considerações Finais

As etapas descritas acima são uma sugestão de desenvolvimento, mas é fundamental que você verifique com seu cliente quais funcionalidades são prioritárias para a integração. Nossa documentação oferece uma ampla gama de recursos adicionais, incluindo vouchers, categorias, vales-pontos, entre outros.