🐷
Fidelimax </API>
Central de AjudaSolicitar SuporteStatus dos SistemasIntegrações Nativas
  • 📌Visão Geral
  • 👩‍💻 Fluxo básico de utilização
  • 🖥️Sugestão de Desenvolvimento
  • 🤖Mapeamento da API
  • ⚙️Cenários de Uso
  • 💁‍♀️ Precisa de Suporte?
  • 🤝Clientes
    • Cadastro de Clientes
    • Atualização
    • Consultar
      • Retornar Dados
      • Listar Clientes
    • Deletar
    • Credenciais
      • Atualização de Senha
      • Validação das credenciais do consumidor
      • Lembrete de Senha
  • 🛍️ Pontuação
    • Pontuar
      • Pontuacao em Lote [EM DESENVOLVIMENTO]
      • Extrato
      • Estorno pontos avulsos
    • Vale pontos
      • Resgatar
    • 🤖Mapeamento Tipos Pontuações API
  • 🎁Premiação
    • Resgate de Prêmio
    • Cadastro de Prêmio
    • Atualização de Prêmios
    • Listar Prêmios
  • 🎫Voucher
    • Cadastro de Voucher
    • Consultar Voucher
    • Resgatar Voucher
  • 🪙 Cashback
    • Resgate de Cashback
    • Verificar Reais para Cashback
  • ⭐Categorias Fixas
    • Atualizar Categoria
    • Deletar Categoria
  • 👋 Indicação de Amigos
    • Indicar Amigos
  • 🔗Integrações Nativas
    • VTEX
    • Linx Microvix
    • WooCommerce
    • Bling
    • Wake
    • TOTVS Chef Web
    • Vhsys
    • TagPlus
    • Omie ERP
    • VarejOnline
    • Ifood
    • Tray
    • Gestão Click
    • IXC Soft
    • HubSoft
    • Galileu
    • TinyERP
    • Loja Integrada
    • Nuvemshop
    • Pipedrive
    • RpInfo
    • SHX GIX
    • Raffinato
    • ConnectPlug (Cplug)
    • Delivery Direto
    • Sige Cloud
    • Rakuten
    • Doação Solutions
  • 🤓Outras Infos
    • Webhooks
      • Cadastro de Consumidor
      • Pontuação de Consumidor
      • Resgate de prêmio por Consumidor
      • Cadastro de Consumidor Indicado
  • 🔗Links Úteis
  • Site Institucional
  • Postman
Powered by GitBook
On this page
  • Como obter e o que é o Token da API
  • Qual a chave que identifica os consumidores / clientes?
  • Fluxo básico - Cadastro, pontuação e resgate de prêmios.
  • Fluxo básico - Cadastro, pontuação e resgate de cashback.
  • Fluxo básico - Como mostro os dados de pontos do consumidor

Was this helpful?

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

PreviousVisão GeralNextSugestão de Desenvolvimento

Last updated 5 months ago

Was this helpful?

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 .

______________________________________________________________________________________________________

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

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

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

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

Para cadastrar um consumidor dentro do programa de fidelidade você deve utilizar o endpoint presente na nossa documentação , após isso, já será possível você pontuar o consumidor dentro do programa de fidelidade utilizando nosso endpoint presente na nossa documentação .

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

Para cadastrar um consumidor dentro do programa de fidelidade você deve utilizar o endpoint presente na nossa documentação , após isso, já será possível você pontuar o consumidor dentro do programa de fidelidade utilizando nosso endpoint presente na nossa documentação .

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

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

aqui
https://docs.fidelimax.com.br/clientes/cadastro-de-cliente-via-api
https://docs.fidelimax.com.br/pontuacao/pontuar
https://docs.fidelimax.com.br/premios/resgate-de-premio
https://docs.fidelimax.com.br/clientes/cadastro-de-cliente-via-api
https://docs.fidelimax.com.br/pontuacao/pontuar
https://docs.fidelimax.com.br/premios/resgate-de-cashback
https://docs.fidelimax.com.br/clientes/consultar