Comenzando con la API
¡Bienvenido a la documentación de la API de FactuStorm! Esta guía te ayudará a comenzar con la implementación de la API de FactuStorm en tu aplicación.
Prerrequisitos
Antes de comenzar, asegúrate de tener:
- Go 1.24.1 o superior instalado
- Docker y Docker Compose instalados
- Comprensión básica de APIs REST y conceptos de autenticación
Instalación
- Clona el repositorio:
git clone https://github.com/yersonargotev/saas-auth-api.gitcd saas-auth-api
- Configura tus variables de entorno:
cp .env.example .env
- Inicia el entorno de desarrollo:
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 usuarioPOST /api/v1/auth/login
- Iniciar sesión con credenciales existentesPOST /api/v1/auth/refresh
- Renovar token de accesoPOST /api/v1/auth/logout
- Cerrar sesión
Autorización
Para rutas protegidas, incluye el token JWT en el encabezado de Autorización:
Authorization: Bearer <tu_token_jwt>
Próximos Pasos
- Revisa la Documentación de la API para información detallada de los endpoints
- Consulta la Guía de Desarrollo para la configuración del desarrollo local
- Sigue las Guías de Seguridad para las mejores prácticas
Soporte
Si encuentras algún problema o tienes preguntas:
- Abre un issue en GitHub
- Únete a nuestra comunidad de Discord