Cadastro de Clientes
Cadastro de Clientes via API na Fidelimax
O Endpoint "CadastrarConsumidor" é utilizado para cadastrar novos consumidores (clientes) no programa de fidelidade via API. Geralmente é o endpoint mais utilizado e deve seguir a estrutura abaixo.
Atenção: Para utilizar a API da Fidelimax você precisará de um Token. Para obter seu token de integração vá em seu Painel de Controle, no menu esquerdo selecione Integrações e então escolha a opção API da Fidelimax. Clique em Quero Integrar e copie seu token.
O uso da API está disponível no Plano Max e no Plano Corp.
CadastrarConsumidor
POST
https://api.fidelimax.com.br/api/Integracao/CadastrarConsumidor
Exemplo no POSTMAN - https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-61946aed-281d-486e-9384-c429420ffff1
Headers
Name | Type | Description |
---|---|---|
AuthToken* | string | Token de Integração que esta na sua plataforma. |
Content-Type* | String | application/json |
Request Body
Name | Type | Description |
---|---|---|
nome | string | Nome do Consumidor |
cpf | string | CPF do Consumidor, o CPF é usado como chave para realizar a atualização. Campo obrigatório se telefone ou cartao não forem enviados |
sexo | string | Sexo do Consumidor, Masculino e Feminino |
nascimento | string | Data de nascimento do Consumidor, formato dd/mm/yyyy |
string | E-mail do consumidor | |
telefone | string | Telefone do Consumidor, formato (11)99999-9999. Campo obrigatório se o cpf ou cartao não forem enviados |
cartao | string | Cartão que pode ser vinculado ao consumidor. Obs. Campo obrigatório se o CPF ou telefone não forem enviados |
saldo | integer | Saldo em pontos inicial que o consumidor pode iniciar |
endereco | Object | Objeto para conter o endereço do cliente. O cadastro do endereço do cliente irá para uma fila que checará o CEP do endereço do cliente para depois vincular o endereço a este cliente. |
endereco.cep | string | CEP de endereço do consumidor. Obrigatório caso o objeto de endereço seja enviado. |
endereco.numero | string | Número de endereço do consumidor. Até 10 caracteres |
endereco.rua | string | Rua de endereço do consumidor. Até 115 caracteres |
endereco.bairro | string | Bairro de endereço do consumidor. Até 115 caracteres |
endereco.complemento | string | Complemento de endereço do consumidor. Até 100 caracteres |
senha | string | Senha do Consumidor para acessar o programa de fidelidade. Obs. Esta senha só será cadastrada se o programa de fidelidade estiver configurado/habilitado paraa utilização de senhas. |
Em caso de dúvidas de como utilizar a API ou precisar de suporte técnico, acione nosso time de ajuda em https://www.fidelimax.com/br/ajuda
Last updated