Loyalty

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

contact/create

Метод contact/create предназначен для регистрации контакта в программе лояльности.

При отправке в запросе параметров [Фамилия, Имя, Отчество] происходит нормализация данных

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

{
  "contact": {
    "firstName": "163   Иван !—  –",           //Имя
    "surname": "     21348972Иванов*()@ ",      //Фамилия
    "middleName": "  Иванович      123 ! —",     //Отчество
}

Пример записи в Creatio

Допустимые символы: A-z, А-я, ёЁ, «тире» в центре и на конце.
1. Из указанного значения будут удалены пробелы в начале и в конце строки
2. Все двойные (и более) пробелы будут заменены на одинарные
3. Максимальное количество символов в одном параметре 100

Параметр Email при регистации приводится к единому регистру

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

{
  "contact": {
    "firstName": "Иван",
    "surname": "Иванов",
     "email": "IvAnOvIvAn@samarasoft.com"
}

Пример записи в Creatio

*При проверке в запросах контакт сервиса значение Email всегда будет приводиться к единому регистру

После выполнения метода, контакт будет добавлен в сегменты согласно фильтрам под которые попадет данная запись.

Принимаемые справочные значения

  • Параметр «gender»(Пол) принимает значения:

«Male»
«Female»

Массив subscriptions:

  • Парметр «channel» принимает значения:

«Email»
«Sms»
«Push»
«Viber»
«Telegram»

  • Параметр «status» принимает значения:

«Subscribed»
«NeedConfirmation»
«Unsubscribed»

  • Параметр «type» принимает значения:

«Info»
«News»
«Promo»
«Trigger»
«Service»

  • Параметр «category» принимает значения из объекта «SmrSubscriptionCategory», если указанное значение не найдено, будет создано новое
  • Параметр «source» принимает значения из объекта «SmrSubscriptionSource», если указанное значение не найдено, будет создано новое

Запрос

URL: https://<адрес сервиса личного кабинета>/contact/create
Метод: POST

Заголовки

Content-Type: application/json
Authorization: Bearer <token>

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

{
	"contact": {
                "id": "134",,
		"brandCode": "default",
		"firstName": "Виктория",
		"surname": "Наринская",
		"middleName": "Алексеевна",
		"email": "narinskaya.viktoria@yandex.ru",
		"phone": "+79037628311",
		"birthday": "1992-04-27T11:32:51Z",
		"gender": "Female",
		"country": "Россия",
		"city": "Самара",
		"address": "Мичурина 150",
		"subscriptions": [
                   {
                      "channel": "Email",
                      "status": "Subscribed",
                      "type": "Info"
                   }
                ],
                "customFields": {
		    "Zip": "443086",
                    "AchievementLevel": "Gold"
		}
	},
	"shopCode": "121",
	"Card": "100654813",
	"date": "2019-06-01T11:32:51Z"
}

Ответ

Пример ответа

{
  "data": {
    "id": "134",
    "loyaltyId": "b54a79de-4f38-447f-ac6a-94ef8e756275"
  },
  "success": true
}

loyaltyId — Id контакта во внешних системах
*Для заполнения справочного значения на стороне creatio, в атрибуте customFields необходимо указать значение колонки «Code» записи, которую необходимо присвоить.

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