Saltar al contenido principal

API

La API de ChurchApps es un monolito modular: una sola base de código que sirve a seis módulos de datos, cada uno con su propia base de datos. Esta arquitectura ofrece los beneficios organizativos de los microservicios (límites claros, almacenes de datos independientes) con la sencillez operativa de un único despliegue.

Módulos​

MóduloPropósito
MembershipPersonas, grupos, hogares, permisos
AttendanceServicios, sesiones, registros de entrada
ContentPáginas, secciones, elementos, transmisión en vivo
GivingDonaciones, fondos, procesamiento de pagos
MessagingConversaciones, notificaciones, correo electrónico
DoingTareas, planes, asignaciones

Stack tecnológico​

  • Runtime: Node.js 24.x con TypeScript (módulos ES)
  • Framework: Express
  • Inyección de dependencias: Inversify (enrutamiento basado en decoradores)
  • Base de datos: MySQL: una base de datos por módulo, cada una con su propio pool de conexiones
  • Autenticación: autenticación basada en JWT mediante CustomAuthProvider
  • Despliegue: AWS Lambda mediante Serverless Framework v3

Puertos​

ProtocoloPuertoDescripción
HTTP8084API REST principal
WebSocket8087Conexiones de socket en tiempo real

Funciones Lambda​

Cuando se despliega en AWS, la API se ejecuta como seis funciones Lambda:

  • web: atiende todas las solicitudes HTTP
  • socket: administra las conexiones WebSocket
  • timer15Min: se ejecuta cada 30 minutos para las notificaciones por correo electrónico (el nombre es histórico)
  • timerMidnight: se ejecuta diariamente para los correos de resumen y las tareas de mantenimiento
  • timerScheduledTasks: se ejecuta diariamente para las automatizaciones vencidas y el procesamiento de flujos de trabajo atrasados
  • timerWebhooks: se ejecuta cada minuto para entregar los webhooks salientes en cola

Bibliotecas compartidas​

La API depende de dos paquetes compartidos de ChurchApps:

  • @churchapps/helpers: utilidades base (DateHelper, ApiHelper, etc.)
  • @churchapps/apihelper: utilidades del servidor Express, incluidas la autenticación, los auxiliares de base de datos y las integraciones con AWS
info

La API usa módulos ES ("type": "module" en package.json). Asegúrese de que sus importaciones usen la sintaxis de módulos ES.

En esta sección​