Pular para o conteúdo principal

API

A API do ChurchApps é um monólito modular -- uma única base de código que atende seis módulos de dados, cada um com seu próprio banco de dados. Essa arquitetura oferece os benefícios organizacionais de microsserviços (limites claros, armazenamentos de dados independentes) com a simplicidade operacional de uma única implantação.

Módulos​

MóduloFinalidade
MembershipPessoas, grupos, domicílios, permissões
AttendanceCultos, sessões, registros de check-in
ContentPáginas, seções, elementos, transmissões
GivingDoações, fundos, processamento de pagamentos
MessagingConversas, notificações, e-mail
DoingTarefas, planos, atribuições

Stack tecnológica​

  • Runtime: Node.js 24.x com TypeScript (módulos ES)
  • Framework: Express
  • Injeção de dependências: Inversify (roteamento baseado em decoradores)
  • Banco de dados: MySQL -- um banco por módulo, cada um com seu próprio pool de conexões
  • Autenticação: autenticação JWT via CustomAuthProvider
  • Implantação: AWS Lambda via Serverless Framework v3

Portas​

ProtocoloPortaDescrição
HTTP8084API REST principal
WebSocket8087Conexões socket em tempo real

Funções Lambda​

Quando implantada na AWS, a API roda como seis funções Lambda:

  • web -- Trata todas as requisições HTTP
  • socket -- Gerencia as conexões WebSocket
  • timer15Min -- Roda a cada 30 minutos para notificações por e-mail (o nome é histórico)
  • timerMidnight -- Roda diariamente para e-mails de resumo e tarefas de manutenção
  • timerScheduledTasks -- Roda diariamente para automações vencidas e processamento de fluxos de trabalho atrasados
  • timerWebhooks -- Roda a cada minuto para entregar webhooks de saída enfileirados

Bibliotecas compartilhadas​

A API depende de dois pacotes compartilhados do ChurchApps:

  • @churchapps/helpers -- Utilitários base (DateHelper, ApiHelper etc.)
  • @churchapps/apihelper -- Utilitários do servidor Express, incluindo autenticação, auxiliares de banco de dados e integrações com a AWS
Info

A API usa módulos ES ("type": "module" no package.json). Certifique-se de que suas importações usem a sintaxe de módulos ES.

Nesta seção​