Loyalty

  1. Домой
  2. Документация
  3. Loyalty
  4. API работы с контактами
  5. contact/track

contact/track

Метод contact/track предназначен для логирования действий, совершенных клиентом на вашем сайте/мобильном приложении.

Ознакомиться с примером запроса можно по ссылке: https://personalarea.docs.apiary.io/#reference/contact/contacttrack/0

Для настройки получения событий с сайта предварительно необходимо выполнить настройки на стороне Creatio.

  • В дизайнере системы на вкладке «Импорт и интеграции» перейти в настройку трекинга событий сайта
  • Добавить новое событие
  • Заполнить соответствующие поля
  • В дальнейшем значение поля «Код» необходимо будет использоваться в параметре «eventCode»

Примечание.

Если событие с указанным кодом отсутствует, оно будет создано в системе Creatio

Пример запроса

{
  "contact": {
    "loyaltyId": "7673a059-dfaa-4144-ad7d-cc26eb1162c1",
    "id": "001",
    "brandCode": "samarasoft",
    "firstName": "Иван",
    "surname": "Иванов",
    "middleName": "Иванович",
    "email": "IvanovIvan1996@gmail.com",
    "phone": "89990001122",
    "birthday": "1996-10-11T14:22:59.9Z",
    "gender": "Male",
    "country": "Россия",
    "city": "Самара",
    "address": "ул. Льва Толстого 34, д.56",
    "customFields": { "Dear": "Иван"  }
     },
    "subscriptions": [
        {
        "channel": "Viber",
        "status": "Subscribed",
        "type": "Service",
        "category": "Системная рассылка",
        "source": "Основной сайт",
        },
    ],
  "eventCode": "RegisterInGame",
  "dateTime": "2020-01-24T14:22:59.9Z",
  "requestId": "202001",
  "shopCode": "063",
  "data": {  "Rating" : "5" }
}

Описание параметров

ПараметрТипОписание
contactobjectДанные клиента для авторизации
В зависимости от способа идентификации клиента может содержать внешний идентификатор либо идентификатор программы лояльности, либо номер телефона
loyaltyIdstringИдентификатор программы лояльности
Значение должно быть в формате «guid»
id string Внешний идентификатор
brandCode string Код бренда в котором зарегистрирован клиент
Длина строки должна быть меньше или равна 50
firstName string Имя
Длина строки должна быть меньше или равна 100
surname string Фамилия
Длина строки должна быть меньше или равна 100
middleName string Отчество
Длина строки должна быть меньше или равна 100
email string Email
Значение должно быть в формате «email»
phone string Мобильный телефон контакта
Значение должно быть в формате «телефон»
birthday string Дата рождения
Значение должно иметь формат «дата-время»
gender string Дата рождения
Значение должно иметь формат «дата-время»
country string Страна
Длина строки должна быть меньше или равна 50
city string Город
Длина строки должна быть меньше или равна 50
address string Адрес
Длина строки должна быть меньше или равна 200
subscriptions array Подписки
channel string Канал подписки
Может принимать значения: «Email»(0), «Sms»(1), «Viber»(2), «Telegram»(3)
Если параметр не указан, ему будет присвоено значение «Email»
Используется для идентификации подписки при изменении
status string Статус подписки
Может принимать значения: «Subscribed», «NeedConfirmation», «Unsubscribed»
Если параметр не указан, ему будет присвоено значение «Subscribed»
type string Тип подписки
Может принимать значения: «Info», «News», «Promo», «Trigger», «Service»
Если параметр не указан, ему будет присвоено значение «Info»
Используется для идентификации подписки при изменении
source string Источник подписки
Длина строки должна быть меньше или равна 150
Используется для идентификации подписки при изменении
category string Категория подписки
Длина строки должна быть меньше или равна 250
Используется для идентификации подписки при изменении
CustomFieldsobjectДополнительные параметры, которые необходимо передать в покупке
eventCodestringКод события
Длина строки должна быть меньше или равна 50
dateTimestringДата и время события
Значение должно иметь формат «дата-время»
requestidstringИдентификатор запроса. Генерируется на стороне системы, вызывающей сервис (ключ идемпотентности)
Длина строки должна быть меньше или равна 50
shopCodestringКод точки продаж (сайта), где сгенерировано событие
Длина строки должна быть меньше или равна 50
dataobjectДополнительные данные события

Если клиент существует в системе

Запись о событии будет добавлена контакту на деталь [События сайта]

Если клиент отсутствует в системе

После выполнения метода будет создан контакт с указанными данными, и привязано событие на деталь [События сайта]

Материал был полезен? Да Нет