Документація 1.0.0
Від встановлення до контрольованого запуску
Послідовний довідник для власника магазину, адміністратора та інтегратора. Почніть із вимог, потім встановіть модуль і пройдіть контрольний тест.
01
Рекомендований маршрут
- Перевірте системні вимоги й сумісність.
- Зробіть резервну копію файлів і бази.
- Встановіть модуль і оновіть модифікатори.
- Підключіть провайдера.
- Увімкніть один OTP-сценарій.
- Пройдіть контрольний тест і лише потім додавайте автоматизацію.
02
Коли потрібен спеціаліст
- нестандартна тема або сторінка оформлення замовлення
- власний HTTP API
- складні risk rules
- серверний cron без панелі керування
- міграція з нетипової старої версії
ПОВНА ІНСТРУКЦІЯ
Усі поля, варіанти та перевірки
Нижче наведено повний профільний розділ офіційної інструкції модуля, без скорочень і маркетингового переказу.
1. Що робить модуль
Модуль допомагає магазину автоматично надсилати повідомлення клієнтам і адміністраторам.
Він уміє:
- надсилати SMS;
- підтверджувати телефон клієнта через OTP-код;
- вибірково вимагати OTP під час оформлення замовлення — тільки для замовлень, які відповідають правилам ризику;
- вибирати окремий канал надсилання OTP: SMS, Viber або Telegram;
- підтверджувати телефон дзвінком;
- надсилати повідомлення через Viber, якщо шлюз це підтримує;
- надсилати Telegram-повідомлення;
- повідомляти адміністратора про нові замовлення;
- повідомляти клієнта про зміну статусу замовлення;
- вручну відправляти повідомлення з картки клієнта або замовлення;
- створювати відкладені повідомлення;
- робити масові розсилки;
- вести звіт відправок;
- експортувати та імпортувати зашифровану резервну копію налаштувань і даних модуля;
- обмежувати платні SMS/Viber-відправки за 24 години, щоб не злити бюджет;
- захищати OTP від ботів, перебору номерів і зайвих витрат.
Проста логіка така:
- Магазин отримує подію: клієнт оформив замовлення, змінив телефон, зареєструвався або замовлення змінило статус.
- Модуль перевіряє ваші правила. Якщо ввімкнено
Ризикові замовлення, процес оформлення спочатку проходить перевірку за правилами ризику, і OTP вимагається тільки для першого правила, яке збіглося. - Модуль вибирає канал: для OTP використовується окреме поле
Канал надсилання OTP/Канал OTP без дзвінка, для інших повідомлень - свої поля каналу. - Перед платною відправкою модуль перевіряє бюджетні ліміти SMS/Viber або дзвінків.
- Модуль відправляє повідомлення або створює завдання на майбутнє.
- Результат потрапляє у звіт або в моніторинг безпеки, якщо запит заблоковано до відправки.
2. Який сценарій вам потрібен
Перед налаштуванням оберіть, що саме має працювати в магазині.
| Що потрібно | Які розділи пройти |
|---|---|
| Тільки відправка SMS | 3, 5, 6, 7, 19, 20 |
| OTP при оформленні замовлення | 3, 5, 6, 7, 14, 15, 17, 20 |
| OTP тільки для ризикових замовлень | 3, 5, 6, 7, 14 (підрозділ Ризикові замовлення), 15, 17, 20, 22.8 |
| OTP при вході або реєстрації | 3, 5, 6, 7, 14, 15, 17, 20 |
| Підтвердження дзвінком із резервним SMS | 3, 5, 6, 7, 10, 14, 15, 17, 20 |
| Тільки авторизація дзвінком без SMS | 3, 5, 6, 7, 10, 14, 15, 17, 20, 22.5 |
| Telegram адміну про нові замовлення | 3, 5, 9, 11, 20 |
| SMS/Viber клієнту при зміні статусу | 3, 5, 7, 9, 12, 20 |
| Ручне повідомлення одному клієнту або по замовленню | 3, 5, 7, 9, 18, 20 |
| Відкладені повідомлення | 3, 5, 7, 9, 13, 20 |
| Масова розсилка | 3, 5, 7, 9, 19, 20 |
| Резервна копія або перенесення налаштувань | 3, 5, 21 |
| Захист від OTP-спаму | 14, 15, 16, 20 |
| Захист від зливу бюджету SMS або дзвінків | 7, 10, 15, 16, 20 |
Як вибрати схему каналів
Перед збереженням налаштувань вирішіть, хто за що відповідає. Це прибирає більшість помилок, коли дзвінок налаштований в одному місці, резервне SMS очікується в іншому, а в результаті клієнт бачить порожню модалку і вся конструкція йде в піздєц.
| Потрібна схема | Що вибрати в SMS-шлюз | Що вибрати в Call gateway | Як працює резервне надсилання |
|---|---|---|---|
| Тільки SMS або Viber/SMS | Ваш SMS-провайдер | За замовчуванням (SMS gateway) або не використовувати дзвінки | Резервне надсилання працює тільки всередині SMS/Viber/Telegram правил. |
| SMS + дзвінок через той самий сервіс | ITTell або AlphaSMS | За замовчуванням (SMS gateway) | Якщо увімкнено SMS при помилці дзвінка, OTP після невдалого дзвінка піде через цей SMS-шлюз. |
| SMS через один сервіс, дзвінок через Stream | Ваш SMS-провайдер | Stream Telecom | Дзвінок робить Stream, а резервне SMS після помилки робить основний SMS-шлюз. |
| Тільки дзвінок через Stream без SMS | Без SMS / тільки авторизація дзвінком | Stream Telecom | Резервне SMS недоступне. Якщо дзвінок не підтвердився, клієнт має повторити дзвінок або звернутися до менеджера. |
| OTP через SMS, Viber або Telegram | Ваш SMS-провайдер і потрібні додаткові канали | За потреби окремий шлюз дзвінків | У OTP -> Налаштування OTP виберіть Канал надсилання OTP / Канал OTP без дзвінка. Якщо перший канал не спрацює, модуль пробує інші доступні канали в порядку Telegram -> Viber -> SMS, пропускаючи вже вибраний канал. Перехід у SMS можливий тільки тоді, коли SMS-шлюз доступний і відповідне резервне надсилання ввімкнене. |
| Telegram/Viber + резервне SMS для інших повідомлень | Ваш SMS-провайдер | За потреби окремий шлюз дзвінків | Telegram/Viber можуть переходити на SMS тільки за наявності основного SMS-шлюзу. |
Якщо налаштовуєте модуль вперше, не вмикайте все одразу. Спочатку перевірте базовий канал доставки: SMS або дзвінок. Потім вмикайте OTP або сповіщення, і тільки після цього відкладені події та масові розсилки.
3. Що підготувати перед налаштуванням
Підготуйте ці дані до відкриття модуля.
| Що потрібно | Де взяти | Для чого |
|---|---|---|
| Доступ до адмінки OpenCart/ocStore | У власника або адміністратора сайту | Щоб відкрити налаштування модуля. |
| Обліковий запис SMS-провайдера | TurboSMS, SMS Club, SMS-fly, ITTell, AlphaSMS або інший сервіс | Потрібен для SMS, Viber через SMS-шлюз і резервного SMS. Якщо потрібне тільки підтвердження дзвінком, виберіть Без SMS / тільки авторизація дзвінком і налаштуйте Call gateway. |
| API-токен, API-ключ або SMS-токен | У кабінеті SMS-провайдера | Це пароль для відправки SMS через API. |
| Обліковий запис провайдера дзвінків | ITTell, AlphaSMS, Stream Telecom або інший підтримуваний сервіс дзвінків | Потрібен тільки для підтвердження дзвінком. Він може збігатися з SMS-шлюзом або бути окремим. |
| Електронна пошта Stream Telecom і пароль | У кабінеті Stream Telecom | Потрібні для Stream Telecom Call2FA. |
| Імʼя відправника або альфа-ім'я | У кабінеті SMS-провайдера | Це ім'я відправника, яке бачить клієнт. |
| Баланс у провайдера | У кабінеті SMS-провайдера | Без балансу SMS або дзвінки не відправляться. |
| Номер адміністратора | Ваш робочий номер | Для службових SMS адміну. |
| Дані Telegram-сервера | У сервісі Telegram-інтеграції | Потрібні тільки якщо використовуєте Telegram. |
| Доступ до cron на хостингу | У панелі хостингу або через підтримку хостингу | Потрібен тільки для відкладених повідомлень. |
Важливо: OTP не має сенсу без робочого каналу доставки. Спочатку перевірте, що SMS, Viber, Telegram або дзвінок реально доходить на ваш номер, а потім виберіть потрібний канал у OTP -> Налаштування OTP -> Канал надсилання OTP / Канал OTP без дзвінка.
4. Короткий словник
| Слово в модулі | Просте пояснення |
|---|---|
SMS-шлюз | Сервіс, який відправляє SMS від імені магазину. |
Call gateway | Окремий сервіс для авторизації дзвінком. Якщо поле порожнє, модуль пробує використати вибраний SMS-шлюз, якщо він підтримує дзвінки. |
Без SMS / тільки авторизація дзвінком | Режим, коли SMS-шлюз не налаштовується, а підтвердження телефону працює тільки через дзвінок. Резервне SMS у такому режимі недоступне. |
Stream Telecom | Шлюз лише для дзвінків через Call2FA. Працює для Останні цифри номера і Вибір цифри в меню, але не надсилає SMS. |
API-токен, API-ключ, SMS-токен | Секретний ключ від SMS-сервісу. Не публікуйте його. |
Імʼя відправника, альфа-ім'я | Ім'я відправника в SMS. Наприклад назва магазину. |
OTP | Одноразовий код для підтвердження телефону. |
Ризикове замовлення | Замовлення, яке відповідає хоча б одному активному правилу ризику. У робочому режимі модуль вимагатиме OTP тільки для такого замовлення. |
Тестовий режим ризику | Правила перевіряються і записуються в журнал, але покупець не бачить додаткового OTP через збіг правила. Використовуйте перед увімкненням робочого режиму. |
Пріоритет правила | Порядок перевірки правил ризику. Менше число означає вищий пріоритет. Після першого збігу інші правила не перевіряються. |
Канал надсилання OTP / Канал OTP без дзвінка | Окремий вибір першого каналу для OTP-коду без дзвінка: SMS, Viber або Telegram. Якщо авторизація дзвінком увімкнена, в адмінці поле показується як Канал OTP без дзвінка, бо першим буде дзвінок. |
Резервне надсилання | Запасний варіант доставки. Наприклад, якщо Viber не доставив повідомлення, модуль може спробувати SMS, якщо SMS-шлюз доступний і резервне надсилання ввімкнене. |
Cron | Автоматичний запуск на сервері за розкладом. Потрібен для відкладених подій. |
Маршрут | Технічна адреса сторінки в OpenCart. Для стандартного магазину зазвичай не змінюється. |
GET, POST, JSON | Формат запиту до SMS-провайдера. Для готових шлюзів уже налаштовано. |
Черга | Список відкладених повідомлень, які ще чекають відправки. |
Журнал | Історія виконаних, скасованих або помилкових завдань. |
.sapbackup | Зашифрований файл експорту модуля. Містить тільки налаштування OpenCart і вибрані розділи даних модуля, а не файли модуля чи зовнішні облікові записи провайдерів. |
Попередній перегляд | Перевірка файлу резервної копії перед відновленням. Розшифровує файл, перевіряє схему і показує реальні зміни без запису в базу даних. |
Ліміт | Обмеження, щоб не витрачати баланс на спам або помилки. |
Бюджетний ліміт | Фінальна межа витрат. Якщо її вичерпано, модуль блокує платну відправку до запиту в провайдера. |
Потрібна швидка перевірка?Відкрити діагностику →