Notificaciones

¿Qué son las Notificaciones?

Las notificaciones son mensajes generados por el sistema para informar a los usuarios sobre eventos importantes. Las notificaciones son específicas para cada usuario y solo se devuelven para el usuario autenticado actualmente. Las notificaciones pueden ser activadas por diversas acciones dentro de la aplicación y permiten que los usuarios se mantengan informados sobre actualizaciones relevantes.

Estructura de una solicitud de Notificaciones

Encabezados

Campo	Tipo	Descripción	Requerido
Authorization	string	Token Bearer para autenticación.	Sí

Parámetros de ruta

Campo	Tipo	Descripción	Requerido
entity	string	Nombre o ID de la entidad a importar.	Sí

Parámetros de consulta

Campo	Tipo	Descripción	Requerido
limit	number	Tamaño de página para la lista.	No
page	number	Página de paginación.	No
read	boolean	Filtrar por estado de lectura.	No

Sobre las notificaciones

Notificación

Campo	Tipo	Descripción
id	string	Identificador único de la notificación.
title	string	Título corto de la notificación.
message	string	Mensaje detallado de la notificación.
read	boolean	Indica si la notificación ha sido leída.
createdAt	string	Fecha y hora de creación de la notificación.
unreadCount	number	Cantidad de notificaciones no leídas (para el endpoint de conteo).
updatedCount	number	Cantidad de notificaciones marcadas como leídas (para el endpoint de leer todas).

Endpoints para gestionar Notificaciones

Obtener todas las notificaciones del usuario actual

Recupera todas las notificaciones para el usuario autenticado.

GET /api/v1/notifications

Ejemplo de respuesta:

{
  "errors": [],
  "status": 200,
  "error": false,
  "message": "Notificaciones obtenidas",
  "data": [ { <Notificación> } ],
  "pagination": { <Paginación> }
}

Obtener el conteo de notificaciones no leídas del usuario actual

Obtiene el conteo de notificaciones no leídas para el usuario autenticado.

GET /api/v1/notifications/unread-count

Ejemplo de respuesta:

{
  "errors": [],
  "status": 200,
  "error": false,
  "message": "Conteo de no leídas",
  "data": { "unreadCount": 0 }
}

Marcar una notificación como leída

Marca una notificación individual como leída.

PUT /api/v1/notifications/F0123456-7890-ABCD-EF00-00000000000/read

Ejemplo de respuesta:

{
  "errors": [],
  "status": 200,
  "error": false,
  "message": "Notificación marcada como leída",
  "data": {
    "id": "F0123456-7890-ABCD-EF00-00000000000",
    "read": true
  }
}

Marcar todas las notificaciones no leídas como leídas

Marca todas las notificaciones no leídas como leídas.

PUT /api/v1/notifications/read-all

Ejemplo de respuesta:

{
  "errors": [],
  "status": 200,
  "error": false,
  "message": "Todas las notificaciones marcadas como leídas",
  "data": { "updatedCount": 100 }
}

Eliminar una notificación por ID

Elimina una notificación por su identificador.

DELETE /api/v1/notifications/F0123456-7890-ABCD-EF00-00000000000

Ejemplo de respuesta:

{
  "errors": [],
  "status": 200,
  "error": false,
  "message": "Notificación eliminada",
  "data": {
    "id": "F0123456-7890-ABCD-EF00-00000000000"
  }
}