Перейти к содержанию

01.1.6 Trackdesk

Версия 1.0.0
Количество листов

Оглавление

История изменений

№ Дата: Автор: RFC: Версия:

1. Trackdesk

Сервис Trackdesk используется для организации реферальной программы сервиса Rippla.

Интеграция с сервисом осуществляется:
Frontend - на основе документации сервиса;
Backend - на основе Trackdesk public API.

1_1 Переменные окружения

Переменная окружения Описание
TRACKDESK_HOST Хост для выполнения запросов к сервису.
TRACKDESK_TOKEN Токен доступа.
TRACKDESK_REVENUE_ORIGIN_ID Идентификатор источника назначенных доходов.

1_2 Логирование запросов
Все запросы к сервису Trackdesk должны логироваться.

Запись лога должна содержать:

  1. Url запроса;
  2. Http-код ответа;
  3. Тело запроса;
  4. Тело ответа.

Срок хранения записей логирования - 1 месяц.

1.1 Очередь “Запросы к сервису Trackdesk”

Очередь состоит из:

  1. Брокера сообщений, который предназначен для хранения информации о Пользователях, информация о которых должна быть передана в сервис Trackdesk.
  2. Обработчика сообщений.

Повторная отправка сообщения очереди
Если сообщение не было обработано “Обработчиком сообщений”, должна выполняться повторная отправка сообщения “Обработчику сообщений” согласно настройкам повторной отправки сообщений.

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

Настройка Значение Описание
Первоначальная отсрочка 600000 Первоначальная отсрочка отправки сообщения в миллисекундах.
Количество попыток 10 Количество повторных попыток отправки сообщения
Множитель отсрочки 2

1.1.1 Параметры сообщения “Конверсия пользователя”

Название Ключ Значение
Email пользователя email
Тип type Возможны следующие типы: lead - фиксирует пользователя как лида; freetrial - фиксирует начало использование сервиса пользователем.
01.1.6_1.1_1 Процедура обработки сообщения “Конверсия пользователя”
  1. Наступает время обработки сообщения, брокер отправляет сообщение обработчику сообщений.
  2. Обработчик получает сообщение “Конверсия пользователя”.
  3. Выполняется логирование события с Payload:
  4. event - "received";
  5. title - “User conversion”;
  6. data.email - Email пользователя, который был получен в сообщении для которого была инициирована данная процедура;
  7. data.type - Тип, который был получен в сообщении для которого была инициирована данная процедура.
  8. Выполняется запрос “Create conversion” к сервису Trackdesk, с телом запроса:
  9. “externalCid” : “Email пользователя” сообщения, для которого выполняется обработка;
  10. “revenueOriginId” : Согласно переменной окружения “TRACKDESK_REVENUE_ORIGIN_ID”;
  11. “conversionTypeCode” : согласно значению параметра “Тип” сообщения, для которого выполняется обработка.
  12. Если запрос “Create conversion” к сервису Trackdesk, не выполнен:
    1. Выполняется логирование события с Payload:
      1. title - “User conversion”;
      2. error - “Trackdesk isn’t available”;
      3. data.email - Email пользователя, который был получен в сообщении для которого была инициирована данная процедура;
      4. data.type - Тип, который был получен в сообщении для которого была инициирована данная процедура.
    2. Брокеру сообщений не возвращается информация о том что сообщение было обработано.
  13. Если запрос “Create conversion” к сервису Trackdesk, выполнен:
    1. И код ответа не 200:
      1. title - “User conversion”;
      2. error - “Request returned an error”;
      3. data.email - Email пользователя, который был получен в сообщении для которого была инициирована данная процедура;
      4. data.type - Тип, который был получен в сообщении для которого была инициирована данная процедура.
      5. Брокеру сообщений не возвращается информация о том что сообщение было обработано.
    2. И код ответа 200 брокеру сообщений возвращается информация о том что сообщение было обработано.