{"info":{"_postman_id":"91027ec6-790f-44e0-96fa-2442d034f1db","name":"API de Integração - Fidelizi","description":"

Sobre a Fidelizi

\n
\n

Usamos o Marketing de Fidelização para sua loja ter clientes fiéis que voltam sempre e compram mais.

\n
\n

A Fidelizi ajuda negócios do varejo físico a transformar clientes comuns em clientes leais e fãs da sua marca. Ajudamos varejistas a implementarem programas de fidelidade customizados com o intuito de criar uma base de dados sólida, para que ele conheça quem é de fato seu cliente para poder criar ações personalizadas que aumentam a recorrência de compras, o ticket médio e a satisfação do cliente.

\n

Veja nossa apresentação no vídeo abaixo:
https://www.youtube.com/watch?v=DGyXxB8T3Mc

\n

Referência da API

\n

Para cada requisição, a autenticação do estabelecimento é obrigatória. Ela deverá ser feita utilizando o App Token e o Access Token, que terá as permissões para acessar e realizar requisições relacionadas a um estabelecimento específico.

\n

As respostas da API são padronizadas no formato JSON, acompanhadas pelos respectivos códigos de status do protocolo HTTP, garantindo clareza na comunicação. Adicionalmente, é essencial que todas as requisições sejam feitas através do protocolo HTTPS, assegurando a segurança e a integridade dos dados transmitidos.

\n

Autenticação

\n
\n

Geração do token para utilização da API

\n
\n

Para efetuar solicitações à API, é necessário, primeiramente, criar um aplicativo na seção \"Integrações\" dentro do CRM. Uma vez criado, serão gerados dois tokens essenciais: o App Token e o Access Token. Estes tokens são fundamentais para autenticar as requisições feitas à API.

\n

É importante ressaltar que todas as requisições à API devem incluir o App Token e o Access Token no cabeçalho (header) da requisição. Essa prática assegura a correta autenticação e autorização das operações realizadas, mantendo a segurança e integridade da comunicação com a API.

\n
\n

Devido a preocupações com a segurança e para garantir a estabilidade e a eficiência do sistema, estabelecemos uma limitação no número de requisições à nossa API: agora, cada usuário poderá realizar no máximo 60 requisições por minuto.

\n
\n

Todas as respostas seguem o formato JSON com os seus respectivos código de status do protocolo HTTP, além de que todas as requisições devem utilizar o protocolo HTTPS.

\n
\n

O domínio para chamada a API no Sandbox é https://sandbox.fidelizii.com.br
O domínio para chamada a API em produção é https://integracao.fidelizii.com.br

\n
\n

Todas as requisições realizadas para a API, deverá ser enviado app e access token no header da requisição.

\n
Key
Value
appToken
{{appToken}}
accessToken
{{accessToken}}
\n\n

Gerando o token de autenticação

\n

Basta acessar o seu painel Meu Fidelizi, após isso, ir em Configurações e Integrações, após isso, vá na guia Integrações customizadas (API).

\n\n\n

Gere o seu token clicando em \"Novo aplicativo\", após isso, digite um nome para sua integração. (Para facilitar a sua identificação posteriormente)

\n\n\n

Após clicar em \"Gerar token\" será exibido o seu appToken e accessToken.

\n

Guarde suas credenciais em um local seguro, pois elas não serão exibidas novamente, caso perca será necessário gerar um novo aplicativo.

\n\n\n

Ambiente de Testes

\n

Para gerar um token a ser usado durante o desenvolvimento de sua integração, basta entrar em contato com nosso time através do email integracao@fidelizi.com.br.

\n

Nós iremos gerar um estabelecimento modelo configurado para que possa realizar a integração e os testes necessários.

\n

No ambiente de testes, a URL base a ser usada é: https://sandbox.fidelizii.com.br

\n
\n

Entendendo a mecânica de pontos

\n

O programa de fidelidade começa com um planejamento detalhado, onde nossa equipe de sucesso do cliente trabalha em conjunto com o responsável do estabelecimento para desenvolver uma estratégia de fidelização customizada.

\n

Este planejamento inclui a definição das regras de forma claras e atraente, além da seleção de prêmios atrativos para os clientes do estabelecimento.

\n

Uma vez que a estratégia está definida e implementada, o programa de fidelidade entra em ação. A mecânica de funcionamento é simples e eficaz: os atendentes do estabelecimento lançam pontos para os clientes através de um totem Fidelizi, um tablet contendo um aplicativo interativo e fácil de usar, colocado em um local acessível dentro do estabelecimento. Esses pontos são acumulados pelos clientes a cada compra, de acordo com as regras pré-estabelecidas.

\n

Após o acúmulo de pontos , os clientes podem então trocar esses pontos por uma variedade de prêmios, que podem variar desde descontos em produtos ou serviços até brindes exclusivos. Esse sistema de recompensas não apenas incentiva os clientes a retornarem, mas também cria uma experiência de compra mais envolvente e personalizada.

\n

Veja o vídeo abaixo com o fluxo:

\n

Fluxo de Pontuação no Totem Fidelizi

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Sobre a Fidelizi","slug":"sobre-a-fidelizi"},{"content":"Referência da API","slug":"referencia-da-api"},{"content":"Autenticação","slug":"autenticacao"},{"content":"Ambiente de Testes","slug":"ambiente-de-testes"},{"content":"Entendendo a mecânica de pontos","slug":"entendendo-a-mecanica-de-pontos"}],"owner":"10478718","collectionId":"91027ec6-790f-44e0-96fa-2442d034f1db","publishedId":"TVKD2chH","public":true,"customColor":{"top-bar":"834BE1","right-sidebar":"303030","highlight":"834BE1"},"publishDate":"2024-06-14T22:11:41.000Z"},"item":[{"name":"Programa de Fidelidade","item":[{"name":"Retornar configuração do programa de fidelidade","id":"983b5d07-dd02-49c5-b18b-47764895d1d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade","description":"

Nesta requisição será retornado todas as configurações relacionadas ao programa de fidelidade do estabelecimento.

\n","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","fidelidade"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e5c64c89-9826-47c9-ae9f-fb0f58a5b8a3","name":"Retornar configuração do programa de fidelidade","originalRequest":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 20:30:43 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 20:30:43 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"label\": \"Multi-prêmios por pontos\",\n \"validade\": 6,\n \"descricao\": \"Troque por Prêmios!\",\n \"chamada\": \"Junte pontos e:\",\n \"observacao\": \"A cada R$ 10,00 gastos você ganha 1 ponto\",\n \"id_parceiro\": \"0000\",\n \"conversao_dinheiro\": {\n \"ativo\": 1,\n \"pontos\": 1,\n \"valor\": 10\n },\n \"carencia_ponto\": \"dia-conquista\",\n \"travas_seguranca\": {\n \"interacoes_dia\": 10,\n \"intervalo_interacoes\": 0,\n \"minimo_pontos_interacao\": 1,\n \"maximo_pontos_interacao\": 1000\n },\n \"atendentes\": {\n \"solicitar_senha_pontuar\": 1,\n \"solicitar_senha_resgate\": 1\n },\n \"premios_fidelidade\": [\n {\n \"id_premio\": 11111,\n \"id_parceiro\": 11111,\n \"nome\": \"R$ 10,00 de desconto em sua próx. compra\",\n \"preco_odometro\": 100,\n \"resgate_mesmo_dia\": 0,\n \"tipo_beneficio\": \"vale_compras\",\n \"valor_beneficio\": 10\n },\n {\n \"id_premio\": 11111,\n \"id_parceiro\": 11111,\n \"nome\": \"Suco de Laranja\",\n \"preco_odometro\": 150,\n \"resgate_mesmo_dia\": 0,\n \"tipo_beneficio\": \"produto_servico\",\n \"valor_beneficio\": null\n },\n {\n \"id_premio\": 11111,\n \"id_parceiro\": 11111,\n \"nome\": \"10% de desconto em sua próx. compra\",\n \"preco_odometro\": 150,\n \"resgate_mesmo_dia\": 0,\n \"tipo_beneficio\": \"desconto_percentual_compra\",\n \"valor_beneficio\": 10\n },\n {\n \"id_premio\": 11111,\n \"id_parceiro\": 11111,\n \"nome\": \"10% de desconto em itens da linha X\",\n \"preco_odometro\": 150,\n \"resgate_mesmo_dia\": 0,\n \"tipo_beneficio\": \"desconto_percentual_item\",\n \"valor_beneficio\": 10\n },\n {\n \"id_premio\": 11111,\n \"id_parceiro\": 11111,\n \"nome\": \"10 pontos adicionais no programa de fidelidade\",\n \"preco_odometro\": 150,\n \"resgate_mesmo_dia\": 0,\n \"tipo_beneficio\": \"fidelidade\",\n \"valor_beneficio\": 10\n }\n ]\n}"}],"_postman_id":"983b5d07-dd02-49c5-b18b-47764895d1d6"},{"name":"Pontuar um cliente no programa de fidelidade","id":"2620bca9-4f34-4dbc-885a-7a4dde19c487","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"valor_gasto\": 100,\n \"cpf\": \"11111111111\",\n \"senha_atendente\": \"10sasaas08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade/pontuar","description":"

Registrar o valor gasto por um determinado cliente e registrar sua pontuação de acordo com a regra do programa de fidelidade.

\n","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","fidelidade","pontuar"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3aa8de9a-8705-429a-86a3-2c46395e3030","name":"Pontuar um cliente no programa de fidelidade","originalRequest":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"valor_gasto\": 100,\n \"cpf\": \"11111111111\",\n \"senha_atendente\": \"1111\" \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade/pontuar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 20:40:00 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 20:40:00 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"id_cartela_cliente\": 111111,\n \"id_parceiro_origem\": 11111,\n \"qtd_ponto\": 10,\n \"date_ponto\": \"2020-01-01 23:59:59\",\n \"client_check_id\": \"ccd0fb4a20198c5b6362376bcf1508c5ace2d2\",\n \"id_ponto\": 111111,\n \"id_cliente\": 111111,\n \"ponto_dinheiro\": {\n \"id_ponto_dinheiro\": 111111,\n \"id_ponto\": 111111,\n \"dinheiro_gasto\": \"100.00\",\n \"conversao_ponto\": 1,\n \"conversao_dinheiro\": \"10.00\"\n }\n}"}],"_postman_id":"2620bca9-4f34-4dbc-885a-7a4dde19c487"},{"name":"Efetuar resgate de um prêmio do programa de fidelidade","id":"343de8d1-a994-4ad4-9c20-eee8f87c5212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"id_premio\": 111111,\n \"id_cliente\": 111111,\n \"senha_atendente\": \"11111\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade/resgatar-premio","description":"

Efetuar o resgate de um prêmio do programa de fidelidade por um cliente com o saldo atual de pontos.

\n","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","fidelidade","resgatar-premio"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"04e1836a-03ba-4ceb-82c8-f5e790cc12dd","name":"Efetuar resgate de um prêmio do programa de fidelidade","originalRequest":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"id_premio\": \"1111\",\n \"id_cliente\": \"111111\",\n \"senha_atendente\": \"1111\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade/resgatar-premio"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 21:01:40 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:01:40 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Prêmio resgatado com sucesso\",\n \"data\": {\n \"id_cliente\": 111111,\n \"id_premio\": 11111,\n \"date_validade\": \"2021-07-17 23:59:59\",\n \"date_retirada\": \"2021-07-16 11:15:30\",\n \"id_parceiro_origem_retirada\": 1111,\n \"date_ganhou\": \"2021-07-16 11:15:30\",\n \"id_parceiro_origem\": 1111,\n \"client_check_id\": \"6100d13111f5d50eec740f86b0aff05f1b2fdbfae\",\n \"id_premio_cliente\": 11111,\n \"id_ponto_gasto\": 1111,\n \"esta_vencido\": false,\n \"foi_resgatado\": true,\n \"premio\": {\n \"id_premio\": 1111,\n \"nome\": \"Vale compras R$ 75,00\",\n \"tipo_beneficio\": \"vale_compras\",\n \"valor_beneficio\": 75\n },\n \"ponto_gasto\": {\n \"ponto_gasto_id\": 1111,\n \"qtd_ponto_gasto\": 150,\n \"date_ponto_gasto\": \"2021-07-16 11:15:30\",\n \"id_parceiro_origem\": 1111\n }\n }\n}"}],"_postman_id":"343de8d1-a994-4ad4-9c20-eee8f87c5212"},{"name":"Efetuar estorno de um prêmio do programa de fidelidade","id":"e180e240-a47f-4949-b7de-1e5ff945a79a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"id_premio_cliente\": 111111,\n \"motivo\": \"Estorno realizado para testes\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade/estornar-premio","description":"

Efetuar o resgate de um prêmio do programa de fidelidade por um cliente com o saldo atual de pontos.

\n","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","fidelidade","estornar-premio"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"62bb934e-be26-4768-af57-40d2b658b71a","name":"Efetuar estorno de um prêmio do programa de fidelidade","originalRequest":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"id_premio_cliente\": 111111,\n \"motivo\": \"Estorno realizado para testes\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade/estornar-premio"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Estorno do prêmio efetuado com sucesso\",\n \"data\": {\n \"id_premio_cliente\": 1111,\n \"id_cliente\": 11111,\n \"id_premio\": 1111,\n \"date_validade\": \"2021-07-17 23:59:59\",\n \"date_retirada\": \"2021-07-16 11:17:29\",\n \"date_ganhou\": \"2021-07-16 11:17:29\",\n \"id_parceiro_origem\": 1111,\n \"id_parceiro_origem_retirada\": 1111,\n \"client_check_id\": \"0fcdba06c7121d83090e173b001f91e8d134465a\",\n \"id_desafio_cliente\": null,\n \"id_ponto\": null,\n \"id_ponto_gasto\": 1111,\n \"motivo_estorno\": \"Estorno realizado para testes - via API de Integração\",\n \"estornada_em\": \"2021-07-16 11:17:38\",\n \"esta_vencido\": false,\n \"foi_resgatado\": true,\n \"premio\": {\n \"id_premio\": 1111,\n \"id_parceiro\": 11111,\n \"nome\": \"Vale compras R$ 75,00\",\n \"descricao\": \"Vale compras R$ 75,00\",\n \"tipo_beneficio\": \"vale_compras\",\n \"valor_beneficio\": 75\n },\n \"ponto_gasto\": {\n \"ponto_gasto_id\": 1111,\n \"id_cartela_cliente\": 1111,\n \"qtd_ponto_gasto\": 150,\n \"date_ponto_gasto\": \"2021-07-16 11:17:29\",\n \"id_parceiro_origem\": 11111,\n \"cancelado\": 1\n }\n }\n}"}],"_postman_id":"e180e240-a47f-4949-b7de-1e5ff945a79a"},{"name":"Atribuir um prêmio a um determinado cliente","id":"2aa1577f-c3b3-4f7f-a5d0-f5cd4ae85a89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id_cliente\": \"1111111\",\n \"id_premio\": \"111111\",\n \"senha_atendente\": \"11111\",\n \"auto_resgatar\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/fidelidade/atribuir-premio","description":"

Realizar a atribuição de um prêmio manualmente a um cliente.

\n

OBS: Apenas premiações do tipo brindes da roleta, Prêmios de campanha e Prêmios surpresa são permitidos a atribuição manual.

\n

Prêmios do programa de fidelidade somente podem ser conquistados através da troca por pontos do programa.

\n","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","fidelidade","atribuir-premio"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2aa1577f-c3b3-4f7f-a5d0-f5cd4ae85a89"}],"id":"2f218b9f-062f-41c3-909f-dbbf84c77523","description":"

