Bem-vindo à documentação da API Gympass Style! Esta API permite aos usuários realizar check-ins em academias, buscar informações sobre academias, cadastrar-se e autenticar-se. Além disso, o usuário só pode fazer check-ins em academias próximas.

• Deve ser possível se cadastrar.
• Deve ser possível se autenticar.

• Deve ser possível obter o perfil de um usuário logado.

• Deve ser possível obter o número de check-ins realizados pelo usuário logado.
• Deve ser possível o usuário realizar check-in em uma academia.
• Deve ser possível validar o check-in.

• Deve ser possível o usuário buscar academias próximas.
• Deve ser possível o usuário buscar academias pelo nome.

• Deve ser possível cadastrar uma academia.

• O usuário não deve poder se cadastrar com um e-mail duplicado.

• O usuário não pode fazer 2 check-ins no mesmo dia.
• O usuário não pode fazer check-in se não estiver a (180k) da academia.
• O check-in pode ser validado até 20 minutos após criado.
• O check-in só pode ser validado por administradores.

• A academia só pode ser cadastrada por administradores.

• A senha do usuário precisa estar criptografada.
• O usuário deve ser identificado por um JWT.

• Os dados da aplicação precisam estar persistidos em um banco PostgreSQL.

• Todas as listas de dados precisam estar paginadas com 20 itens por página.

• Endpoint: GET /gyms/nearby
• Restrições: Requer autenticação JWT.

• Endpoint: GET /gyms/search
• Restrições: Requer autenticação JWT.

• Endpoint: POST /gyms
• Restrições: Requer autenticação JWT.

{
  "title": "Referencial academia",
  "description": "A melhor academia da cidade",
  "phone": "19991890255",
  "latitude": 12.2222,
  "longitude": "24.111"
}

• Restrições: Apenas administradores podem realizar essa operação.
  Requer autenticação JWT.

• Endpoint: GET /check-ins/history
• Restrições: Requer autenticação JWT.

• Endpoint: GET /check-ins/metrics
• Restrições: Requer autenticação JWT.

• Endpoint: POST /gyms/:gymId/check-ins
• Função: create
• Restrições: Requer autenticação JWT.

Permite ao usuário admin(geralmente o funcionário da academia), confirmar o checkin do usuário para liberar o seu acesso

• Endpoint: POST /users

{
	"name": "Bruno Tetzner",
	"email": "[email protected]",
	"password": "123456"
}

• Endpoint: POST /sessions

• Endpoint: PATCH /token/refresh

• Endpoint: GET /me
• Restrições: Requer autenticação JWT.