Як отримати ключ для використання mob push повідомлень у eSputnik | Support eSputnik

Email

Омніканальність

Автоматизація

Створення та інтеграція Google проекту для Mob Push

Для роботи з мобільними пушами треба створити акаунт у Google Firebase, де збиратимуться і зберігатимуться дані про підписників. Налаштування потребуватиме не більше 10 хвилин, оскільки механіка підключення є доволі простою. Якщо акаунт уже існує — завантажте його ключ до системи eSputnik.

Крок 1: Зареєструйте проект на FireBase і додайте ключ проекту до eSputnik

Якщо у вас уже є проект, переходьте одразу до пункту 4

1. Увійдіть на сторінку сервісу Google Firebase і натисніть кнопку Get started.

Підключення мобільних пушів

2. Потім натисніть кнопку «Додати проект».

Додати проект до Firebase

3. Заповніть форму створення нового проекту. У діалозі, що з'явиться, надайте проекту назву, вкажіть регіон.

Назва нового проекту

Після цього прийміть угоду про безпеку.

Підтвердження умов використання

4. На екрані з'явиться сповіщення, що новий проект готовий.

Проект готовий

5. Натисніть “Продовжити”, щоб потрапити до створеного акаунта Firebase.

6. Увійдіть до налаштувань проекту.

Після того, як проект буде створено, на панелі ліворуч натисніть коліщатко поруч із пунктом «Project Overview» і перейдіть до пункту меню «Налаштування проекту».

Налаштування проекту

7. Виберіть вкладку “Сервісні акаунти”.

Сервісні акаунти

У вікні, що відкриється, натисніть кнопку «Створення закритого ключа».

Створення ключа

8. Після цього в діалозі натисніть "Створити ключ".

Створити ключ у Firebase

9. Після того, як ключ буде скачаний, завантажте його до eSputnik у "Налаштуваннях" нового проекту для Mob Push.

Завантаження JSON до eSputnik

Готово! Не забудьте надати назву вашому проекту. Пізніше назву буде видно у контактів та у групах. Наприклад, на списку груп кількість контактів із токенами цієї програми буде показано окремою цифрою:

Відображення назви проекту

Крок 2: Інтегруйте Firebase із вашим мобільним додатком

Цей пункт призначений для розробників вашого додатка, яким необхідно зробити додаткові налаштування для запуску мобільних пуш-сповіщень:

Крок 3: Завантажте базу контактів із мобільними токенами за допомогою доступних методів Public API

  • Add/update contacts — Одиночне/масове додавання/оновлення контактів

  • Update contact — Оновлення контакту (одиночно по id)

У структурі channel для вищезазначених методів, підтримується параметр device, для якого доступні такі вкладені поля:

  • appId — ідентифікатор додатка (UUID), який видається під час реєстрації програми в eSputnik. Виводиться користувачеві в налаштуваннях. У тому разі, якщо в акаунті зареєстрований лише один додаток, передавати це поле в запиті не обов'язково.

  • deviceModel — модель пристрою (довільне значення — до 50 символів).

  • os — операційна система девайсу (до 15 символів, наприклад: ios або android).

  • locale — локаль (наприклад en_UK, ru_UA, uk_UA).

  • clientVersion — версія SDK, що використовується в додатку (native or esputnik-1). native — для використання пуш-сповіщень типу Notification, esputnik-1 — для використання пуш-сповіщень типу Data (за замовчуванням).

  • appVersion — версія мобільного додатка.

  • active — прапорець активності токена.

Приклад POST запиту до ресурсу v1/contacts для імпорту контакту з номером телефону і токеном:

{
  "contacts": [
    {
      "channels": [
        {
          "type": "mobilepush",
          "value": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
          "device": {
            "appId": "123e4567-e89b-12d3-a456-426655440000",
            "deviceModel": "iPhone SE 2nd Gen",
            "os": "iOs",
            "locale": "ru_UA",
            "clientVersion": "native",
            "appVersion": "3.14",
            "active": true
          }
        },
        {
          "type": "sms",
          "value": "380501234567"
        }
      ]
    }
  ],
  "dedupeOn": "sms",
  "contactFields": ["mobilepush", "sms"],
  "groupNames": ["mobile push contacts"],
  "restoreDeleted": true
}

Важливо!

Для сповіщень типу Notification доступна можливість передавання зображення, для цього у редакторі повідомлення треба задати посилання в Custom data у форматі JSON: {"es_notification_image":"https://example.com/img.png"}

Зображення для сповіщень типу Notification

Важливо!

Для збирання та обліку активності за кожним повідомленням на боці вашого мобільного додатка треба реалізувати повернення статусу, при доставленні потрібно повернути DELIVERED або OPENED у випадку відкривання. Для цього доступний метод зміни статусу Push-повідомлення: PUT Update interaction status

У тілі запиту, окрім interactionId, передаються також токен FCM і час зміни статусу на девайсі.

Приклад PUT запиту для оновлення статусу сповіщення:

{
    "token": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
    "status": "OPENED",
    "time": "2020-07-09T15:11:17"
}

Коли у сповіщенні є посилання, щоб переходи за ним фіксувалися і були доступні в статистиці персонального кабінету, у вашому додатку розробникам треба підтримати таку можливість. У редакторі повідомлень доступна підстановка посилання до тіла повідомлення, але без відстеження переходів за ним.

Посилання в мобільному пуш-сповіщенні

При додаванні до редактора посилання в тілі пуш-сповіщення буде додатково передано два поля: es_link_raw та es_link:

  • поле es_link_raw — http://example.com/somelink.html — містить початкове посилання, яке можна відкрите браузером пристрою або воно може бути внутрішнім посиланням вашого додатка, яке відкриває його конкретний розділ;

  • поле es_link — https://ххх.esclick.me/37NdHw3pf3DjRcukc0l — створюється на базі вказаного посилання і містить загорнуте посилання, призначене для відстеження та обліку переходів.

Важливо!

На боці вашого мобільного додатка треба реалізувати роботу з полями es_link_raw та es_link. Посилання з es_link_raw може бути використане для перенаправлення користувача до розділу програми або на web ресурс, для обліку кліків достатньо GET запиту за посиланням з es_link.

Також у редакторі підтримується можливість кастомного формату посилань; це може бути посилання на web ресурс, deeplink та velocity вираз, коли дані підставляються з події, що є актуальним для тригерних повідомлень.

Залишилися питання?
Спеціалісти обов'язково нададуть відповідь та допоможуть вирішити вашу проблему!
Зворотний дзвінок
Залишіть заявку – і наш спеціаліст зв'яжеться з вами в робочий час.
Відправити заявку
Консультація в чаті
Готові до ваших запитань!
Написати в чат
Електронна пошта
Напишіть в службу підтримки eSputnik.
Надіслати email