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

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

Лицензионный ключ отправляется автоматически на почту аккаунта покупателя, если письма Вы не нашли, проверьте папку спам, если письмо в спаме, то пожалуйста поставьте отметку не спам. При отсутствии ключа в папке спам напишите в поддержку. Подробная информация о получении файлов и ключа по ссылке.
Купить модуль можно по ссылке.

 

Установка:

1. Разархивируйте архив
2. В админ панели сайта меню Дополнения - Установка дополнений - Загрузите архив artgram.ocmod.zip
3. Меню Менеджер дополнений (Модификации) - обновите кэш модификаций
4. Установите модуль в разделе Админ панель - Дополнения - Модули - ART&PR Telegram PRO (при отсутвии данного модуля в меню воспользуйтесь установкой вручную описанной ниже)
5. Зайдите в настройки модуля (ссылка Изменить)
6. Введите настройки. (Если Вы не получили лицензионный ключ, то запросите его по ссылке).
7. Для поля SecretKey сгенерируйте надежный пароль (этот пароль Вы будите использовать при настройке сервера, см. пункт НАСТРОЙКА СЕРВЕРА)
8. В поле Адрес сервера указывайте адрес до файла proto.php (см. пункт НАСТРОЙКА СЕРВЕРА), в месте с названием файла ( https://server.ru/proto.php )
9. Включить модуль (статус включено). Сохранить настройки.
10. Для магазинов 3.0 Очистите кеш шаблонов (главная страница админ панели -> шестеренка справа вверху)

Установка вручную:

1. Разархивируйте архив
2. Разархивируйте архив artgram.ocmod.zip, внутри папка upload и файл install.xml
3. С помощью файлового доступа к сайту (ftp или ssh) загрузите все содержимое папки upload в корень сайта
4. Для магазинов 2.0-2.1 Переименуйте install.xml в artgram.ocmod.xml
5. В админ панели сайта меню Дополнения - Установка дополнений - Загрузите файл artgram.ocmod.xml
6. Меню Менеджер дополнений (Модификации) - обновите кэш модификаций
7. Установите модуль в разделе Админ панель - Дополнения - Модули - ART&PR Telegram PRO (ВНИМАНИЕ! отсутствие данного пункта может быть свзяно с отсутвием языка модуля, копируйте папку языка из архива в свою папку языка, либо вы произвели копирование файлов не корректно)
8. Зайдите в настройки модуля (ссылка Изменить)
9. Введите настройки. (Если Вы не получили лицензионный ключ, то запросите его по ссылке)
10. Для поля SecretKey сгенерируйте надежный пароль (этот пароль Вы будите использовать при настройке сервера, см. пункт НАСТРОЙКА СЕРВЕРА)
11. В поле Адрес сервера указывайте адрес до файла proto.php (см. пункт НАСТРОЙКА СЕРВЕРА), в месте с названием файла ( https://server.ru/proto.php )
12. Включить модуль (статус включено). Сохранить настройки.
13. Для магазинов 3.0 Очистите кеш шаблонов (главная страница админ панели -> шестеренка справа вверху)

 

Обновление на новую версию:

1. Создайте резервную копию базы данных и файлов сайта
2. Для магазинов 2.0-2.1 Удалите модификатор модуля
3. Установите модуль согласно инструкции УСТАНОВКА выше с перезаписью файлов (не забудте обновить модификаторы и кеш шаблона)
4. Внимание! Обязательно пересохраните настройки.
5. При обновляении модуля обновляйте также файлы сервера.

Настройка сервера:
В качестве сервера используется открытая библиотека MadelineProto
Для Вашего удобства созданы файлы https://disk.yandex.ru/d/FjptOEbnpoYk7g

1. Скачайте файлы и разместите на сайте с php 8.2 и выше, в папке или корне сайта https://disk.yandex.ru/i/Qb9A8UYlkCzaqg.
   Подойдет обычный хостинг. Рекомендуется размещать сервер отдельно от сайта, более того Вы можете использовать 1 сервер для разных сайтов при условии привязки одного и того же аккаунта телеграм.
   Если вы хотите использовать сервер для разных аккаунтов отправителя https://disk.yandex.ru/i/0RYdQqZugrWwig, то вы можете разместить каждый сервер в отдельной папке (к каждой копии сервера возможно привязать только один аккаунт отправителя) https://disk.yandex.ru/i/9V6HJISi9bl34Q.
2. Введите адрес фала login.php в адресной строке (например https://myserver.ru/login.php или при размещении в папке https://myserver.ru/server1/login.php)
3. Библиотека автоматически скачается на сервер (первоначальный запуск возможно потребует время, при появлении ошибок или проблем увеличте время работы php скриптов)
4. Следуйте инструкциям на экране для авторизации, авторизуйтесь обязательно только как пользователь.
5. Отредактируйте файл proto.php, заполните secretKey который вы указали в настройках модуля опенкарт https://disk.yandex.ru/i/Ul-9i_5mrIkQLg
6. При необходимости заполните IP адрес для ограничения доступа, введите IP адрес сайта с которого будет приходить запрос https://disk.yandex.ru/i/AXT-ls3N5EPRaw
7. Сохраните изменения в файле.
8. В настройках модуля укажите адрес до файла proto.php (например https://myserver.ru/proto.php или при размещении в папке https://myserver.ru/server1/proto.php) https://disk.yandex.ru/i/fENerpXRDFkmgw
9. Файл logout.php пригодится в случае если что-то пошло не так, поможет отвязать аккаунт от сервера, рекомендуется удалить или преименовать расширение php и использовать только в случае необходимости.

Инструкция по работе:

1. При смене статуса или создания заказа отправляется сообщение созданное Вами в настройках модуля
2. Вы можете использовать разные сообщения для разных статусов а также в зависимости от Нового заказа или смены статуса уже созданного заказа.
3. В настройках модуля добавьте нужное сообщение нажатием на кнопку "карандаш", введите текст, сохраните настройки.
4. В тексте комментариев Вы можете использовать переменные из заказа указанные ниже в разделе Переменные.

Не работает отправка сообщения:

1. Включите режим отладки в настройках модуля (Отладка - да)
2. В стандартном просмотре заказа (не редактировании) смените статус у заказа (добавьте историю), на тот статус для которого настроены уведомления.
3. Смотрите журнал ошибок магазина (система-обслуживание-журнал ошибок) на предмет записи artgram Debug:

Запись artgram Debug отсутвует - проблема с работой событий или не обновлен кеш модификаторов.
При наличии записи - в ней будет ответ с содержанием ошибки от сервиса отправки сообщений telegram.

 

Дублируются сообщения:

Обратите внимание на историю заказа, некоторые модули которые управляют статусами заказа могут создавать дубли одинаковых статусов в одно и то же время (очень часто встречается в бесплатных модулях оплаты), по этой причине сообщения могут уходить повторно, так как был инициирован статус на который был настроен модуль сообщений.

Обойти данную проблему можно только исправив работу модуля который устанавливает статусы или использовать сообщения на другой статус, к сожалению в таком случае вам нужно этот следующий статус как то запустить (вручную например или какимто модулем автомтического обновления статусов)
 

Использование шаблонов с сылками на оплату:

Функционал доступен только для магазинов 2.3 и 3.0.
Теперь вы можете использовать ссылки на оплату для формирования шаблона с использованием переменной ~paylink~
эта переменная работает только когда в заказе установлен метод оплаты ART&PR с возможностью генерации ссылок.

 

Переменные и использование полей из Simple:

Свои поля стандартного оформления заказа

Расположение Адрес оплаты
~payAddrCustom_IDПОЛЯ~

Расположение Адрес доставки
~shipAddrCustom_IDПОЛЯ~

Расположение Аккаунт
~accCustom_IDПОЛЯ~

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

 

Свои поля simple

ID поля берется из вкладки "Настройка полей"

Для Simple 4.x
~paymentsimple4_IDполя~ - поле привязанное к адресу оплаты
~shippingsimple4_IDполя~ - поле привязанное к адресу доставки
~simple4_IDполя~ - поле привязанное к учетной записи покупателя или поле привязанное к методу

Выбор отображения отчества покупателя
Пример: 
Отчество: ~simple4_otchestvo~

 

Сторонние модули (работает в эксперементальном режиме):

Трек-номер заказа (toporchillo):
переменная ~track_no~ - добавляет номер накладной при условии что он существует в заказе.

 

Перемененная ~status_comment~ добавляет текст комментария из данного обновления статуса (например модули оплаты добавляют свои комментарии или вы вручную вписали текст комментария через просмотр заказа и добавление истории, или модули доставки которые меняют статус и добавляют в комментарий трек номер, теперь эти данные можно отправить в telegram)

Также доступны переменные:
~order_id~ - номер заказа
~totals~ - итого заказа в валюте заказа
~products~ - состав заказа
~telephone~ - номер телефона
~dateNumOrder~ - дата заказа в формате 20.12.2021
~status_update~ - имя статуса на который происходит смена
~invoice_no~ - номер счета 
~invoice_prefix~ - префикс счета 
~store_id~ - id магазина 
~store_name~ - название магазина 
~store_url~ - url магазина 
~customer_id~ - id покупателя 
~customer_group_id~ - id группы покупателя
~fax~ - факс 
~email~ - почта 
~payment_firstname~ - имя плательщика 
~payment_lastname~ - фамилия плательщика 
~payment_company~ - компания плательщика 
~payment_address_1~ - адрес плательщика 
~payment_address_2~ - адрес2 плательщика 
~payment_postcode~ - индекс плательщика 
~payment_city~ - город плательщика 
~payment_zone_id~ - id гео зоны плательщика 
~payment_zone~ - гео зона плательщика 
~payment_zone_code~ - код зоны плательщика 
~payment_country_id~ - id страны плательщика 
~payment_country~ - страна плательщика 
~payment_iso_code_2~ - iso код плательщика 
~payment_iso_code_3~ - iso код плательщика 
~payment_address_format~ - формат адреса плательщика 
~payment_method~ - метод оплаты 
~payment_code~ - код оплаты    
~shipping_firstname~ - имя для доставки 
~shipping_lastname~ - фамилия для доставки 
~shipping_company~ - компания для доставки 
~shipping_address_1~ - адрес доставки 
~shipping_address_2~ - адрес2 доставки 
~shipping_postcode~ - индекс для доставки 
~shipping_city~ - город доставки 
~shipping_zone_id~ - id гео зоны доставки 
~shipping_zone~ - гео зона доставки 
~shipping_zone_code~ - код зоны доставки 
~shipping_country_id~ - id страны доставки 
~shipping_country~ - страна доставки 
~shipping_iso_code_2~ - iso код доставки 
~shipping_iso_code_3~ - iso код доставки 
~shipping_address_format~ - формат адреса доставки 
~shipping_method~ - метод доставки 
~shipping_code~ - код метода доставки 
~comment~ - комментарий 
~total~ - итого (из базы данных) 
~order_status_id~ - id статуса заказа 
~order_status~ - статус заказа из базы данных (предыдущий статус)
~language_id~ - id языка 
~language_code~ - код языка 
~language_filename~ - файл языка 
~language_directory~ - дирректория языка 
~currency_id~ - id валюты 
~currency_code~ - код валюты 
~currency_value~ - курс валюты 
~ip~ - ip 
~forwarded_ip~ - переадресованный ip 
~user_agent~ - юзер агент 
~accept_language~ - язык 
~date_modified~ - дата изменения заказа 
~date_added~ - дата создания заказа

Зависимости от доставки.
Вы можете настроить разные варианты одного шаблона в зависимости от метода доставки, данная часть отобразиться только для указанной доставки.
Для этого используйте переменную ~checkShip-{}mod.сod{}ТЕКСТ~
где mod.сod это код доставки (найти код доставки вы можете у заказа в таблице order, поле shipping_code), код состоит из двух частей разделенный точкой, первая часть это основной модуль доставки, а вторая часть это производные от этой доставки, для того чтобы учесть все производные вы можете использовать не жесткую конструкцию например cod.cod, а все подметоды этой доставки cod.*
Внутри конструкции вы можете использовать ТЕКСТ и переменные из списка выше, но обернутые с двух сторон знаком $$
ПРИМЕР:
~checkShip-{}flat.flat{} $$order_id$$ Доставка 2 flat  $$shipping_code$$~
~checkShip-{}cod.*{} $$order_id$$ Доставка 3 cod $$payment_code$$~

 

Использование из сторонних модулей:
Вызвать модель модуля можно из сторонних модулей, это позволит отправить сообщение указав текст и номер телефона (код страны обязателен) .
$this->load->model(extension/module/artgram);
$this->model_extension_module_artgram->startTgMessager('text', 'phone')