Para trabalhar com o programa de fidelidade na Fidelizi, será necessário usar os seguintes endpoints abaixo para realizar a busca de informações das regras configuradas. Elas serão necessárias para os lançamentos de pontos a um determinado cliente e também para efetuar operações como resgate e estorno de premiações.

\n","event":[{"listen":"prerequest","script":{"id":"3cfc5fec-9943-4df4-bff6-0bf81b90a434","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1db28960-ad4b-44bf-bd6d-83644d51ca0a","type":"text/javascript","exec":[""]}}],"_postman_id":"2f218b9f-062f-41c3-909f-dbbf84c77523"},{"name":"Clientes","item":[{"name":"Retornar todos os clientes de um estabelecimento","id":"aaf2a44e-b875-492d-923d-16acd2771cf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes","description":"

Retornar listagem dos clientes cadastrados no programa de fidelidade de um determinado estabelecimento

\n","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","clientes"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Filtrar os clientes pelo nome

\n","type":"text/plain"},"key":"nome","value":"CLIENTE TESTE281"},{"disabled":true,"description":{"content":"

Filtrar os clientes pela data inicial de cadastro

\n","type":"text/plain"},"key":"data_inicio","value":"2024-01-01 00:00:00"},{"disabled":true,"description":{"content":"

Filtrar os clientes pela data final de cadastro

