91 lines
2.1 KiB
Markdown
91 lines
2.1 KiB
Markdown
# WhatsApp Bot - Planillas Río Frío
|
|
|
|
Este proyecto levanta un bot de WhatsApp utilizando [Open-WA](https://openwa.dev/) en Docker para integrar mensajes entrantes y salientes en el sistema de planillas de Beneficio Río Frío.
|
|
|
|
---
|
|
|
|
## 🚀 Cómo levantar el bot
|
|
|
|
1. **Clonar el repositorio**
|
|
|
|
```bash
|
|
git clone https://tu-repo.git
|
|
cd whatsapp-bot-planillas
|
|
```
|
|
|
|
2. **Configurar el entorno**
|
|
|
|
Crear un archivo `.env` basado en el ejemplo:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
Editá `.env` para definir tu `WA_API_KEY` y demás variables.
|
|
|
|
3. **Desplegar con Docker Compose**
|
|
|
|
```bash
|
|
docker compose -f docker-compose.whatsapp.yml up -d
|
|
```
|
|
|
|
4. **Escanear el QR**
|
|
|
|
- Ver los logs del contenedor.
|
|
- Escanear el código QR usando la app de WhatsApp Business.
|
|
|
|
5. **Probar conexión**
|
|
|
|
```bash
|
|
curl -H "x-api-key:TU_API_KEY" http://localhost:8080/chats
|
|
```
|
|
|
|
---
|
|
|
|
## 📦 Estructura del proyecto
|
|
|
|
```
|
|
whatsapp-bot-planillas/
|
|
├── docker-compose.whatsapp.yml
|
|
├── .env
|
|
├── .gitignore
|
|
└── README.md
|
|
```
|
|
|
|
---
|
|
|
|
## ⚙️ Variables de Entorno
|
|
|
|
| Variable | Descripción |
|
|
|------------------|---------------------------------------------------|
|
|
| WA_API_KEY | Clave privada para autenticación API |
|
|
| WA_SESSION_ID | Nombre de la sesión (por default `planillas`) |
|
|
| WA_DISABLE_SPINS | Evita spinners molestos en logs (`true`) |
|
|
| WA_WEBHOOK | URL para recibir mensajes entrantes (opcional) |
|
|
|
|
---
|
|
|
|
## 🔒 Seguridad
|
|
|
|
- **No publiques tu `.env**` ni los archivos de sesión (`sessions/`).
|
|
- Configurá Nginx Proxy Manager o Authentik para proteger tu endpoint.
|
|
|
|
---
|
|
|
|
## 📚 Recursos útiles
|
|
|
|
- [Documentación oficial Open-WA](https://openwa.dev/)
|
|
- [Referencia API Open-WA](https://openwa.dev/docs/api)
|
|
|
|
---
|
|
|
|
## 🛠️ Próximos pasos
|
|
|
|
- Conectar el webhook a `attendance-svc` o `core-hr`.
|
|
- Procesar mensajes y registrar asistencia automáticamente.
|
|
- Automatizar respuestas básicas via WhatsApp.
|
|
|
|
---
|
|
|
|
Hecho con ☕ y dedicación en Río Frío, Honduras.
|