Темный режим

8. n8n API

Общая информация

Бэкенд приложения HRoom полностью размещен на сервере api.hroom.ai и построен с использованием платформы n8n.

Что такое n8n?

n8n - это открытая платформа автоматизации рабочих процессов, которая позволяет визуально создавать, интегрировать и запускать рабочие процессы без написания кода. Это мощный инструмент, который позволяет связывать различные сервисы и API, обрабатывать данные и автоматизировать бизнес-процессы.

Ключевые особенности n8n:

  • Визуальный редактор процессов - интуитивно понятный интерфейс для создания рабочих процессов
  • Большое количество интеграций - готовые коннекторы для сотен сервисов и API
  • Гибкость и расширяемость - возможность создания собственных узлов и интеграций
  • Возможность запуска по расписанию - автоматическое выполнение процессов в определенное время
  • Обработка ошибок - механизмы обработки исключений и ошибок

Архитектура бэкенда HRoom

Бэкенд приложения HRoom построен на основе n8n с использованием базы данных PostgreSQL. Такая архитектура обеспечивает гибкость, масштабируемость и надежность системы.

Основные компоненты бэкенда:

  • n8n сервер - обрабатывает API-запросы и выполняет рабочие процессы
  • PostgreSQL - реляционная база данных для хранения всех данных приложения
  • API endpoints - набор конечных точек для взаимодействия с фронтендом
  • Cron-задачи - процессы, выполняемые по расписанию

В рамках каждого API-процесса n8n выполняет следующие шаги:

  1. Принимает HTTP-запрос от клиента
  2. Проверяет аутентификацию и авторизацию
  3. Извлекает и валидирует параметры запроса
  4. Выполняет бизнес-логику (запросы к БД, обработка данных и т.д.)
  5. Формирует ответ и отправляет его клиенту

Обзор API-endpoints

API-сервер HRoom предоставляет множество конечных точек для различных функций приложения. Каждая API-endpoint обрабатывает определенный тип запросов и отвечает за конкретную часть функциональности:

Team Metrics API

API для получения метрик команд и анализа производительности.

Подробнее

Metrics Dynamic API

API для получения динамических метрик и их изменений во времени.

Подробнее

Admin API

API для административных функций и управления системой.

Подробнее

Surveys API

API для работы с опросами, их создания и управления.

Подробнее

Survey Processing API

API для обработки результатов опросов и анализа данных.

Подробнее

Cron Survey Processing

Автоматическая обработка опросов по расписанию.

Подробнее

Translations API

API для получения переводов из базы данных с гибкой фильтрацией по ключу и типу.

Подробнее

Unsubscribe API

API для управления подписками сотрудников и менеджеров с авторизацией по токену.

Подробнее

Questions API

API для получения данных опросов с различными фильтрами и агрегацией результатов.

Подробнее

AI Sync Data

Workflow для обработки данных опросов сотрудников и генерации аналитических инсайтов.

Подробнее

Profile API

API для управления профилями пользователей и компаний с авторизацией по токену.

Подробнее

Departments API

CRUD API для управления отделами компании с авторизацией по токену.

Подробнее

Auth API

Полноценная система аутентификации с регистрацией, активацией аккаунта, восстановлением пароля и авторизацией.

Подробнее

AI Get API

API для получения данных искусственного интеллекта с фильтрацией по различным параметрам.

Подробнее

Employees API

CRUD API для управления сотрудниками компании с авторизацией по токену и расширенными возможностями фильтрации.

Подробнее

Import API

Workflow для импорта сотрудников с обработкой данных.

Подробнее

Engagement Score API

API для расчета показателей вовлеченности сотрудников на основе данных опросов.

Подробнее

Survey Get API

API для получения данных опроса с проверкой доступа пользователя.

Подробнее

Survey Send API

Прием и обработка данных опроса с валидацией пользователя и обновлением статистики опроса.

Подробнее

Полный список API-endpoint можно найти в соответствующих разделах документации.