Description

n8n-nodes-moyklass

Community node для n8n, позволяющий работать с CRM МойКласс (MoyKlass).

Установка

Установка через Community Nodes (рекомендуется)

1. Откройте n8n
2. Перейдите в Settings → Community Nodes
3. Нажмите Install
4. Введите n8n-nodes-moyklass
5. Нажмите Install

Ручная установка

Для самостоятельного хостинга n8n добавьте пакет в переменную окружения:

export N8N_CUSTOM_EXTENSIONS="/path/to/n8n-nodes-moyklass"

Настройка

Получение API ключа

1. Войдите в CRM МойКласс
2. Перейдите в Настройки → Интеграции
3. Создайте новый API ключ
4. Скопируйте ключ

Создание Credentials в n8n

1. В n8n создайте новое подключение типа MoyKlass API
2. Вставьте ваш API ключ
3. Сохраните

Возможности

Node поддерживает работу со следующими ресурсами:

📚 Основные ресурсы

• User (Ученик/Лид) – управление учениками и лидами
• Payment (Платеж) – работа с платежами
• Invoice (Счет) – управление счетами
• Manager (Сотрудник) – управление сотрудниками
• Lesson (Урок) – работа с уроками
• Class (Группа) – управление группами
• Join (Запись в группу) – управление записями учеников в группы
• Task (Задача) – работа с задачами
• File (Файл) – управление файлами
• Subscription (Вид абонемента) – управление видами абонементов
• User Subscription (Абонемент ученика) – управление абонементами учеников
• Comment (Комментарий) – работа с комментариями
• Lesson Record (Отметка о посещении) – управление отметками о посещении
• Room (Помещение) – управление помещениями
• Cashbox (Касса) – управление кассами
• Bonus Program (Бонусная программа) – работа с бонусной программой
• Family (Семья) – управление семьями учеников

🏢 Справочники компании

• Company – получение справочников:
  • Источники рекламы
  • Источники создания
  • Причины статусов
  • Филиалы
  • Атрибуты учеников
  • Курсы
  • Статусы записей
  • Статусы клиентов
  • Теги записей
  • Типы платежей
  • Роли
  • Теги учеников

Операции

Для большинства ресурсов доступны стандартные операции:

• Get All – получить список всех записей (с поддержкой пагинации)
• Get – получить одну запись по ID
• Create – создать новую запись
• Update – обновить существующую запись
• Delete – удалить запись

Некоторые ресурсы имеют специальные операции:

• User: обновление статуса, управление тегами, обновление атрибутов
• Lesson: обновление статуса, отметка посещения ученика
• Join: обновление статуса записи
• User Subscription: обновление статуса, заморозка абонемента

Примеры использования

Пример 1: Получить всех учеников

Resource: User (Ученик)
Operation: Get All
Return All: true
Additional Fields:
  - Include Archive: false

Пример 2: Создать нового ученика

Resource: User (Ученик)
Operation: Create
JSON Body:
{
  "name": "Иван Иванов",
  "phone": "+79001234567",
  "email": "ivan@example.com"
}

Пример 3: Получить платежи за период

Resource: Payment (Платеж)
Operation: Get All
Additional Fields:
  - Date From: 2024-01-01
  - Date To: 2024-01-31
  - Limit: 100

Пример 4: Создать урок

Resource: Lesson (Урок)
Operation: Create
JSON Body:
{
  "classId": 123,
  "date": "2024-01-20",
  "beginTime": "10:00",
  "endTime": "11:30",
  "title": "Математика"
}

Пример 5: Отметить посещение ученика

Resource: Lesson (Урок)
Operation: Mark Student
ID: 12345
JSON Body:
{
  "type": "visit",
  "userId": 67890
}

Пагинация

Для операций Get All доступна пагинация:

• Установите Return All в false для получения только первой страницы
• Установите Return All в true для автоматического получения всех страниц
• Используйте Limit в дополнительных полях для контроля размера страницы (макс. 100)
• Используйте Offset для ручной пагинации

Ограничения API

⚠️ Важно: API MoyKlass имеет ограничение не более 7 запросов в секунду.

Рекомендуется использовать:

• Добавление задержек между запросами в циклах
• Использование пакетной обработки где возможно

Документация API

Полная документация API MoyKlass доступна по адресу: https://api.moyklass.com

Поддержка

• 📧 Email: bekzat.zhm@gmail.com
• 🌐 Github: @elapen
• 📖 База знаний: https://help.moyklass.com

Лицензия

MIT

Разработка

Требования

• Node.js >= 16.x
• npm >= 8.x

Установка зависимостей

npm install

Сборка

npm run build

Разработка

npm run dev

Версии

1.0.0

• Первый релиз
• Поддержка всех основных ресурсов API MoyKlass
• 139 эндпоинтов API
• Поддержка пагинации
• Полная поддержка CRUD операций