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 должны логироваться.
Запись лога должна содержать:
- Url запроса;
- Http-код ответа;
- Тело запроса;
- Тело ответа.
Срок хранения записей логирования - 1 месяц.
1.1 Очередь “Запросы к сервису Trackdesk”¶
Очередь состоит из:
- Брокера сообщений, который предназначен для хранения информации о Пользователях, информация о которых должна быть передана в сервис Trackdesk.
- Обработчика сообщений.
Повторная отправка сообщения очереди
Если сообщение не было обработано “Обработчиком сообщений”, должна выполняться повторная отправка сообщения “Обработчику сообщений” согласно настройкам повторной отправки сообщений.
Настройки повторной отправки сообщений
| Настройка | Значение | Описание |
|---|---|---|
| Первоначальная отсрочка | 600000 | Первоначальная отсрочка отправки сообщения в миллисекундах. |
| Количество попыток | 10 | Количество повторных попыток отправки сообщения |
| Множитель отсрочки | 2 |
1.1.1 Параметры сообщения “Конверсия пользователя”
| Название | Ключ | Значение |
|---|---|---|
| Email пользователя | ||
| Тип | type | Возможны следующие типы: lead - фиксирует пользователя как лида; freetrial - фиксирует начало использование сервиса пользователем. |
01.1.6_1.1_1 Процедура обработки сообщения “Конверсия пользователя”¶
- Наступает время обработки сообщения, брокер отправляет сообщение обработчику сообщений.
- Обработчик получает сообщение “Конверсия пользователя”.
- Выполняется логирование события с Payload:
- event - "received";
- title - “User conversion”;
- data.email - Email пользователя, который был получен в сообщении для которого была инициирована данная процедура;
- data.type - Тип, который был получен в сообщении для которого была инициирована данная процедура.
- Выполняется запрос “Create conversion” к сервису Trackdesk, с телом запроса:
- “externalCid” : “Email пользователя” сообщения, для которого выполняется обработка;
- “revenueOriginId” : Согласно переменной окружения “TRACKDESK_REVENUE_ORIGIN_ID”;
- “conversionTypeCode” : согласно значению параметра “Тип” сообщения, для которого выполняется обработка.
- Если запрос “Create conversion” к сервису Trackdesk, не выполнен:
- Выполняется логирование события с Payload:
- title - “User conversion”;
- error - “Trackdesk isn’t available”;
- data.email - Email пользователя, который был получен в сообщении для которого была инициирована данная процедура;
- data.type - Тип, который был получен в сообщении для которого была инициирована данная процедура.
- Брокеру сообщений не возвращается информация о том что сообщение было обработано.
- Выполняется логирование события с Payload:
- Если запрос “Create conversion” к сервису Trackdesk, выполнен:
- И код ответа не 200:
- title - “User conversion”;
- error - “Request returned an error”;
- data.email - Email пользователя, который был получен в сообщении для которого была инициирована данная процедура;
- data.type - Тип, который был получен в сообщении для которого была инициирована данная процедура.
- Брокеру сообщений не возвращается информация о том что сообщение было обработано.
- И код ответа 200 брокеру сообщений возвращается информация о том что сообщение было обработано.
- И код ответа не 200: