tsmanuelanton / satec-notification-service

Servicio que permite a usuarios registrados gestionar de manera centralizada la comunicación para con sus listas de suscriptores mediante el envío de notificaciones.

🔔 satec-notification-service

Servicio que permite registrar usarios para enviarles notificaciones/mensajes a través de múltiples plataformas.

El sistema ofrece una API desarrollada con Django Rest Framework para gestionar las suscripciones, ver plataformas disponibles o añadir aplicaciones que generen notificaciones.

Tabla de Contenidos 📚

• Plataformas disponibles 📋
• Rutas de la API 🗺️
• Instalación 📦
• Recomendaciones 💡

Plataformas disponibles 📋

El servicio ofrece, actualmente, los siguientes medios para recibir las notificaciones/mensajes.

• Navegador web: Los suscriptores de esta plataforma reciben los mensajes en su navegador web gracias a la tecnología web Push API.

• Slack: Obtén notificaciones en tu chat de Slack mediante este conector.
• Microsoft Teams: Recibe las notificaciones directamente en Microsoft Teams.
• Telegram: Recibe notificaciones en la plataforma de mensajería Telegram.
• Email: Permite enviar mensajes a la bandeja de correo que quieras.

Rutas de la API 🗺️

Las rutas cumplen con la especificación OpenAPI. Para obtener más detalles de los endponts están disponibles bajo la ruta api/v1/schema.

Endpoint	GET	POST	PUT	DELETE
api/v1/subscriptions	Listar las suscripciones	Registrar una suscripción	N/A	N/A
api/v1/subscriptions/id	Detalles de la suscripción	N/A	Actualizar la suscripción	Eliminar suscripción
api/v1/groups	Listar grupos de suscripción	Registrar grupo	N/A	N/A
api/v1/groups/id	Detalles del grupo de suscripción	N/A	Actualizar el grupo	Eliminar grupo
api/v1/services	Listar los servicios	Registrar un nuevo servicio	N/A	N/A
api/v1/services/id	Detalles del servicio	N/A	Actualizar servicio	Eliminar servicio
api/v1/conectors	Muestra los conectores disponibles	N/A	N/A	N/A
api/v1/conectors/id	Detalles del conector	N/A	N/A	N/A
api/v1/notifications	N/A	Enviar mensaje para notificar a los suscriptores	N/A	N/A

Instalación 📦

Creamos un directorio e inicilizamos un entorno virtual de python dentro. Depués, ejecutamos los siguientes comandos

git clone https://github.com/UO276213/satec-notification-service.git
cd satec-notification-service
cd app
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py manageconectors --add
python manage.py runserver

Recomendaciones 💡

Python 3.8 o superior. El servicio podría no funcionar para versiones anteriores.