{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"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\nA 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\nVeja nossa apresentação no vídeo abaixo: \n[https://www.youtube.com/watch?v=DGyXxB8T3Mc](https://www.youtube.com/watch?v=DGyXxB8T3Mc)\n\n# Referência da API\n\nPara 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\nAs 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\n# Autenticação\n\n> Geração do token para utilização da API \n \n\nPara 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\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\nTodas 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](https://sandbox.fidelizii.com.br) \nO domínio para chamada a API em produção é https://integracao.fidelizii.com.br \n \n\nTodas as requisições realizadas para a API, deverá ser enviado app e access token no header da requisição.\n\n
Key
Value
appToken
{{appToken}}
accessToken
{{accessToken}}
\n\n## Gerando o token de autenticação\n\nBasta 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\nGere 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\nApós clicar em \"Gerar token\" será exibido o seu appToken e accessToken.\n\nGuarde 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\n# Ambiente de Testes\n\nPara 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](https://mailto:integracao@fidelizi.com.br).\n\nNós iremos gerar um estabelecimento modelo configurado para que possa realizar a integração e os testes necessários.\n\nNo ambiente de testes, a URL base a ser usada é: [https://sandbox.fidelizii.com.br](https://sandbox.fidelizii.com.br)\n\n---\n\n# Entendendo a mecânica de pontos\n\nO 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\nEste 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\nUma 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\nApó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\nVeja o vídeo abaixo com o fluxo:\n\n[Fluxo de Pontuação no Totem Fidelizi](https://www.youtube.com/watch?v=7DhAe7Yz6t4)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10478718","team":885917,"collectionId":"91027ec6-790f-44e0-96fa-2442d034f1db","publishedId":"TVKD2chH","public":true,"publicUrl":"https://documenter-api.postman.tech/view/10478718/TVKD2chH","privateUrl":"https://go.postman.co/documentation/10478718-91027ec6-790f-44e0-96fa-2442d034f1db","customColor":{"top-bar":"834BE1","right-sidebar":"303030","highlight":"834BE1"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"834BE1","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"834BE1","right-sidebar":"303030","highlight":"834BE1"}}]}},"version":"8.10.0","publishDate":"2024-06-14T22:11:41.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1dd2e5ac2212ebb141a9f64fc07790813952cb384bb41369c24a587ebd1a74ff","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVKD2chH"}