\n","type":"text/plain"},"key":"data_fim","value":"2024-06-01 00:00:00"}],"variable":[]}},"response":[{"id":"2c445bc2-26d2-4aae-a633-95ff80f7f99b","name":"Retornar todos os clientes de um estabelecimento","originalRequest":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 21:23:15 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:23:14 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"current_page\": 1,\n \"data\": [\n {\n \"id_cliente\": 11111,\n \"nome\": \"FIDEWIZARD\",\n \"celular\": \"+5519999999999\",\n \"email\": \"email@email.com.br\",\n \"codigo_indicador\": \"fidewizardb726170\",\n \"origem_cadastro\": \"tablet\"\n },\n {\n \"id_cliente\": 1111,\n \"nome\": \"FIDEWIZARD\",\n \"celular\": \"+5519999999999\",\n \"email\": \"email@email.com.br\",\n \"codigo_indicador\": \"fidewizardb726170\",\n \"origem_cadastro\": \"tablet\"\n },\n {\n \"id_cliente\": 11111,\n \"nome\": \"FIDEWIZARD\",\n \"celular\": \"+5519999999999\",\n \"email\": \"email@email.com.br\",\n \"codigo_indicador\": \"fidewizardb726170\",\n \"origem_cadastro\": \"tablet\"\n } \n ],\n \"first_page_url\": \"https://integracao.fidelizii.com.br/v3/estabelecimentos/1111/clientes?page=1\",\n \"from\": 1,\n \"last_page\": 483,\n \"last_page_url\": \"https://integracao.fidelizii.com.br/v3/estabelecimentos/1111/clientes?page=483\",\n \"next_page_url\": \"https://integracao.fidelizii.com.br/v3/estabelecimentos/1111/clientes?page=2\",\n \"path\": \"https://integracao.fidelizii.com.br/v3/estabelecimentos/1111/clientes\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 15,\n \"total\": 7245\n}"}],"_postman_id":"aaf2a44e-b875-492d-923d-16acd2771cf8"},{"name":"Retornar informações de um cliente específico","id":"be43224a-d9f4-4935-b319-b0dc0c412b95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes/{{id_cliente}}","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","clientes","{{id_cliente}}"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

Campo tipo \"bool\" para incluir ou não as transações

\n","type":"text/plain"},"key":"transacoes","value":"1"},{"disabled":true,"description":{"content":"

Páginação das transações, padrão 1

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Quantidade de itens por página, padrão 15

\n","type":"text/plain"},"key":"per_page","value":"15"},{"disabled":true,"description":{"content":"

Data para filtrar as transações, padrão primeiro dia do mês atual

\n","type":"text/plain"},"key":"data_inicio","value":"2024-12-01"},{"disabled":true,"description":{"content":"

Data final para filtrar as transações, padrão dia atual

\n","type":"text/plain"},"key":"data_fim","value":"2024-12-10"}],"variable":[]}},"response":[{"id":"7a15fe3f-73f3-43cb-bfeb-9534c01e096f","name":"Retornar informações de um cliente específico","originalRequest":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes/{{id_cliente}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 21:26:50 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:26:50 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"id_cliente\": 1111111,\n \"nome\": \"Cliente de Exemplo\",\n \"email\": \"email@email.com.br\",\n \"cartela_atual\": {\n \"id_cartela_cliente\": 111111,\n \"id_cliente\": 111111,\n \"id_parceiro_origem\": 11111,\n \"proxima_validade_data\": \"01/01/2021\",\n \"proxima_validade_pontos\": 10,\n \"vencimentos\": [],\n \"saldo\": 1000,\n \"saldo_carencia\": 0\n },\n \"frequencia\": {\n \"frequencia_mes_atual\": 3.5,\n \"frequencia_mes_passado\": 0.11787072243346007,\n \"visitas_mes_atual\": 6,\n \"visitas_mes_passado\": 263\n },\n \"avaliacoes\": {\n \"media\": 0,\n \"todos\": []\n },\n \"pontos_conquistados_total\": 7446,\n \"gastos\": {\n \"total\": 38130.35999999999,\n \"ticket_medio_desde_inicio\": 146.0933333333333,\n \"ticket_medio_mes_atual\": 1866.6666666666667,\n \"ticket_medio_mes_passado\": 105.60925490196078,\n \"todos\": {\n \"2020-09-21\": 100,\n \"2020-09-11\": 11100,\n \"2020-08-31\": 443.25,\n \"2020-08-30\": 100,\n \"2020-08-27\": 210,\n \"2020-08-26\": 753,\n \"2020-08-25\": 50,\n \"2020-08-24\": 51,\n \"2020-08-23\": 1271,\n \"2020-08-22\": 80,\n \"2020-08-21\": 6371,\n \"2020-08-20\": 12060,\n \"2020-08-19\": 270,\n \"2020-08-18\": 260,\n \"2020-08-14\": 520,\n \"2020-08-13\": 158,\n \"2020-08-12\": 142,\n \"2020-08-06\": 3167.09,\n \"2020-08-05\": 216.28,\n \"2020-08-04\": 807.74\n }\n },\n \"premios_conquistados\": [\n {\n \"id_premio_cliente\": 1111,\n \"id_premio\": 1111,\n \"id_cliente\": 1111,\n \"date_validade\": \"2018-12-12 16:05:44\",\n \"date_retirada\": \"2018-12-11 16:05:44\",\n \"date_ganhou\": \"2018-12-11 16:05:44\",\n \"estornada_em\": null,\n \"motivo_estorno\": null,\n \"esta_vencido\": false,\n \"foi_resgatado\": true,\n \"premio\": {\n \"id_premio\": 1111,\n \"nome\": \"Vale compras R$ 500,00\",\n \"tipo\": \"premio\",\n \"tipo_beneficio\": \"vale_compras\",\n \"valor_beneficio\": 500\n }\n } \n ],\n \"transacoes\": {\n \"headers\": {},\n \"original\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"data_evento\": \"2024-11-28 17:18:57\",\n \"data_evento_formatada\": \"28/11/2024 às 17:18\",\n \"id_cliente\": 279,\n \"origem\": \"Via Totem Fidelizi\",\n \"titulo\": \"Ganhou pontos\",\n \"descricao\": null,\n \"cliente\": {\n \"id_cliente\": 279,\n \"nome\": \"279#CLIENTE TESTE279\",\n \"celular\": \"67991360278\",\n \"data_cadastro\": \"2013-11-10 13:06:00\"\n }\n }\n ],\n \"first_page_url\": \"http://localhost:8081/v3/estabelecimentos/31/clientes/279?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://localhost:8081/v3/estabelecimentos/31/clientes/279?page=1\",\n \"next_page_url\": null,\n \"path\": \"http://localhost:8081/v3/estabelecimentos/31/clientes/279\",\n \"per_page\": \"15\",\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n },\n \"exception\": null\n },\n \"codigo_indicador\": \"cliente4c0102a\",\n \"origem_cadastro\": \"tablet\"\n}"}],"_postman_id":"be43224a-d9f4-4935-b319-b0dc0c412b95"},{"name":"Retornar informações de um cliente específico através do CPF e/ou Email e/ou Celular","id":"06abd97e-4673-4fb8-bae0-e41b283170fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes?cpf=11111111111","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","clientes"],"host":["{{base_url}}"],"query":[{"description":{"content":"

Buscar o cliente através do CPF

\n","type":"text/plain"},"key":"cpf","value":"11111111111"},{"disabled":true,"description":{"content":"

Buscar o cliente através do email

\n","type":"text/plain"},"key":"email","value":"email@fidelizi.com.br"},{"disabled":true,"description":{"content":"

Buscart o cliente através do celular

\n","type":"text/plain"},"key":"celular","value":"5519999999999"}],"variable":[]}},"response":[{"id":"2022215b-1115-4096-a2cb-8dbd8ee76afd","name":"Retornar informações de um cliente específico através do CPF","originalRequest":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":{"raw":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes?cpf=11111111111","host":["{{base_url}}"],"path":["v3","estabelecimentos","{{id_parceiro}}","clientes"],"query":[{"key":"cpf","value":"11111111111"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 21:30:25 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:30:25 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"current_page\": 1,\n \"data\": [\n {\n \"id_cliente\": 11111,\n \"nome\": \"CLIENTE TESTE#1111\",\n \"celular\": null,\n \"email\": \"cliente_111111_teste@fidelizi.com.br\",\n \"cartela_atual\": {\n \"id_cartela_cliente\": 11111,\n \"id_cliente\": 11111,\n \"id_parceiro_origem\": 11111,\n \"proxima_validade_data\": \"31/10/2021\",\n \"proxima_validade_pontos\": 1282,\n \"vencimentos\": [],\n \"saldo\": 1282,\n \"saldo_carencia\": 0\n },\n \"frequencia\": {\n \"frequencia_mes_atual\": 0,\n \"frequencia_mes_passado\": 0,\n \"visitas_mes_atual\": 0,\n \"visitas_mes_passado\": 0\n },\n \"avaliacoes\": {\n \"media\": null,\n \"todos\": []\n },\n \"pontos_conquistados_total\": 27532,\n \"gastos\": {\n \"total\": 275465.94,\n \"ticket_medio_desde_inicio\": 4515.83,\n \"ticket_medio_mes_atual\": 0,\n \"ticket_medio_mes_passado\": 0,\n \"todos\": {\n \"2021-04-23\": 12000,\n \"2021-04-01\": 9408,\n \"2021-02-18\": 11000,\n \"2021-01-21\": 7700\n }\n },\n \"premios_conquistados\": [\n {\n \"id_premio_cliente\": 1111,\n \"id_premio\": 1111,\n \"id_cliente\": 1111,\n \"date_validade\": \"2018-12-12 16:05:44\",\n \"date_retirada\": \"2018-12-11 16:05:44\",\n \"date_ganhou\": \"2018-12-11 16:05:44\",\n \"estornada_em\": null,\n \"motivo_estorno\": null,\n \"esta_vencido\": false,\n \"foi_resgatado\": true,\n \"premio\": {\n \"id_premio\": 1111,\n \"nome\": \"Vale compras R$ 500,00\",\n \"tipo\": \"premio\",\n \"tipo_beneficio\": \"vale_compras\",\n \"valor_beneficio\": 500\n }\n }\n ],\n \"codigo_indicador\": \"clientef935787\",\n \"origem_cadastro\": \"tablet\"\n }\n ],\n \"first_page_url\": \"http://sandbox.fidelizii.com.br/v3/estabelecimentos/1111/clientes?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://sandbox.fidelizii.com.br/v3/estabelecimentos/1111/clientes?page=1\",\n \"next_page_url\": null,\n \"path\": \"http://sandbox.fidelizii.com.br/v3/estabelecimentos/1111/clientes\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}"}],"_postman_id":"06abd97e-4673-4fb8-bae0-e41b283170fc"},{"name":"Retornar transações de um determinado cliente em um estabelecimento","id":"202673d1-a93e-4b69-8fd9-d12c8fca19c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes/{{id_cliente}}/transacoes?data_inicio=2024-04-01&data_fim=2024-07-01&page=1&per_page=15","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","clientes","{{id_cliente}}","transacoes"],"host":["{{base_url}}"],"query":[{"description":{"content":"

Data padrão é o primeiro dia do mês atual

\n","type":"text/plain"},"key":"data_inicio","value":"2024-04-01"},{"description":{"content":"

Data padrão é o dia atual

\n","type":"text/plain"},"key":"data_fim","value":"2024-07-01"},{"description":{"content":"

Página das transações

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Quantidade de itens por página

\n","type":"text/plain"},"key":"per_page","value":"15"}],"variable":[]}},"response":[{"id":"d1dc349b-564c-44cd-8b7d-5c25ab4ff519","name":"Retornar transações de um determinado cliente em um estabelecimento","originalRequest":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":{"raw":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes/{{id_cliente}}/transacoes?data_inicio=2020-09-01&data_fim=2020-09-21","host":["{{base_url}}"],"path":["v3","estabelecimentos","{{id_parceiro}}","clientes","{{id_cliente}}","transacoes"],"query":[{"key":"data_inicio","value":"2020-09-01"},{"key":"data_fim","value":"2020-09-21"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 21:33:24 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:33:24 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"60"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Pontuou\",\n \"descricao\": \"Cliente de Exemplo GANHOU 10 ponto(s) NO PROGRAMA DE FIDELIDADE\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Pontuou\",\n \"descricao\": \"Cliente de Exemplo GANHOU 900 ponto(s) NO PROGRAMA DE FIDELIDADE\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Pontuou\",\n \"descricao\": \"Cliente de Exemplo GANHOU 100 ponto(s) NO PROGRAMA DE FIDELIDADE\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Pontuou\",\n \"descricao\": \"Cliente de Exemplo GANHOU 50 ponto(s) NO PROGRAMA DE FIDELIDADE\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Pontuou\",\n \"descricao\": \"Cliente de Exemplo GANHOU 50 ponto(s) NO PROGRAMA DE FIDELIDADE\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Resgatou prêmio\",\n \"descricao\": \"Cliente de Exemplo USOU 100 PONTO(S) PARA RESGATAR O PRÊMIO '111111#Prêmio de Exemplo'\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Pontuou\",\n \"descricao\": \"Cliente de Exemplo GANHOU 10 ponto(s) NO PROGRAMA DE FIDELIDADE\",\n \"data\": \"2020-01-01 23:59:59\"\n },\n {\n \"origem\": \"tablet\",\n \"atividade\": \"Cadastro\",\n \"descricao\": \"Cliente de Exemplo SE CADASTROU NO PROGRAMA DE FIDELIDADE\",\n \"data\": \"2020-01-01 23:59:59\"\n }\n]"}],"_postman_id":"202673d1-a93e-4b69-8fd9-d12c8fca19c8"},{"name":"Cadastrar um novo cliente ao estabelecimento","id":"4be454cc-f537-4d72-837c-f53eaa822bbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"nome\":\"Cliente de exemplo\",\n \"email\": \"email@email.com.br\",\n \"cpf\": \"111.111.111-11\",\n \"data_nascimento\": \"1994-12-01\",\n \"celular\": \"(11) 11111-1111\",\n \"sexo\": \"M\",\n \"cep\": \"11111111\",\n \"endereco\": \"Rua xxxxxxxxx\",\n \"bairro\": \"xxxxxxxxxxxx\",\n \"cidade\": \"Campinas\",\n \"estado\": \"SP\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","clientes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e9ea202c-5c9b-4d90-9631-c1357ca6c787","name":"Cadastrar um novo cliente ao estabelecimento","originalRequest":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"nome\":\"Cliente de Exemplo\",\n \"email\": \"email@email.com.br\",\n \"cpf\": \"111.111.111-11\",\n \"data_nascimento\": \"1994-12-01\",\n \"celular\": \"(11) 11111-1111\",\n \"sexo\": \"M\",\n \"cep\": \"11111111\",\n \"endereco\": \"Rua xxxxxxx\",\n \"bairro\": \"xxxxxxxxxx\",\n \"cidade\": \"Campinas\",\n \"estado\": \"SP\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/clientes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 21:36:45 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 21:36:45 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"}],"cookie":[],"responseTime":null,"body":"{\n \"nome\": \"cliente de exemplo\",\n \"email\": \"email@email.com.br\",\n \"id_cliente\": 1111111,\n \"codigo_indicador\": \"cliente852f2b3\",\n \"origem_cadastro\": \"api-integracao\"\n}"}],"_postman_id":"4be454cc-f537-4d72-837c-f53eaa822bbb"}],"id":"1c85a9d5-770f-4945-81ca-85bb4614aef3","description":"

