Integ Docs | API

Appearance

Getting Started ​

Добро пожаловать в документацию Integ API! Это руководство поможет вам быстро начать работу с проектом.

Что такое Integ API? ​

Integ API — это NestJS-based backend сервис для управления и обработки интеграций в экосистеме Happ. API служит интеграционным слоем, обрабатывая аутентификацию, управление пользователями и оркестрацию интеграций для различных каналов коммуникации и внешних сервисов.

Основные возможности ​

  • Управление интеграциями: Создание, настройка и управление различными интеграциями
  • Система secrets: Безопасное хранение и управление секретами для интеграций
  • Handlers: Гибкая система обработчиков для различных событий интеграций
  • JWT Authentication: Безопасная аутентификация с использованием JWT токенов
  • Access Tokens: Управление токенами доступа для внешних API
  • Audit Logging: Логирование изменений конфигураций и секретов
  • Cache: Интегрированная система кэширования через Redis

Требования к системе ​

Перед началом работы убедитесь, что у вас установлены следующие компоненты:

  • Node.js: версия 20.x или выше
  • npm: версия 10.x или выше
  • Docker: версия 24.x или выше
  • Docker Compose: версия 2.x или выше
  • Doppler CLI: для управления переменными окружения

Структура проекта ​

integ-api/
├── src/
│   ├── app/                    # Основной код приложения
│   │   ├── core/              # Глобальные конфигурации
│   │   ├── shared/            # Общие модули и утилиты
│   │   ├── auth/              # Аутентификация
│   │   ├── users/             # Управление пользователями
│   │   └── integrations/      # Управление интеграциями
│   ├── environments/          # Конфигурации окружений
│   ├── migrations/            # TypeORM миграции
│   └── main.ts                # Точка входа приложения
├── docs/                      # Дополнительная документация
├── scripts/                   # Вспомогательные скрипты
├── docker-compose.yml         # Docker конфигурация
└── package.json               # Зависимости проекта

Следующие шаги ​

Рекомендуем начать с руководств

Для новых разработчиков рекомендуем начать с раздела Руководства, где есть пошаговая Первоначальная настройка.

Полезные ссылки ​