Модуль для YClients
Модуль для автоматической отправки SMS и email уведомлений из YCLIENTS через сервис Notificore.

Возможности

  • Автоматические уведомления при создании, отмене записи и напоминании
  • Ручная отправка сообщений выбранным клиентам
  • Массовая рассылка нескольким клиентам
  • Поддержка шаблонов сообщений с подстановкой данных
  • Система повторных попыток при ошибках отправки
  • Логирование всех отправок и вебхуков
Требования
  • Сервер с Python 3.12+
  • Аккаунт в YCLIENTS с правами разработчика
  • Аккаунт в Notificore с API ключом

⚠️ Инструкция требует умения работать с терминалом, открывать порты и настраивать вебхуки.

1. Подготовка
  • Убедитесь, что на сервере установлен Python 3.12+ (проверьте командой python3 --version).
  • Выполните на сервере:
git clone https://github.com/PetruschenkoEgor/notificore-yclients-module
cd notificore-yclients-module



2. Установка зависимостей (один раз)
Показать

3. Настройка переменных окружения (API‑ключи)
Создайте файл .env из примера:
Показать
Откройте его для редактирования:
Показать
Впишите свои ключи:
Показать

Сохраните (Ctrl+O, Enter, Ctrl+X).
Где взять ключи:
  • YCLIENTS → Настройки → Интеграции → API → создать приложение.
  • Notificore → Личный кабинет → API‑ключи.
4. Настройка CORS
Откройте файл app/main.py:
Показать
Найдите секцию CORS (или добавьте, если её нет).
Добавьте код
Показать

Внимание: Не оставляйте ["*"] в реальной работе. Вместо * укажите адрес, с которого будут приходить вебхуки от YCLIENTS: allow_origins=["https://ваш_домен.yclients.ru"]
Сохраните файл.

5. Запуск модуля
Запустите сервер с помощью этого кода (показать)

Модуль запустится и будет работать до закрытия терминала.
Чтобы он работал постоянно – используйте screen или systemd.

6. Настройка вебхуков в YCLIENTS
  1. Зайдите в YCLIENTS → Настройки → Интеграции → Webhooks.
  2. Добавьте новый вебхук:
  • URL: http://IP_вашего_сервера:8000/webhook/yclients (если у вас есть домен – используйте его, или внешний IP сервера)
  • События: выберите все нужные (запись создана, отменена, напоминание)
Сохраните.
Убедитесь, что порт 8000 открыт в фаерволе сервера:

7. Проверка и шаблоны сообщений
Откройте в браузере:
Показать URL

Там будет интерактивная документация – можно тестировать отправку.

Как изменить текст сообщений
Шаблоны жёстко заданы в коде модуля.
Вы можете их поменять вручную, отредактировав соответствующий .py файл.