Nesta seção estão todos os endpoints necessários para o gerenciamento dos clientes do estabelecimento.

\n","_postman_id":"1c85a9d5-770f-4945-81ca-85bb4614aef3"},{"name":"Atendentes","item":[{"name":"Retornar todos os atendentes de um estabelecimento","id":"818ed39c-3af9-4ef2-b664-897f77bbb4e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","atendentes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e64b37d9-91db-474c-a492-fba69fadcacc","name":"Retornar todos os atendentes de um estabelecimento","originalRequest":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 22:05:49 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 22:05:49 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id_atendente\": 11111,\n \"id_parceiro\": 1111,\n \"nome\": \"Cliente de Exemplo\",\n \"senha\": \"1111\",\n \"ativo\": 1\n },\n {\n \"id_atendente\": 11111,\n \"id_parceiro\": 1111,\n \"nome\": \"Cliente de Exemplo\",\n \"senha\": \"1111\",\n \"ativo\": 1\n }\n]"}],"_postman_id":"818ed39c-3af9-4ef2-b664-897f77bbb4e8"},{"name":"Retornar informações de um atendente específico","id":"cd2cb73b-efc9-450e-aced-17b0251b9eb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes/{{id_atendente}}","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","atendentes","{{id_atendente}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"35f684a9-cb27-40b1-ac93-310580baefbf","name":"Retornar informações de um atendente específico","originalRequest":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes/{{id_atendente}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 22:06:52 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 22:06:52 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"id_atendente\": 11111,\n \"id_parceiro\": 11111,\n \"nome\": \"Atendente\",\n \"senha\": \"1111\",\n \"ativo\": 1,\n \"receita\": {\n \"total\": 0,\n \"todos\": [],\n \"ticket_medio\": 0\n },\n \"cadastros\": {\n \"total_cadastros\": 0,\n \"todos\": []\n }\n}"}],"_postman_id":"cd2cb73b-efc9-450e-aced-17b0251b9eb4"},{"name":"Cadastrar um atendente no estabelecimento","id":"6f7aa63e-82ad-41b9-ad5f-acc39ead6361","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"nome\": \"Atendente\",\n \"senha\": \"1111\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","atendentes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5a2c5e5f-46fd-43aa-8725-91538fbf9d40","name":"Cadastrar um atendente no estabelecimento","originalRequest":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"nome\": \"Atendente\",\n \"senha\": \"1111\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 22:07:29 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 22:07:29 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"nome\": \"Atendente\",\n \"codigo\": \"1111\",\n \"ativo\": 1,\n \"id_parceiro\": 1111,\n \"id_atendente\": 11111\n}"}],"_postman_id":"6f7aa63e-82ad-41b9-ad5f-acc39ead6361"},{"name":"Editar informações de um determinado atendente","id":"d7f4c435-d413-47f0-9c69-081faa0f79b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"nome\": \"Atendente\",\n \"senha\": \"5555\",\n \"ativo\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes/{{id_atendente}}/editar","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","atendentes","{{id_atendente}}","editar"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5144d1a4-3517-411a-8dd1-1d23a3ea8ce8","name":"Editar informações de um determinado atendente","originalRequest":{"method":"POST","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"body":{"mode":"raw","raw":"{\n \"nome\": \"Atendente\",\n \"senha\": \"5555\",\n \"ativo\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/atendentes/{{id_atendente}}/editar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:7777"},{"key":"Date","value":"Mon, 21 Sep 2020 22:41:38 GMT"},{"key":"Date","value":"Mon, 21 Sep 2020 22:41:38 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.2.33-1+ubuntu20.04.1+deb.sury.org+1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"id_atendente\": 11111,\n \"id_parceiro\": 1111,\n \"nome\": \"Atendente\",\n \"senha\": \"5555\",\n \"ativo\": \"1\"\n}"}],"_postman_id":"d7f4c435-d413-47f0-9c69-081faa0f79b7"}],"id":"952e6ebf-9a8d-41c3-b62a-7d3fc7988214","description":"

