API
API ChurchApps — это модульный монолит: одна кодовая база, которая обслуживает шесть модулей данных, у каждого из которых своя база данных. Такая архитектура даёт организационные преимущества микросервисов (чёткие границы, независимые хранилища данных) при операционной простоте одного развёртывания.
Модули
| Модуль | Назначение |
|---|---|
| Membership | Люди, группы, домохозяйства, права доступа |
| Attendance | Служения, занятия, записи регистрации |
| Content | Страницы, разделы, элементы, трансляции |
| Giving | Пожертвования, фонды, обработка платежей |
| Messaging | Беседы, уведомления, email |
| Doing | Задачи, планы, назначения |
Технологический стек
- Среда выполнения: Node.js 24.x с TypeScript (ES-модули)
- Фреймворк: Express
- Внедрение зависимостей: Inversify (маршрутизация на декораторах)
- База данных: MySQL — по одной базе данных на модуль, у каждой свой пул соединений
- Аутентификация: JWT через
CustomAuthProvider - Развёртывание: AWS Lambda через Serverless Framework v3
Порты
| Протокол | Порт | Описание |
|---|---|---|
| HTTP | 8084 | Основной REST API |
| WebSocket | 8087 | Соединения сокетов в реальном времени |
Функции Lambda
При развёртывании в AWS API работает как шесть функций Lambda:
web— обрабатывает все HTTP-запросыsocket— управляет соединениями WebSockettimer15Min— запускается каждые 30 минут для email-уведомлений (название исторически сложилось именно так)timerMidnight— запускается ежедневно для дайджест-писем и служебных задачtimerScheduledTasks— запускается ежедневно для выполнения запланированных автоматизаций и обработки просроченных рабочих процессовtimerWebhooks— запускается каждую минуту для отправки исходящих вебхуков из очереди
Общие библиотеки
API зависит от двух общих пакетов ChurchApps:
@churchapps/helpers— базовые утилиты (DateHelper, ApiHelper и др.)@churchapps/apihelper— утилиты Express-сервера, включая аутентификацию, помощники работы с базой данных и интеграции с AWS
Информация
API использует ES-модули ("type": "module" в package.json). Убедитесь, что ваши импорты используют синтаксис ES-модулей.
В этом разделе
- Локальная установка — клонирование, настройка и локальный запуск API
- База данных — архитектура «одна база на модуль», скрипты схемы и паттерны доступа к данным
- Структура модулей — контроллеры, репозитории, модели и аутентификация
- API-ключи — персональные токены доступа для скриптов и коннекторов
- Подключённые приложения (OAuth) — многопользовательский OAuth-поток для сторонних приложений
- Вебхуки — отправка уведомлений о событиях во внешние системы
- MCP-сервер — конечная точка Model Context Protocol, которая открывает API для ИИ-ассистентов
- Справочник эндпоинтов — полная документация REST API для всех модулей