Esta coleção abrange os principais endpoints de backend da plataforma Abraço Amigo, um sistema projetado para conectar voluntários a demandas sociais e locais.
\nEla está organizada em três módulos principais:
\nTodas as requisições são direcionadas a um servidor de desenvolvimento local (http://localhost:3333) e seguem as convenções RESTful.
Esta rota permite a criação de um novo usuário no sistema. Ela valida os dados enviados através do middleware de validação e, se tudo estiver correto, persiste o novo usuário no banco de dados. Geralmente, a senha é criptografada (hash) antes do salvamento por questões de segurança.
\nRequer Autenticação: Não (Público).
\nValidação: createUserSchema (Garante que os dados seguem as regras de negócio, como e-mail único e força da senha).
Acesso: Livre para qualquer visitante.
\nEsta rota valida as credenciais do usuário (e-mail e senha) e, em caso de sucesso, gera um Token JWT (JSON Web Token). Este token deve ser armazenado pelo cliente (Frontend/Mobile) e enviado no Header de todas as requisições que exigem autenticação.
\nauthUserSchema (Verifica se o e-mail é válido e se a senha foi preenchida).Esta rota desloga o usuário e remove o token do banco de dados, em caso de sucesso.
\nRequer Autenticação: Sim.
\nAcesso: Apenas via token do usuário.
\nEsta rota é responsável por retornar os dados detalhados do usuário que está autenticado no momento. Ela utiliza o identificador contido no Token JWT para buscar as informações no banco de dados, garantindo que um usuário não acesse dados de terceiros.
\n","urlObject":{"protocol":"http","port":"3333","path":["me"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2bf415d-a30b-426b-96e7-695dad11c7fa"},{"name":"editar user","id":"66f4f73a-b424-44df-834d-d9c57ad6f828","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3Nzc0Njc4NTMsImV4cCI6MTc3NzU1NDI1Mywic3ViIjoiZWU3NDFjM2YtNmE1NC00MmQ4LTlhNWEtOGYxNjk0YTdlMjZlIn0.g8sZGK3mQKCrb1lgCFEXkXayWBtowQq_TKnZFoVyOb4","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"telefone\": \"3337371226\",\r\n \"endereco\": \"Rua das Andradas, 25, Planalto, Araçuai - Minas Gerais\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3333/me","description":"Esta rota permite que o usuário logado altere suas informações cadastrais. Por segurança, a identificação de qual usuário está sendo editado é feita através do Token JWT (extraído pelo middleware isAuthenticated), impedindo que um usuário altere os dados de outro.
isAuthenticated).Esta rota permite que o usuário autenticado encerre sua conta permanentemente. A identificação do registro a ser removido é feita de forma segura através do Token JWT presente no Header da requisição.
\nAtenção: Esta ação é irreversível e removerá todos os dados vinculados ao perfil do usuário no banco de dados.
\nisAuthenticated).Esta pasta contém todos os endpoints relacionados ao gerenciamento de usuários, suportando operações CRUD completas, criar, recuperar (por lista ou por ID), atualizar, atualizar status e excluir demandas.
\nEla também abrange o fluxo de aplicação, permitindo que os usuários se candidatem a uma demanda (\"candidatura\") ou retirem sua candidatura (\"desistência\"). As operações protegidas exigem autenticação baseada em JWT e aplicam o Controle de Acesso Baseado em Funções (RBAC), restringindo certas ações a funções autorizadas, como \"GESTOR\".
\n","_postman_id":"d634e466-b769-4273-82b0-e57dbbdaaf8e"},{"name":"Locais","item":[{"name":"get locations","id":"b91afed2-49d4-4cc8-b557-550b9f86c61a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJub21lIjoiVGF0eWFuZSBHb27Dp2FsdmVzIiwiZW1haWwiOiJ0YXR5YW5lZ29uY2FsdmVzMDIzQGdtYWlsLmNvbSIsImlhdCI6MTc3NzQ4OTU1MCwiZXhwIjoxNzc3NzQ4NzUwLCJzdWIiOiJlZTc0MWMzZi02YTU0LTQyZDgtOWE1YS04ZjE2OTRhN2UyNmUifQ.t1rVuq7lDz6okYiOX1Es-raR43NIp-oJZuR7ShzK3u8","type":"text"}],"url":"http://localhost:3333/locais","description":"Esta rota é responsável por retornar os dados detalhados do locais que está autenticado no momento.
\n","urlObject":{"protocol":"http","port":"3333","path":["locais"],"host":["localhost"],"query":[{"disabled":true,"key":"nome","value":"Marisol"}],"variable":[]}},"response":[],"_postman_id":"b91afed2-49d4-4cc8-b557-550b9f86c61a"},{"name":"create Locations","id":"8137ef89-4645-4580-abe2-4141bf79efad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJub21lIjoiVGF0eWFuZSBHb27Dp2FsdmVzIiwiZW1haWwiOiJ0YXR5YW5lZ29uY2FsdmVzMDIzQGdtYWlsLmNvbSIsImlhdCI6MTc3NzQ4Njk2MSwiZXhwIjoxNzc3NzQ2MTYxLCJzdWIiOiJlZTc0MWMzZi02YTU0LTQyZDgtOWE1YS04ZjE2OTRhN2UyNmUifQ.7uUhzMez5wwlWKKCOEX7sCDDLIwIu0L_Z2Q75LTzhhw","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Associação ABC\",\r\n \"endereco\": \"ABC\",\r\n \"telefone\": \"31669988831\",\r\n \"email\": \"ABC@email.com\",\r\n \"tipoLocal\": \"Coleta\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3333/locais","description":"O sistema utiliza RBAC (Role-Based Access Control), garantindo que funções críticas como o cadastro de locais de acolhimento sejam exclusivas para perfis do tipo GESTOR, prevenindo a propagação de informações falsas por usuários comuns.
\n","urlObject":{"protocol":"http","port":"3333","path":["locais"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"8137ef89-4645-4580-abe2-4141bf79efad"},{"name":"edit location by token","id":"99dd37d6-867b-45f0-b1a8-e6d247ca0d88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJub21lIjoiVGF0eWFuZSBHb27Dp2FsdmVzIiwiZW1haWwiOiJ0YXR5YW5lZ29uY2FsdmVzMDIzQGdtYWlsLmNvbSIsImlhdCI6MTc3NzQ4Njk2MSwiZXhwIjoxNzc3NzQ2MTYxLCJzdWIiOiJlZTc0MWMzZi02YTU0LTQyZDgtOWE1YS04ZjE2OTRhN2UyNmUifQ.7uUhzMez5wwlWKKCOEX7sCDDLIwIu0L_Z2Q75LTzhhw","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"3fc50276-8606-4ff9-9c9b-3b30a0fe8e57\",\r\n \"nome\": \"ONG Aprender\",\r\n \"telefone\": \"14682316794\",\r\n \"email\": \"ong-aprender@email.org\",\r\n \"tipoLocal\": \"Abrigo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3333/locais","description":"Para garantir a integridade dos dados e a segurança da plataforma, a vinculação de um local a um gestor é feita de forma automática via token JWT. Isso impede a manipulação de IDs por usuários mal-intencionados e assegura que apenas o responsável autenticado responda pelas informações do ponto de apoio.
\n","urlObject":{"protocol":"http","port":"3333","path":["locais"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"99dd37d6-867b-45f0-b1a8-e6d247ca0d88"},{"name":"delete locations by id","id":"7fd8ee87-7348-4872-ae23-cb7cb85ef87d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJub21lIjoiVGF0eWFuZSBHb27Dp2FsdmVzIiwiZW1haWwiOiJ0YXR5YW5lZ29uY2FsdmVzMDIzQGdtYWlsLmNvbSIsImlhdCI6MTc3NzQ4Njk2MSwiZXhwIjoxNzc3NzQ2MTYxLCJzdWIiOiJlZTc0MWMzZi02YTU0LTQyZDgtOWE1YS04ZjE2OTRhN2UyNmUifQ.7uUhzMez5wwlWKKCOEX7sCDDLIwIu0L_Z2Q75LTzhhw","type":"text"}],"url":"http://localhost:3333/locais/a7a3f31e-00a7-4f38-858c-3fcbc485fc82","description":"Para garantir a integridade dos dados e a segurança da plataforma, a vinculação de um local a um gestor é feita de forma automática via token JWT. Isso impede a manipulação de IDs por usuários mal-intencionados e assegura que apenas o responsável autenticado responda pelas informações do ponto de apoio.
\n","urlObject":{"protocol":"http","port":"3333","path":["locais","a7a3f31e-00a7-4f38-858c-3fcbc485fc82"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7fd8ee87-7348-4872-ae23-cb7cb85ef87d"}],"id":"904f9ffa-eede-4aae-82f7-d357cb2b348b","description":"Este módulo gerencia os pontos geográficos onde a ajuda voluntária acontece. Ele permite o mapeamento de centros de distribuição, abrigos ou bases de apoio.
\nRetorna as demandas disponíveis. Suporta filtros opcionais via Query Params (ex: por local, tipo de ajuda ou status).
\nAcesso: Autenticado.
\nExemplo de Query: {{baseUrl}}/demandas?status=Aberta&localId=123
Resposta (200 OK): Lista de demandas com detalhes do local vinculado.
\nBusca informações detalhadas de uma vaga específica.
\nAcesso: Autenticado.
\nPath Variable: id (UUID da demanda).
GET /demandas/aplicacoes
Permite que um voluntário consulte todas as vagas em que se inscreveu usando apenas o seu e-mail.
\nAcesso: Público.
\nbody obrigatório
\nPublica uma nova vaga de voluntariado no sistema.
\nAcesso: Autenticado + IsGestor.
\nBody (JSON):
\nRota para o voluntário registrar interesse em uma vaga.
\nAcesso: Público.
\nBody (JSON): Geralmente recebe dados do formulário como nome, email e telefone.
Edita informações como título, descrição ou quantidade de vagas.
\nAtualização rápida para mudar o estado da demanda (ex: de \"Aberta\" para \"Concluída\" ou \"Cancelada\").
\nAcesso: Autenticado + IsGestor.
\nBody: {\"status\": \"Concluída\"}
Remove a demanda e todas as candidaturas vinculadas a ela do sistema.
\nPermite que um voluntário remova sua candidatura de uma vaga específica.
\nAcesso: Público.
\nDica: Geralmente requer que o e-mail seja passado no Body ou Query para validar a posse da candidatura.
\nEste módulo gerencia as vagas de voluntariado. Ele conecta a necessidade dos Locais com a disponibilidade dos Voluntários.
\nEsta rota é responsável por as categorias. Ela utiliza o identificador contido no Token JWT para buscar as informações no banco de dados, garantindo que um usuário não acesse dados de terceiros.
\nisAuthenticated).Esta rota permite a criação de uma nova conta de voluntário no sistema. Ela valida os dados enviados através do middleware de validação e, se tudo estiver correto, persiste o novo voluntário no banco de dados. Geralmente, a senha é criptografada (hash) antes do salvamento por questões de segurança.
\nRequer Autenticação: Sim (Middleware isAuthenticated).
Validação: createVolunteerSchema (Garante que os dados seguem as regras de negócio, como e-mail único e força da senha).
Acesso: Apenas GESTORES.
\nEsta rota permite que o usuário logado altere o nome da categoria. Por segurança, a identificação de qual usuário está sendo editado é feita através do Token JWT (extraído pelo middleware isAuthenticated), impedindo que um usuário como VOLUNTARIO altere as categorias.
Requer Autenticação: Sim (Middleware isAuthenticated).
Validação: updateVolunteerSchema (Verifica se as informações fornecidas estão adequadas).
Tipo de Autenticação: Bearer Token.
\nAcesso: Via token do usuário que seja GESTOR.
\nEsta rota permite que o usuário autenticado deleta uma categoria pelo id. A identificação do registro a ser removido é feita de forma segura através do Token JWT presente no Header da requisição.
\nAtenção: Esta ação é irreversível e removerá todos os dados vinculados ao perfil do voluntário no banco de dados.
\nRequer Autenticação: Sim (Middleware isAuthenticated).
Tipo de Autenticação: Bearer Token.
\nAcesso: Próprio usuário logado.
\nEsta pasta contém todos os endpoints relacionados ao gerenciamento de categorias, suportando operações CRUD completas, criar, recuperar (por lista ou por ID), atualizar, e excluir categoria.
\nAs operações protegidas exigem autenticação baseada em JWT e aplicam o Controle de Acesso Baseado em Funções (RBAC), restringindo certas ações a funções autorizadas, como \"GESTOR\".
\n","_postman_id":"daa3df35-2284-4701-b56d-2c0b6fa58186"}]}