Налаштування шаблону push-повідомлення з кодом для підтвердження каналу зв’язку "Дія"

1. Загальний опис

Для налаштування функції відправлення push-сповіщень користувачам у мобільний застосунок "Дія", користувач має спочатку підтвердити, тобто авторизувати канал зв’язку diia. Таким чином, користувач верифікує обмін даними (push-повідомленнями) між двома системами — Кабінетом отримувача послуг та мобільним застосунком "Дія".

Підтвердження каналу зв’язку використовує механізм верифікації даних за допомогою псевдовипадкового 6-значного OTP-коду, що генерується платформою і надходить до "Дії".

Власне відправлення OTP-коду — це вже повідомлення, що містить OTP-код. І відправлення такого повідомлення вимагає попередньо змодельованого шаблону у структурі регламенту реєстру.

2. Моделювання регламенту

Базовий репозиторій розгортання регламенту registry-regulations розширено директорією channel-confirmation, яка містить шаблон push-повідомлення із плейсхолдером[1] для OTP-коду[2], що генеруватиметься системою та надсилатиметься громадянам у мобільний додаток "Дія".

Типовий шаблон для підтвердження каналу зв’язку "Дія" має наступну структуру:
email-notification-structure
Шлях до шаблону виглядає наступним чином: 
registry-regulations/notifications/diia/channel-confirmation
Директорія channel-confirmation містить 2 файли:

  • notification.diia — це текстовий формат шаблону повідомлення з плейсхолдером для OTP-коду.

Приклад 1. Шаблон із кодом підтвердження каналу зв’язку
Код підтвердження: ${verificationCode}

${verificationCode} — плейсхолдер для коду підтвердження/OTP-коду.

  • notification.yml — Конфігураційний файл з метаданими для відправлення повідомлення.

Приклад 2. Шаблон з атрибутами відправлення push-нотифікацій для підтвердження каналу зв’язку
title: "Підтвердження каналу зв'язку реєстру"
attributes:
  actionType: "message"
  templateType: "attention"
  shortText : "Підтвердження каналу зв'язку реєстру"
Обов’язкові атрибути:

  • title — Заголовок повідомлення. Вкажіть будь-який текст за бажанням.

  • actionType — Тип дії.

    Необхідно вказати саме тип actionType: "message", інакше "Дія" не зможе приймати повідомлення.

  • templateType — Тип шаблону.

    Необхідно вказати саме тип templateType: "attention", інакше "Дія" не зможе приймати повідомлення.

  • shortText — Короткий зміст повідомлення. Вкажіть будь-який текст за бажанням.

Згенерований 6-значний псевдовипадковий код (наприклад, 010203) автоматично надсилатиметься користувачеві у мобільний застосунок "Дія" для перевірки та підтвердження контактних даних, за умови активації каналу зв’язку "Дія" у профілі Кабінету отримувача послуг.

Перегляньте сторінку Отримання push-повідомлень з OTP-кодом у застосунку "Дія" для отримання деталей.
Після оновлення наявного реєстру, для правильної роботи функціональності, адміністратор регламенту має в ручному режимі додати до каталогу notifications/diia папку channel-confirmation із відповідними файлами шаблону підтвердження, як показано на прикладах вище.
1. Плейсхолдер (англ. — placeholder) — заповнювач тексту.
2. Одноразовий пароль (англ. — one time password, OTP) — це пароль, який є дійсним тільки для одного сеансу автентифікації. Його дія також може бути обмежена певним проміжком часу. Перевага такого пароля перед статичним полягає у тому, що його неможливо використовувати повторно.