A plataforma Linxcommerce possibilita que um sistema externo se conecte com a ferramenta para fazer a gestão de saldo e captura de meios de pagamento no estilo cartão fidelidade. Para integração da plataforma com seu ERP, será necessária a criação de um endpoint para comunicação. Durante vários fluxos da loja, essa URL será requisitada para verificar o saldo possuído por um cliente com sessão ativa no site.
O que são e onde utilizar o bônus de fidelidade:
O cartão fidelidade é uma funcionalidade para lojistas que permite a você uma forma de integrar o bônus exclusivo de clientes cadastrados entre a Linxcommerce e seu ERP. Dessa forma será possível ao cliente final acessar no carrinho e checkout a quantidade de “crédito” que possui.
O cartão fidelidade deverá ser utilizado em casos onde você possui alguma funcionalidade de fidelidade na loja. Por exemplo: bônus por compras anteriores ou alguma outra forma de gratificação por alguma ação do usuário, ou ainda, compra externa de valores na loja.
Como utilizar o bônus de fidelidade:
Para utilizar a fidelidade, será necessário cadastrar na Linxcommerce um meio de pagamento do tipo “Meio de pagamento com cartão fidelidade” e a criação de um endpoint externo para a comunicação da Linxcommerce com o serviço do lojista. Os passos abaixo assumem que você (lojista) já possui acesso ao menu administração da Linxcommerce.
Autenticação
A autenticação deverá ser com Basic Authentication (usuário e senha definidos na criação deste endpoint) e deverá aceitar um POST para < endpoint >/XXXX recebendo como parâmetro um content-type: application/json.
Create
Método POST para < endpoint >/create:
{
"card_id": "LO-0000",
"message": "Mensagem cartão fidelidade",
"is_valid": true,
"balance": "000",
"email": "[email protected]",
"document_number": "11111111111"
}
Campo | Tipo | Descrição |
card_id | String | - |
message | String | - |
is_valid | Boolean | - |
balance | String | Saldo |
String | E-mail do Cliente | |
document_number | String | CPF do cliente |
Balance
Buscar o valor disponível no cartão e exibir ao cliente:
{
"document_number": "11111111111", /*CPF*/
}
Campo | Tipo | Descrição |
document_number | string | CPF do cliente logado |
Response
O endpoint retornará um objeto no formato json conforme abaixo, para que a Linxcommerce possa exibir os valores do cliente na loja:
{
"balance": "20000.00",
}
Campo | Tipo | Descrição |
balance | decimal | Valor disponível para o cliente logado |
Capture
Ação para passar o valor que será capturado do cartão para transacionar na compra:
{
"order_number": "123144123",
"card": {
"card_id": "some value",
"document_number": "11111111111",
"email": "some value"
},
"value": 160
}
Campo | Tipo | Descrição |
order_number | String | Pedido da transação |
card_id | String | - |
document_number | String | CPF do cliente |
String | E-mail do cliente | |
value | Integer | Valor para a ser descontado da transação a ser paga |
Response
A API deverá devolver o identificador da transação.
{
"transaction_id": "D53215DD-F2B2-436A-B1D2-84FE29F572EF"
}
Campo | Tipo | Descrição |
transaction_id | String | Identificador da transação gerado pelo serviço externo. |
StatementHtml
Retorna o extrato do cartão, em HTML, para ser exibido na área do cliente.
{
"document_number": "11111111111",
}
Campo | Tipo | Descrição |
document_number | String | CPF do cliente |
Configuração básica
Este passo assume que o endpoint para comunicação externa já foi previamente criado.
- Acesse a tela de gerenciamento de meios de pagamento em Configs > Meios de pagamento > Adicionar meio de pagamento
- No campo Fornecedor de Serviço, escolha Pagamento com cartão fidelidade
![567](https://files.readme.io/c65353e-3.png)
- Preencha os campos na aba Dados Gerais e Restrições
![567](https://files.readme.io/c35850a-4.png)
![835](https://files.readme.io/23560f9-14.png)
- Na aba Integrações, é preciso informar o endpoint previamente criado. Preencha os outros campos.
![1221](https://files.readme.io/7fcb072-testesteste.png)