Получить ТЗ для интеграции по API

1. Что такое ТЗ и зачем оно разработчикам

Техническое задание или ТЗ — это описание запросов для создания или обновления клиентов и их событий в сценарии. Оно помогает разработчикам правильно передавать информацию в VK CXhub.

ТЗ нужно, чтобы автоматизировать передачу или обновление информации о клиентах в VK CXhub. Например:

Пользователь нажал на кнопку «Подписаться на рассылку» на вашем сайте.
Вы передали информацию о нем в VK CXhub.
Если клиента не было в системе, он появится в базе со свойством «Подписан на рассылку».
Если клиент уже был в системе, у него обновится статус подписки.

После этого пользователя можно работать с этим клиентом в ваших сценариях VK CXhub.

2. Как создать ТЗ

1. Откройте VK CXhub и перейдите в раздел «Интеграции» → «Каталог интеграций» → «Другая система».

2. Нажмите «Новая система» и введите название системы.

3. VK CXhub создаст токен для авторизации системы. Этот токен будет использоваться в ТЗ для разработчиков.

4. Нажмите на добавленную систему и выберите нужный метод.

5. Задайте параметры запроса. О том, как заполнять этот блок, рассказываем ниже.

6. Скопируйте ТЗ и передайте его разработчикам.

3. Как заполнить параметры запроса

Для создания или обновления клиентов:

Выберите уникальный идентификатор клиента — параметр, который будет заполнен у всех пользователей. Это может быть номер телефона или электронная почта. По уникальному идентификатору VK CXhub будет находить клиента в системе и обновлять/создавать информацию по нему.
Выберите набор свойств, которые будут передаваться в запросе. Например, если при регистрации вы передаете почту, имя и фамилию, — укажите эти три переменные.
Выберите действие с рассылками: пользователь подписывается, отписывается или ничего не делает. Этот параметр вынесен в отдельный блок, поскольку этого требует API VK СXhub.
Выберите переменные, значения которых нужно удалить. API VK СXhub не может записать пустое значение переменной. Например, если передать параметр Name: null или «» — имя клиента не удалится. Чтобы удалить значение переменной, передайте ее в отдельном блоке.

Для создания или обновления событий:

Выберите уникальный идентификатор клиента — параметр, который будет заполнен у всех пользователей. Это может быть номер телефона или электронная почта. По уникальному идентификатору VK CXhub будет находить клиента в системе и обновлять или создавать информацию по нему.
Выберите тип события, по которому нужно передавать данные. Например, если вы передаете информацию по открытию ссылки, укажите это событие.
Выберите переменные события для записи. Можно выбрать несколько переменных.

Для обновления и наполнения элементов справочника:

Выберите справочник, который нужно обновить или наполнить.
Выберите действие с элементом справочника: «Обновить или создать» или «Удалить».
Если выбрали «Обновить или создать» элемент, можете выбрать дополнительные переменные, которые нужно передать.

Если у вас возникнут какие-либо вопросы или трудности, обращайтесь к нам в чат. Всегда рады помочь!