{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c26dfe53-b9a3-4e7b-a9f0-b36492963255","name":"Urbis API","description":"## Visão Geral da API\n\nA API da Urbis facilita a gestão de usuários e a autenticação unificada. Com ela, é possível realizar o login de forma centralizada, gerenciar dados dos usuários e garantir acesso seguro por meio de tokens de autenticação. Todos os processos são otimizados para uma experiência integrada e eficiente.\n\n## Autenticação\n\n- O **serviço de autenticação do Clube de Vantagens** garante um acesso seguro e personalizado, utilizando tokens para proteger dados sensíveis. Ele gerencia todo o processo de login e autenticação de gestores, assegurando a segurança e o controle de acesso aos recursos da API.\n    \n- Descrição da Propriedade **`access_token:`**\n    \n    - **Access Token do Gestor:**\n        \n        - **Finalidade:** Este token possui permissões ampliadas, permitindo que o gestor realize ações administrativas, como buscar e listar todos os usuários do clube.\n            \n        - **Expiração:** O `access_token` do gestor não expira, sendo válido durante todo o período de autenticação na plataforma do gestor.\n            \n        - **Gestão:** A criação do acesso de gestor é realizada pelo time de Sucesso do Cliente da Urbis. Para utilizá-lo, é necessário solicitar a criação do gestor diretamente a eles.\n            \n    - **Access Token do Usuário:**\n        \n        - **Finalidade:** Este token é utilizado para exibir dados na perspectiva do usuário. Com ele, o usuário terá acesso apenas às informações do clube que estão diretamente relacionadas às suas próprias ações, como utilizações, economia, visitas e outras interações.\n            \n        - **Expiração:** O `access_token` do usuário possui validade de 12 horas. Caso expire, o sistema deve usar o `refresh_token` (válido por 24 horas) para obter um novo `access_token`.\n            \n        - **Orientação ao Desenvolvedor:** Quando o token expirar, o desenvolvedor deve implementar uma lógica para chamar a rota de **reautenticação** com o `refresh_token` e gerar um novo `access_token`, garantindo uma experiência contínua e segura para o usuário.\n            \n\n---\n\n> Para ambos os casos acima, o sistema foi projetado para manter a privacidade e segurança, garantindo que o acesso aos recursos seja restrito e adequado ao perfil de cada token. \n  \n\n## Usuário\n\n- Serviços de gerenciamento completo de usuários, incluindo cadastro, atualização e consulta de dados de usuários dentro do clube de vantagens. Proporciona uma gestão completa de usuários no clube de vantagens. Serviços disponíveis incluem:\n    \n    - Cadastro de usuário\n        \n    - Buscar usuários\n        \n    - Buscar usuário pelo ID\n        \n    - Atualizar informações do usuário pelo ID\n        \n    - Atualizar o status do usuário (Ativar/Inativar)\n        \n\n### Tag\n\nO serviço de **Tags** permite o gerenciamento completo de níveis de acesso dentro do clube de vantagens, definindo quais parceiros e benefícios cada usuário pode visualizar. Por exemplo, você pode criar uma tag chamada **\"Ouro\"** e vinculá-la a um parceiro específico. Dessa forma, apenas usuários que possuem essa tag poderão acessar os benefícios desse parceiro.\n\nA gestão das tags pode ser feita diretamente pelo painel do gestor, acessando **Menu Lateral > Usuários > Tags**, onde é possível visualizar os IDs das tags existentes, criar novas tags e gerenciar seus vínculos. Via API também disponibilizamos os serviços necessários para essa gestão.\n\n- Os serviços disponíveis incluem:\n    \n    - **Cadastro de tags** – Criar novas tags para definir acessos.\n        \n    - **Buscar tag pelo ID** – Consultar informações sobre uma tag específica.\n        \n    - **Atualizar informações da tag pelo ID** – Alterar detalhes de uma tag existente.\n        \n    - **Atualizar o status da tag (Ativar/Inativar)** – Habilitar ou desabilitar uma tag conforme necessário.\n        \n\nA associação de tags pode ser feita tanto no momento da criação de um parceiro quanto posteriormente, na opção de edição. Para vincular um usuário a uma tag, basta informar o **ID da tag** ao cadastrá-lo ou também na edição.\n\n## Configurações de Acesso à API\n\n- Nesta seção, você encontrará as informações necessárias para se conectar à API, incluindo a base URL, o Whitelabel ID do clube e o Access Token.\n    \n    - Base URL: [https://new-api.urbis.cc](https://new-api.urbis.cc/)\n        \n    - ID do Clube \\[whitelabelId\\]: Fornecido por e-mail pela equipe de Tecnologia da Urbis\n        \n    - Access Token \\[access_token\\]: Instruções sobre como obter o token estão disponíveis na seção de Autenticação\n        \n- Esses dados são essenciais para realizar chamadas à API de maneira segura e autorizada.\n    \n\nPara dúvidas e suporte, entre em contato através do email: [fabricio.pinheiro@urbis.cc](https://mailto:fabricio.pinheiro@urbis.cc)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"37683678","team":6460048,"collectionId":"c26dfe53-b9a3-4e7b-a9f0-b36492963255","publishedId":"2sAYJ9Bece","public":true,"publicUrl":"https://documentation-api.urbis.cc","privateUrl":"https://go.postman.co/documentation/37683678-c26dfe53-b9a3-4e7b-a9f0-b36492963255","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Sobre esta Documentação\n\nEsta documentação fornece uma visão completa da API do Clube de Vantagens, detalhando suas funcionalidades, endpoints, e o processo de autenticação. Com ela, você poderá integrar de forma eficiente e segura o login unificado, gerenciar usuários, e acessar os recursos do clube. É um guia essenci"},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-04-28T15:00:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Sobre esta Documentação\n\nEsta documentação fornece uma visão completa da API do Clube de Vantagens, detalhando suas funcionalidades, endpoints, e o processo de autenticação. Com ela, você poderá integrar de forma eficiente e segura o login unificado, gerenciar usuários, e acessar os recursos do clube. É um guia essenci"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production","id":"954830b4-87b0-4775-a0a5-3ef046f5b839","owner":"37683678","values":[{"key":"token","value":"","type":"default","enabled":true},{"key":"collectionName","value":"","type":"default","enabled":true},{"key":"collectionSchemaUrl","value":"","type":"default","enabled":true},{"key":"accessKey","value":"","type":"default","enabled":true},{"key":"workspaceId","value":"","type":"default","enabled":true},{"key":"collectionId","value":"","type":"default","enabled":true}],"published":true}],"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/a5dfb59616fcec69044378a6f62c91e0f4699453f438e2b9dfe2f6b7292c7378","favicon":"https://urbis.cc/favicon.ico"},"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"},{"label":"Production","value":"37683678-954830b4-87b0-4775-a0a5-3ef046f5b839"}],"canonicalUrl":"https://documentation-api.urbis.cc/view/metadata/2sAYJ9Bece"}