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ódulo | Propósito |
|---|---|
| Membership | Personas, grupos, hogares, permisos |
| Attendance | Servicios, sesiones, registros de entrada |
| Content | Páginas, secciones, elementos, transmisión en vivo |
| Giving | Donaciones, fondos, procesamiento de pagos |
| Messaging | Conversaciones, notificaciones, correo electrónico |
| Doing | Tareas, 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
| Protocolo | Puerto | Descripción |
|---|---|---|
| HTTP | 8084 | API REST principal |
| WebSocket | 8087 | Conexiones 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 HTTPsocket: administra las conexiones WebSockettimer15Min: 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 mantenimientotimerScheduledTasks: se ejecuta diariamente para las automatizaciones vencidas y el procesamiento de flujos de trabajo atrasadostimerWebhooks: 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
- Configuración local: clone, configure y ejecute la API localmente
- Base de datos: arquitectura de una base de datos por módulo, scripts de esquema y patrones de acceso a datos
- Estructura de módulos: controladores, repositorios, modelos y autenticación
- Claves de API: tokens de acceso personales para scripts y conectores
- Aplicaciones conectadas (OAuth): flujo OAuth multiinquilino para aplicaciones de terceros
- Webhooks: envíe notificaciones de eventos a sistemas externos
- Servidor MCP: endpoint del Protocolo de contexto de modelos que expone la API a asistentes de IA
- Referencia de endpoints: documentación REST completa de la API para todos los módulos