{"info":{"_postman_id":"95ca82fa-8aed-45a4-a86c-521958f2357a","name":"API Fidelidade","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"569841","collectionId":"95ca82fa-8aed-45a4-a86c-521958f2357a","publishedId":"RznEKyFg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-01-07T12:29:29.000Z"},"item":[{"name":"Registra pontuação","id":"754496ee-8229-4830-9901-11c09ee2e762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer 'API TOKEN'","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cpf\": \"000.000.000-00\",\n \"pontos\": \"123\",\n \"pdv\": \"123\",\n \"operador\": \"123\"\n}"},"url":"https://api.{{host}}/api/registraPontos","description":"

Parametros:

Obrigatórios:

cpf ou telefone
\n
- Descrição: CPF ou telefone que receberá a pontuação
  \n
- Formato cpf: \"000.000.000-00\" ou \"01234567890\"
  \n
- Formato telefone (sem DDI): \"55999999999\"
  \n
\n
pontos
\n
- Descrição: Valor em pontos sendo cadastrado
  \n
- Formato: \"000\"
  \n
\n

Outros:

pdv
\n
- Descrição: Código do pdv que está realizando o cadastro, se em branco será registrado no primeiro pdv cadastrado no sistema
  \n
- Formato: \"000\"
  \n
\n
operador
\n
- Descrição: Código externo do operador
  \n
- Formato: \"000\"
  \n
\n

Comportamento:

Caso o CPF não esteja cadastrado no sistema, um pré-cadastro será realizado com as informações fornecidas.

Exemplo de resposta com sucesso:

{\n    \"status\": \"success\",\n    \"code\": \"001\",\n    \"message\": \"Pontuação realizada com sucesso\",\n    \"data\": {\n        \"pontos\": \"2120\",\n        \"visitas\": 1,\n        \"resgates\": 4,\n        \"premios\": {\n            \"Prêmio 1\": {\n                \"id\": 1238,\n                \"nome\": \"Prêmio 1\",\n                \"pontos\": 100,\n                \"status\": \"disponivel\",\n                \"code\": 1\n            },\n            \"Prêmio 2\": {\n                \"id\": 1239,\n                \"nome\": \"Prêmio 2\",\n                \"pontos\": 200,\n                \"status\": \"disponivel\",\n                \"code\": 1\n            },\n            \"Prêmio 3\": {\n                \"id\": 1240,\n                \"nome\": \"Prêmio 3\",\n                \"pontos\": 300,\n                \"status\": \"disponivel\",\n                \"code\": 1\n            }\n        },\n        \"dados_cadastro\": {\n            \"cpf\": \"000.000.000-00\",\n            \"nome_completo\": \"John Doe\",\n            \"email\": \"john@alloy.al\",\n            \"telefone\": null,\n            \"genero\": \"Masculino\",\n            \"data_nascimento\": \"1991-11-29\"\n        }\n    }\n}\n\n

Exemplo de resposta com erro:

{\n    \"status\": \"error\",\n    \"code\": \"101\",\n    \"message\": \"O CPF XXX.XXX.XXX-XX é invalido\",\n    \"data\": \"XXX.XXX.XXX-XX\"\n}\n\n

Códigos:

001 - Cadastro realizado com sucesso
\n
101 - CPF inválido
\n
102 - Pontuação inválida
\n
199 - Algum outro erro
\n

\n","urlObject":{"protocol":"https","path":["api","registraPontos"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"754496ee-8229-4830-9901-11c09ee2e762"},{"name":"Resgata prêmio","id":"f0bbe491-5c0c-489b-b85b-7eb587a3f829","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer 'API TOKEN'","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"000.000.000-00\",\n\t\"premio_id\": \"1238\"\n}"},"url":"https://api.{{host}}/api/resgataPremio","description":"

Parametros:

Obrigatórios:

cpf
- Descrição: Cpf do usuário resgatando o prêmio
- Formato: \"000.000.000-00\" ou \"01234567890\"
\n
premio_id
- Descrição: Id interno do prêmio sendo resgatado
- Formato: \"0000\"
\n

Outros:

pdv
- Descrição: Código do pdv que está realizando o cadastro, se em branco será registrado no primeiro pdv cadastrado no sistema
- Formato: \"0000\"
\n
operador
- Descrição: Código externo do operador
- Formato: \"0000\"
\n

Exemplo de resposta com sucesso:

\n{\n    \"status\": \"success\",\n    \"code\": \"001\",\n    \"message\": \"Prêmio resgatado com sucesso\",\n    \"data\": {\n        \"premio\": {\n            \"nome\": \"Prêmio 1\",\n            \"pontos\": 100\n        },\n        \"resumo_usuario\": {\n            \"nome\": \"XXX\",\n            \"cpf\": \"XXX.XXX.XXX-XX\",\n            \"pontos\": \"XXXX\",\n            \"visitas\": X,\n            \"resgates\": X,\n            \"premios\": {\n                \"Prêmio 1\": {\n                    \"id\": 1238,\n                    \"nome\": \"Prêmio 1\",\n                    \"pontos\": 100,\n                    \"status\": \"disponivel\",\n                 \"code\": 1\n                 },\n                 \"Prêmio 2\": {\n                    \"id\": 1239,\n                    \"nome\": \"Prêmio 2\",\n                    \"pontos\": 200,\n                    \"status\": \"indisponivel\",\n                    \"code\": 0\n                }\n            }\n        }\n    }\n}\n

\n\n

Exemplo de resposta com erro:

\n{\n    \"status\": \"error\",\n    \"code\": \"101\",\n    \"message\": \"O CPF XXX.XXX.XXX-XX é invalido\",\n    \"data\": \"XXX.XXX.XXX-XX\"\n}\n

\n\n

Códigos:

001 - Retorno com sucesso
101 - CPF inválido
102 - Id do prêmio é obrigatório
103 - Prêmio não encontrado
104 - Pontos insuficientes
109 - Usuário não encontrado
199 - Algum outro erro

\n","urlObject":{"protocol":"https","path":["api","resgataPremio"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0bbe491-5c0c-489b-b85b-7eb587a3f829"},{"name":"Cadastra usuário","id":"dd2a663c-a608-427e-b9e2-257514a4ad1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer 'API TOKEN'","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"000.000.000-00\",\n\t\"email\": \"\",\n\t\"nome_completo\": \"John Doe\",\n\t\"telefone\": \"(99)9999-9999\",\n\t\"genero\": \"M\",\n\t\"data_nascimento\": \"1990-01-30\"\n}"},"url":"https://api.{{host}}/api/criaCadastro","description":"

Parametros:

Obrigatórios:

cpf
- Descrição: Cpf do usuário sendo cadastrado
- Formato: \"000.000.000-00\" ou \"01234567891\"
\n
nome_completo
- Descrição: Nome completo sendo cadastrado
- Formato: \"John Doe\"
\n

Outros:

email
- Descrição: E-mail sendo cadastrado
- Formato: \"john@dominio.com\"
\n
nome_completo
- Descrição: Nome completo sendo cadastrado
- Formato: \"John Doe\"
\n
telefone
- Descrição: Telefone sendo cadastrado
- Formato: (55)9999-9999 ou (55)99999-9999
\n
genero
- Descrição: Genero sendo cadastrado
- Formato: \"M\"
- Opções: \"M\" - Masculino | \"F\" - Feminino | \"O\" - Outro | \"N\" - Não informado
\n
data_nascimento
- Descrição: Data de nascimento sendo cadastrado
- Formato: \"1990-01-30\"
\n

Exemplo de resposta com sucesso:

\n{\n    \"status\": \"success\",\n    \"code\": \"001\",\n    \"message\": \"Usuário cadastrado com sucesso\",\n    \"data\": {\n        \"usuario\": {\n            \"cpf\": \"000.000.000-00\",\n            \"nome_completo\": \"John Doe\",\n            \"email\": \"\",\n            \"telefone\": \"(99)9999-9999\",\n            \"genero\": \"Masculino\",\n            \"data_nascimento\": \"1990-01-30\"\n        }\n    }\n}\n

\n\n

Exemplo de resposta com erro:

\n{\n    \"status\": \"error\",\n    \"code\": \"101\",\n    \"message\": \"O CPF já cadastrado com o e-mail: john@dominio.com\",\n    \"data\": \"000.000.000-00\"\n}\n

\n\n

Códigos:

001 - Cadastro realizado com sucesso
002 - Cadastro realizado com sucesso mas com erros
101 - CPF inválido
102 - Erro no nome
199 - Algum outro erro

\n","urlObject":{"protocol":"https","path":["api","criaCadastro"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd2a663c-a608-427e-b9e2-257514a4ad1f"},{"name":"Atualiza usuário","id":"e67467cf-4a86-4bf3-a797-c9f11d876d22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer 'API TOKEN'","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"000.000.000-00\",\n\t\"email\": \"john@dominio.com\",\n\t\"nome_completo\": \"John Doe\",\n\t\"telefone\": \"(99)99999-9999)\",\n\t\"genero\": \"M\",\n\t\"data_nascimento\": \"1990-01-30\"\n}"},"url":"https://api.{{host}}/api/atualizaCadastro","description":"

Parametros:

Obrigatórios:

cpf
- Descrição: Cpf do usuário resgatando o prêmio
- Formato: \"000.000.000-00\" ou \"01234567891\"
\n

Outros:

email
- Descrição: E-mail sendo cadastrado
- Formato: \"teste@teste.com\"
\n
nome_completo
- Descrição: Nome completo sendo cadastrado
- Formato: \"John Doe\"
\n
telefone
- Descrição: Telefone sendo cadastrado
- Formato: (55)9999-9999 ou (55)99999-9999
\n
genero
- Descrição: Genero sendo cadastrado
- Formato: \"M\"
- Opções: \"M\" - Masculino | \"F\" - Feminino | \"O\" - Outro | \"N\" - Não informado
\n
data_nascimento
- Descrição: Data de nascimento sendo cadastrado
- Formato: \"1990-01-30\"
\n

Exemplo de resposta com sucesso:

\n{\n    \"status\": \"success\",\n    \"code\": \"002\",\n    \"message\": \"Usuário alterado com sucesso\",\n    \"data\": {\n        \"Erros\": {\n            \"telefone\": \"Telefone inválido - (99)9999999\"\n        },\n        \"usuario\": {\n            \"cpf\": \"477.126.135-08\",\n            \"nome_completo\": \"John Doe\",\n            \"email\": \"john@dominio.com\",\n            \"genero\": \"Outro\",\n            \"telefone\": \"(55)1111-1111\",\n            \"data_nascimento\": \"1990-01-30\"\n        },\n        \"alteracoes\": {\n            \"email\": \"\",\n            \"sexo\": \"M\"\n        }\n    }\n}\n

\n\n

Exemplo de resposta com erro:

\n{\n    \"status\": \"error\",\n    \"code\": \"101\",\n    \"message\": \"O CPF XXX.XXX.XXX-XX é invalido\",\n    \"data\": \"XXX.XXX.XXX-XX\"\n}\n

\n\n

Códigos:

001 - Cadastro atualizado com sucesso
002 - Cadastro atualizado com sucesso mas com erros
003 - Nenhum campo alterado
004 - Nenhum campo alterado com erros
101 - CPF inválido
109 - Usuário não encontrado
199 - Algum outro erro

\n","urlObject":{"protocol":"https","path":["api","atualizaCadastro"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e67467cf-4a86-4bf3-a797-c9f11d876d22"},{"name":"Lista usuários","id":"f23efe66-5c13-4eb4-bce9-bf48e4116b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer 'API TOKEN'","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"loja\": \"00000\"\n}"},"url":"https://api.{{host}}/api/listaUsuarios","description":"

Comportamento:

Retorna resumo do usuário no programa caso a loja não seja informada
Retorna resumo do usuário na loja sendo pesquisada

Parametros:

Opcionais:

loja
- Descrição: Id da loja sendo procurada
- Formato: \"0000\"
\n

Exemplo de resposta com sucesso:

\n{\n    \"status\": \"success\",\n    \"code\": \"001\",\n    \"message\": \"Usuário encontrado\",\n    \"data\": [\n        {\n            \"cpf\": \"000.000.000-00\",\n            \"nome_completo\": \"John Doe\",\n            \"email\": \"john_doe@dominio.com\",\n            \"genero\": \"Feminino\",\n            \"data_nascimento\": \"24/12/1947\",\n            \"ultima_visita\": \"24/10/2019 02:17\",\n            \"primeira_visita\": \"24/10/2019 02:17\",\n            \"loja_de_cadastro\": 0000,\n            \"visitas\": 1,\n            \"resgates\": 1,\n            \"pontos_atual\": 1,\n            \"total_gasto\": 1\n        }\n    ]\n}\n

\n\n

Exemplo de resposta com erro:

\n{\n    \"status\": \"error\",\n    \"code\": \"109\",\n    \"message\": \"Loja não encontrada\",\n    \"data\": \"\"\n}\n

\n\n

Códigos:

001 - Retorno com sucesso
108 - Usuário sem permissão para esta loja
109 - Usuário não encontrado
199 - Algum outro erro

\n","urlObject":{"protocol":"https","path":["api","listaUsuarios"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f23efe66-5c13-4eb4-bce9-bf48e4116b12"},{"name":"Resumo usuario","id":"51974fe3-e92d-49a5-9f32-e381efcc69ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer 'API TOKEN'","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"cpf\": \"000.000.000-00\"\n}"},"url":"https://api.{{host}}/api/resumoUsuario","description":"

Comportamento:

Retorna resumo do usuário na loja sendo pesquisada junto com o cadastro do mesmo

Parametros:

cpf
\n
- Descrição: Cpf do usuário
  \n
- Formato: \"000.000.000-00\" ou \"01234567890\"
  \n
\n
telefone
\n
- Descrição: Telefone do usuário
  \n
- Formato: \"55911111111\"
  \n
\n

Exemplo de resposta com sucesso:

{\n    \"status\": \"success\",\n    \"code\": \"001\",\n    \"message\": \"Lista gerada com sucesso\",\n    \"data\": {\n        \"pontos\": \"2120\",\n        \"visitas\": 1,\n        \"resgates\": 4,\n        \"premios\": {\n            \"Prêmio 1\": {\n                \"id\": 1238,\n                \"nome\": \"Prêmio 1\",\n                \"pontos\": 100,\n                \"status\": \"disponivel\",\n                \"code\": 1\n            },\n            \"Prêmio 2\": {\n                \"id\": 1239,\n                \"nome\": \"Prêmio 2\",\n                \"pontos\": 200,\n                \"status\": \"disponivel\",\n                \"code\": 1\n            },\n            \"Prêmio 3\": {\n                \"id\": 1240,\n                \"nome\": \"Prêmio 3\",\n                \"pontos\": 300,\n                \"status\": \"disponivel\",\n                \"code\": 1\n            }\n        },\n        \"dados_cadastro\": {\n            \"cpf\": \"000.000.000-00\",\n            \"nome_completo\": \"John Doe\",\n            \"email\": \"john@dominio.com\",\n            \"telefone\": null,\n            \"genero\": \"Masculino\",\n            \"data_nascimento\": \"1991-11-29\"\n        }\n    }\n}\n\n

Exemplo de resposta com erro:

{\n    \"status\": \"error\",\n    \"code\": \"101\",\n    \"message\": \"O CPF XXX.XXX.XXX-XX é invalido\",\n    \"data\": \"XXX.XXX.XXX-XX\"\n}\n\n

Códigos:

001 - Retorno com sucesso
\n
101 - CPF inválido
\n
109 - Usuário não encontrado
\n
199 - Algum outro erro
\n

\n","urlObject":{"protocol":"https","path":["api","resumoUsuario"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"51974fe3-e92d-49a5-9f32-e381efcc69ae"},{"name":"Consulta Prêmios","id":"502cecb4-bed6-4bb9-8faa-5da7cc66781d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.{{host}}/api/consultaPremios","description":"

Comportamento:

Retorna os prêmios do programa

Exemplo de resposta com sucesso:

\n{\n    \"status\": \"success\",\n    \"code\": \"001\",\n    \"message\": \"\",\n    \"data\": {\n        \"Prêmio 1\": {\n            \"id\": 1238,\n            \"nome\": \"Prêmio 1\",\n            \"pontos\": 100,\n            \"status\": \"disponivel\",\n            \"code\": 1\n        },\n        \"Prêmio 2\": {\n            \"id\": 1239,\n            \"nome\": \"Prêmio 2\",\n            \"pontos\": 200,\n            \"status\": \"disponivel\",\n            \"code\": 1\n        },\n        \"Prêmio 3\": {\n            \"id\": 1240,\n            \"nome\": \"Prêmio 3\",\n            \"pontos\": 300,\n            \"status\": \"indisponivel\",\n            \"code\": 0\n        }\n    }\n}\n

\n\n

Exemplo de resposta com erro:

\n{\n    \"message\": \"Unauthenticated.\"\n}\n

\n\n

Códigos:

001 - Retorno com sucesso
002 - Nenhum prêmio disponível

\n","urlObject":{"protocol":"https","path":["api","consultaPremios"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"502cecb4-bed6-4bb9-8faa-5da7cc66781d"},{"name":"Token info","id":"0b854093-1cb7-45a5-97b9-cc859aa7a37a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.{{host}}/api/tokenInfo","description":"

Parametros:

Obs:

Com essa função você terá as informações e acessos disponíveis pelo token sendo utilizado

Exemplo de resposta com sucesso:

\n{\n    \"loja_id\": 0000,\n    \"nome\": \"Marca\",\n    \"pdvs\": [\n        292\n    ]\n}\n

\n\n

Exemplo de resposta com erro:

\n{\n    \"message\": \"Unauthenticated.\"\n}\n

","urlObject":{"protocol":"https","path":["api","tokenInfo"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b854093-1cb7-45a5-97b9-cc859aa7a37a"},{"name":"Gera token","id":"fdf6ab40-eaf1-4db9-81fd-64afda783a83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"},{"key":"integrador-token","value":"{{integrador-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"jliqhawxmuiobkmija@niwghx.com\",\n\t\"password\": \"123456\",\n\t\"remember_me\": true\n}"},"url":"https://api.{{host}}/api/auth/login","description":"

Utilizado para gerar um novo token de acesso

\n","urlObject":{"protocol":"https","path":["api","auth","login"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fdf6ab40-eaf1-4db9-81fd-64afda783a83"}],"event":[{"listen":"prerequest","script":{"id":"73e40f24-e943-4891-86c6-f618d7403af1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c87c645-bf39-4eb2-bc47-fe37ee38bcf4","type":"text/javascript","exec":[""]}}]}