Aller au contenu principal

API

L'API ChurchApps est un monolithe modulaire -- une seule base de code qui sert six modules de données, chacun disposant de sa propre base de données. Cette architecture offre les avantages organisationnels des microservices (frontières claires, magasins de données indépendants) avec la simplicité opérationnelle d'un déploiement unique.

Modules​

ModuleObjet
MembershipPersonnes, groupes, foyers, autorisations
AttendanceServices, séances, registres de pointage
ContentPages, sections, éléments, diffusion en direct
GivingDons, fonds, traitement des paiements
MessagingConversations, notifications, courriels
DoingTâches, plans, affectations

Pile technique​

  • Environnement d'exécution : Node.js 24.x avec TypeScript (modules ES)
  • Framework : Express
  • Injection de dépendances : Inversify (routage basé sur les décorateurs)
  • Base de données : MySQL -- une base par module, chacune avec son propre pool de connexions
  • Authentification : authentification par JWT via CustomAuthProvider
  • Déploiement : AWS Lambda via Serverless Framework v3

Ports​

ProtocolePortDescription
HTTP8084API REST principale
WebSocket8087Connexions socket en temps réel

Fonctions Lambda​

Lorsqu'elle est déployée sur AWS, l'API s'exécute sous forme de six fonctions Lambda :

  • web -- Traite toutes les requêtes HTTP
  • socket -- Gère les connexions WebSocket
  • timer15Min -- S'exécute toutes les 30 minutes pour les courriels de notification (le nom est historique)
  • timerMidnight -- S'exécute chaque jour pour les courriels récapitulatifs et les tâches de maintenance
  • timerScheduledTasks -- S'exécute chaque jour pour les automatisations échues et le traitement des flux de travail en retard
  • timerWebhooks -- S'exécute chaque minute pour livrer les webhooks sortants en file d'attente

Bibliothèques partagées​

L'API dépend de deux paquets partagés de ChurchApps :

  • @churchapps/helpers -- Utilitaires de base (DateHelper, ApiHelper, etc.)
  • @churchapps/apihelper -- Utilitaires du serveur Express, dont l'authentification, les aides de base de données et les intégrations AWS
info

L'API utilise les modules ES ("type": "module" dans package.json). Assurez-vous que vos importations utilisent la syntaxe des modules ES.

Dans cette section​