Integração Dito Cashback via API

Passo a passo

Criação do Dashboard de teste/homologação
- Abra um ticket solicitando a criação de um novo dashboard, onde serão feitos os testes da integração.
- Solicite a habilitação do motor de cashback da Dito (via ticket).
Criação da Service Account (SA) para utilização das APIs de cashback:
- Abrir ticket e solicitar a criação de uma SA com um email corporativo.
- Com o seguinte perfil de cashback: Cashback Rewards Admin (listagem de cashback e resgate de cashback).
- Você vai receber um email para a criação de senha.
Com essa senha, acesse nossa API da Dito e faça uma requisição na rota de Authentication para gerar um token.
Utilize o token gerado para a autenticação na API de Cashback.

Observações:
- Este token deve ser inserido no header das requisições no seguinte formato: Authentication: Bearer <token-gerado>.
- Este token expira dentro de 24 horas. Então, após esse tempo, é necessário gerar um novo token.
Analisando/Entendendo as rotas da API no fluxo do cashback

Pontos importantes:
- As três rotas que compoem o fluxo de resgate de cashback:
  - Lock: Realiza o cálculo e a reserva do valor disponível de cashback para ser utilizado em uma determinada compra. O cálculo é feito baseado na regra de resgate estabelecida pela marca, considerando o valor da compra.
  - Commit: Confirma a utilização do cashback que foi reservado pela rota de Lock.
  - Rollback: Cancela a reserva do cashback realizada pela rota de Lock, liberando o valor novamente para uso.
- Rotas para listar cashback:
  - Listagem de Cashback: Rota responsável por listar todos os cashbacks do cliente, independente do status.
- Rotas de consulta de saldo de cashback:
  - Consulta saldo do cliente: Rota responsável por disponibilizar o saldo total do cliente. Possui informações sobre o saldo indisponível, disponível e o disponível para a próxima compra.
- Rota de cancelamento:
  - Cancelamento: Rota responsável por realizar o estorno de um cashback utilizado em uma compra ou o cancelamento de um cashback gerado.
- Rota de simulação:
  - Simulação: Realiza uma simulação de um Lock, porém sem efetuar a reserva de valor de fato. Ideal para entender qual seria o valor Lockado para um determinado valor de compra.
- Outras rotas:
  - Existem outras rotas na API que estão relacionadas ao uso do Super App da Dito para resgatar cashback. Porém, elas podem ser ignoradas para a sua implementação.
Valide realizando os seguintes testes e suas respectivas respostas (erros ou sucessos):

Obs.: Para fazer esses testes você precisa gerar os eventos usando nossa API de eventos.
- Listar cashbacks de clientes que possuem cashbacks gerados.
- Listar cashbacks de clientes que não possuem cashbacks.
- Listar cashbacks de clientes que não existem/com cadastro inválido.
- Consultar saldo de cliente que não possui cashbacks.
- Consultar saldo de cliente que possui somente cashbacks indisponíveis.
- Consultar saldo de cliente que possui somente cashbacks disponíveis.
- Consultar saldo de cliente que possui cashbacks indisponíveis e disponíveis.
- Realizar uma intenção de resgate de cashback (Lock) em um cliente que não possui cashback disponível.
- Realizar uma intenção de resgate de cashback (Lock) e depois confirmar o resgate (Commit).
- Realizar uma intenção de resgate de cashback (Lock) e depois cancelar o resgate (Rollback).
- Tentar confirmar o resgate (Commit) do cashback sem antes realizar a intenção de resgate (Lock).
- Tentar realizar o cancelamento do resgate (Rollback) sem antes realizar a intenção de resgate (Lock).
Abra um ticket solicitando a permissão da SA no dashboard oficial.
- Obs.: Neste momento, a Dito também faz a habilitação do motor de cashback para o dashboard oficial. Por isso, alinhe conosco sobre as regras de geração de cashback conforme sua estratégia.
Solicite a criação das campanhas de disparo de notificação de cashback para o time Dito.