# 👩💻 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/resgates/relatórios já vincularão essa ação para a franquia dona do token de API.\
\
Se seu cliente tiver mais de uma loja essa etapa é obrigatória para o desenvolvimento na integração. Pois, senão todas as suas ações de integrações estarão vinculadas somente a uma única loja.\
\
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
{% hint style="info" %}
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](https://fidelimax.zendesk.com/hc/pt-br/articles/360022108071-Meios-e-Tipos-de-Cadastro-de-Clientes).
{% endhint %}
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
## 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 , 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
## 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 , 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
## 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
O saldo de cashback só é apresentado quando o programa de fidelidade estiver com a regra de cashback ativada.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.fidelimax.com.br/fluxo-basico-de-utilizacao.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.