👩‍💻 Fluxo básico de utilização

Como obter e o que é o Token da API

O token da plataforma de fidelidade pode ser obtido através da sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar.

Procure saber se a plataforma de fidelidade possuí franquias (também chamado de filiais) dentro do sistema, cada loja/franquia/filial tem seu próprio token de API, em que as requisições de cadastro/pontuação já vincularão essa ação para a franquia dona do token de API. Para acessar o token de cada uma das franquias, realize o passo a passo:

  • Entre na plataforma de controle com o usuário de admin da filial escolhida;

  • Clique no menu "Configurações Sistema" > "Integrações" > "API";

  • Será exibido o Token da filial escolhida;

______________________________________________________________________________________________________

Qual a chave que identifica os consumidores / clientes?

Ao criar sua plataforma é possível escolher qual será a chave que irá ser o identificador único dos consumidores / clientes cadastrados no seu programa de fidelidade. Você pode optar por:

  • CPF ou CNPJ

  • Telefone com DDD

Atenção: Após selecionar algum identificador acima, você deve utiilzá-lo em todo seu programa de fidelidade, isto é, todos os endpoint obrigarão o preenchimento destes parâmetros dependendo da sua regra de negócio. Os demais parâmetros não serão identificadores do seu consumidor e não servirão como filtro nos endpoints da API Se quiser, você também poderá alterar a regra de identificação do consumidor, veja mais detalhes aqui.

______________________________________________________________________________________________________

Fluxo básico - Cadastro, pontuação e resgate de prêmios.

Para cadastrar um consumidor dentro do programa de fidelidade você deve utilizar o endpoint presente na nossa documentação https://docs.fidelimax.com.br/clientes/cadastro-de-cliente-via-api, após isso, já será possível você pontuar o consumidor dentro do programa de fidelidade utilizando nosso endpoint presente na nossa documentação https://docs.fidelimax.com.br/pontuacao/pontuar.

O resgate de prêmios é uma regra do programa de fidelidade que pode ser ativada dependendo do cenário de cada cliente, quando o consumidor quiser resgatar algum dos prêmios disponiveis para ele o endpoint a ser utilizado neste resgate está presente na documentação https://docs.fidelimax.com.br/premios/resgate-de-premio

Fluxo básico - Cadastro, pontuação e resgate de cashback.

Para cadastrar um consumidor dentro do programa de fidelidade você deve utilizar o endpoint presente na nossa documentação https://docs.fidelimax.com.br/clientes/cadastro-de-cliente-via-api, após isso, já será possível você pontuar o consumidor dentro do programa de fidelidade utilizando nosso endpoint presente na nossa documentação https://docs.fidelimax.com.br/pontuacao/pontuar.

O resgate de cashback é uma regra do programa de fidelidade que pode ser ativada dependendo do cenário de cada cliente, quando o consumidor quiser resgatar o valor de cashback, este resgate pode ser feito no endpoint presente na documentação https://docs.fidelimax.com.br/premios/resgate-de-cashback

Fluxo básico - Como mostro os dados de pontos do consumidor

Se você deseja apresentar o saldo de pontos, prêmios que o consumidor já pode resgatar pela pontuação que ele já possui e seu saldo de cashback, o endpoint a ser utilizado é o presente nesta documentação https://docs.fidelimax.com.br/clientes/consultar

O saldo de cashback só é apresentado quando o programa de fidelidade estiver com a regra de cashback ativada.

Last updated