A organização de atendentes, é uma forma de garantir a identificação do responsável em cada compra pontuada no estabelecimento. Com ela, podemos tanto identificar cada lançamento, mas também analisar métricas de performance de cada um.

\n
\n

É recomendado que você faça uma adaptação em seu sistema para gerenciar os atendentes, facilitando o trabalho para identificação do responsável que está efetuando o lançamento da compra.

\n
\n

O gerenciamento dos atendentes, é possível ser realizado tanto via API como pelo seu Painel Meu Fidelizi.

\n

Abaixo estão alguns links de como trabalhar com o gerenciamento dentro do Painel.

\n

Central de Ajuda - Atendentes

\n","_postman_id":"952e6ebf-9a8d-41c3-b62a-7d3fc7988214"},{"name":"Estabelecimentos","item":[{"name":"Retornar os estabelecimentos","id":"25792ecd-de91-4600-89b0-8f0eb1125259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/estabelecimentos","urlObject":{"path":["v3","estabelecimentos"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"25792ecd-de91-4600-89b0-8f0eb1125259"},{"name":"Retornar informações de um estabelecimento específico","id":"b706d676-c457-4093-bb27-830aa74f3e54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","type":"text","value":"{{appToken}}"},{"key":"accessToken","type":"text","value":"{{accessToken}}"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b706d676-c457-4093-bb27-830aa74f3e54"},{"name":"Retornar todas as transações realizadas no estabelecimento","id":"26b110dd-a59b-491d-9494-6469029ec504","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/estabelecimentos/{{id_parceiro}}/transacoes?data_inicio=2024-06-01&data_fim=2024-07-01&per_page=15","urlObject":{"path":["v3","estabelecimentos","{{id_parceiro}}","transacoes"],"host":["{{base_url}}"],"query":[{"key":"data_inicio","value":"2024-06-01"},{"key":"data_fim","value":"2024-07-01"},{"key":"per_page","value":"15"},{"disabled":true,"description":{"content":"

Opções de eventos disponíveis para uso (Todos os eventos deverão ser passados separados por vírgula): compras, compras_canceladas, nps, roleta_conquistados, roleta_resgatados, roleta_expirados, roleta_cancelados, fidelidade_resgatados, campanha_conquistados, campanha_resgatados, campanha_expirados, campanha_cancelados, surpresa_conquistados, surpresa_resgatados, surpresa_expirados, surpresa_cancelados, jogos_conquistados, jogos_resgatados, jogos_expirados, jogos_cancelados, cadastros, ofertas_ativadas, pesquisas_respondidas

\n","type":"text/plain"},"key":"atividades","value":"compras"}],"variable":[]}},"response":[],"_postman_id":"26b110dd-a59b-491d-9494-6469029ec504"}],"id":"885fa71f-670b-4a12-8eeb-ce98a2fe862b","event":[{"listen":"prerequest","script":{"id":"9aa5cc03-3552-40bd-ae7b-386d751bf663","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b0ef4c06-db8a-449a-863d-9f9d73b55035","type":"text/javascript","exec":[""]}}],"_postman_id":"885fa71f-670b-4a12-8eeb-ce98a2fe862b","description":""},{"name":"Redes","item":[{"name":"Retornar todas as redes","id":"ab983ade-9d2c-4f5d-a2e7-1156a4b8c948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/redes","urlObject":{"path":["v3","redes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab983ade-9d2c-4f5d-a2e7-1156a4b8c948"},{"name":"Retornar informações de uma rede específica","id":"75e3c737-b700-4ac5-94b8-da6ea26fe34d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"appToken","value":"{{appToken}}","type":"text"},{"key":"accessToken","value":"{{accessToken}}","type":"text"}],"url":"{{base_url}}/v3/redes/{{id_rede}}","urlObject":{"path":["v3","redes","{{id_rede}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"75e3c737-b700-4ac5-94b8-da6ea26fe34d"}],"id":"3e17ff30-9b29-46b6-a2f4-683e250868b9","_postman_id":"3e17ff30-9b29-46b6-a2f4-683e250868b9","description":""}],"event":[{"listen":"prerequest","script":{"id":"0d100fee-f4b5-49a2-8a29-fcbae1d877d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0c24b9dd-3f91-4385-bd63-68acae4faa38","type":"text/javascript","exec":[""]}}]}