Saltearse al contenido

Inicio Rápido

¡Bienvenido a la documentación de la API de Autenticación SaaS! Esta guía te ayudará a comenzar con la implementación de autenticación y autorización en tu aplicación SaaS.

Prerrequisitos

Antes de empezar, asegúrate de tener:

  • Go 1.24.1 o superior instalado
  • Docker y Docker Compose instalados
  • Conocimientos básicos de APIs REST y conceptos de autenticación

Instalación

  1. Clona el repositorio:
Ventana de terminal
git clone https://github.com/yersonargotev/saas-auth-api.git
cd saas-auth-api
  1. Configura tus variables de entorno:
Ventana de terminal
cp .env.example .env
  1. Inicia el entorno de desarrollo:
Ventana de terminal
docker-compose -f docker-compose.dev.yml up

Uso Básico

Autenticación

La API proporciona varios endpoints para la autenticación de usuarios:

  • POST /api/v1/auth/register - Registrar un nuevo usuario
  • POST /api/v1/auth/login - Iniciar sesión con credenciales existentes
  • POST /api/v1/auth/refresh - Renovar token de acceso
  • POST /api/v1/auth/logout - Cerrar sesión de usuario

Autorización

Para rutas protegidas, incluye el token JWT en el encabezado de Autorización:

Ventana de terminal
Authorization: Bearer <tu_token_jwt>

Siguientes Pasos

  1. Revisa la Documentación de la API para información detallada sobre los endpoints
  2. Consulta la Guía de Desarrollo para la configuración de desarrollo local
  3. Sigue las Directrices de Seguridad para mejores prácticas

Soporte

Si encuentras algún problema o tienes preguntas: