❤️Motor de pontos

Aqui você vai conseguir encontrar tudo relacionado ao Motor de Pontos do programa de fidelidade de uma determinada loja.

Adicionando pontuação para um cliente

Nesse endpoint você vai conseguir adicionar pontos para um cliente específico. Nesse endpoint você irá precisar estar autenticado, verifique como aqui: Autenticando.

Adiciona pontuação para um CPF/CNPJ

POST https://sandbox.fidelizarmais.com/api/v1/private/motor-of-points/credit

Para adicionar pontuação para um documento, é necessário autenticar.

Body Example

{ "accountManager": "{{_email}}",

"storeId": "{{_storeId}}",

"document": "{{_document}}",

"type": 4,

"realValue": 100,

"partner": 0,

"shopForSale": 1,

"currencyType": 1,

"shortDescription": "Compra teste",

"approved": true,

"validMember": false,

"withReturn": true,

"settingsValid":true }

Headers

Name	Type	Description
store-key*	guid	id da loja
secret-key*	guid	chave secreta
Authorization	String	Jwt (accessTokenobtido na autenticação)

Request Body

Name	Type	Description
accountManager*	string	responsável por adicionar essa pontuação
storeId*	guid	id da loja
document*	string	documento (CPF/CNPJ)
type*	int	tipo de pontuação (4 é compra, existem mais opções em Lista de dados > scoreType)
realValue*	decimal	valor em reais (100.00)
partner*	int	colocar 0, significa que a pontuação foi manual
shopForSale*	int	1 (sempre)
currencyType*	int	1 (sempre)
shortDescription*	string	descrição curta da pontuação (Ex: "Compra manual")
approved*	bool	true (sempre)
validMember*	bool	se true valida se o cliente tem cadastro, caso coloque false o sistema não irá validar. Recomendamos colocar: false
withReturn*	bool	se true retorna os dados do cliente, caso coloque false o sistema não retorna dados. Recomendamos colocar: false
settingsValid*	bool	se true verifica se tem regra cadastrada, caso coloque false o sistema não verifica. Recomendamos colocar true

200: OK

Resgatar pontos gerando cupom de desconto no e-commerce

Nesse endpoint você consegue resgatar um prêmio específico gerando cupom no e-commmerce caso seja um prêmio do tipo cupom.

Resgata uma pontuação referente a um prêmio, gerando cupom no plataforma de e-commerce selecionada.

POST https://sandbox.fidelizarmais.com/api/v1/protected/motor-of-points/partner-redemption

Body Example

{ "accountManager": "teste",

"awardId": "a49f4aab-7029-4a21-b332-3fe6fc2a33f0",

"cashback": false,

"categoryAwardId": "5deab305-a72d-44e3-8248-0ace49c7e8c6",

"document": "•••••••",

"partnerGroupId": "4835ea58-e310-4b3f-aa58-b124125b063d",

"points": 100,

"shortDescription": "Resgate teste",

"storeId": "•••••••",

"type": 18,

"validMember": true,

"withReturn": true }

Headers

Name	Type	Description
store-key*	guid	id da loja
secret-key*	guid	chave secreta

Request Body

Name	Type	Description
accountManager*	string	responsável por adicionar essa pontuação
storeId*	guid	id da loja
document*	string	documento (CPF/CNPJ)
type*	int	tipo de pontuação (18 é resgate)
points*	decimal	valor em pontos (100.00)
partnerGroupId*	guid	deve colocar o id da sua plataforma de e-commerce, disponível em: Lista de dados > partners)
shortDescription*	string	descrição curta do resgate (Ex: "Resgate teste")
validMember*	bool	se true valida se o cliente tem cadastro, caso coloque false o sistema não irá validar. Recomendamos colocar: false
withReturn*	bool	se true retorna os dados do cliente, caso coloque false o sistema não retorna dados. Recomendamos colocar: false
settingsValid*	bool	se true verifica se tem regra cadastrada, caso coloque false o sistema não verifica. Recomendamos colocar true
awardId	guid	id do prêmio que deve ser resgatado. Dado informado na listagem dePrêmios
categoryAwardId	guid	categoria do prêmio resgatado. Dado informado na listagem dePrêmios

200: OK

Resgatar pontos sem gerar cupom no e-commerce

Nesse endpoint você vai conseguir resgatar pontos sem que um cupom seja gerado no e-commerce. Nesse endpoint você irá precisar estar autenticado, verifique como aqui: Autenticando.

Resgata uma pontuação, sem gerar cupom caso seja do tipo cupom.

POST https://sandbox.fidelizarmais.com/api/v1/private/motor-of-points/redemption

Body Example

{ "accountManager": "teste",

"awardId": "•••••••",

"cashback": false,

"categoryAwardId": "•••••••",

"document": "•••••••",

"partner": "0",

"shortDescription": "Resgate teste",

"storeId": "•••••••",

"currencyType": 1,

"shopForSale": 1,

"type": 19,

"validMember": true,

"withReturn": true,

"approved": true,

"active": true }

Headers

Name	Type	Description
store-key*	guid	id da loja
secret-key*	guid	chave secreta
Authorization	String	Jwt {coloque oaccessTokenobtido na autenticação aqui}

Request Body

Name	Type	Description
accountManager*	string	responsável por adicionar essa pontuação
storeId*	guid	id da loja
document*	string	documento (CPF/CNPJ)
type*	int	tipo de pontuação (19)
points*	decimal	valor em pontos (100.00)
partner*	int	0 (sempre)
shortDescription*	string	descrição curta do resgate (Ex: "Resgate teste")
validMember*	bool	se true valida se o cliente tem cadastro, caso coloque false o sistema não irá validar. Recomendamos colocar: false
withReturn*	bool	se true retorna os dados do cliente, caso coloque false o sistema não retorna dados. Recomendamos colocar: false
settingsValid*	bool	se true verifica se tem regra cadastrada, caso coloque false o sistema não verifica. Recomendamos colocar true
awardId*	guid	id do prêmio que deve ser resgatado. Dado informado na listagem dePrêmios
categoryAwardId*	guid	categoria do prêmio resgatado. Dado informado na listagem dePrêmios
shopForSale*	int	1 (sempre)
currencyType*	int	1 (sempre)
approved*	bool	true sempre
active*	bool	true sempre

200: OK

Verificando saldo por documento

Você pode verificar o saldo de um cliente no programa da loja à partir desse endpoint.

Busca o saldo por CPF/CNPJ

GET https://sandbox.fidelizarmais.com/api/v1/protected/check-balance

Para encontrar um cliente é obrigatório passar o storeId (id da loja) e o document (CPF/CNPJ) do cliente na QueryString.

Path Parameters

Name	Type	Description
storeId*	guid	id da loja
document*	string	CPF/CNPJ somente números

Headers

Name	Type	Description
store-key*	guid	id da loja
secret-key*	guid	chave secreta

200: OK