Методы API для добавления контактов

Из всех перечисленных методов можно выделить 2 основных - /v1/contact/subscribe и /v1/contacts. Остальные используются по мере необходимости и, как правило, для решения каких-либо специфических задач.

/v1/contact/subscribe

Тип метода: POST

Описание метода

Метод сабскрайб

Метод добавления одиночного контакта. Предназначен для форм подписки. Контакт создается неподтвержденным, что позволяет настроить double opt-in.

Если контакт не существует в нашей системе - будет создан новый контакт
Если контакт существует - он будет обновлен. Дубликаты не создаются.

С помощью данного метода можно добавлять контакты в какую-либо группу. Удалять контакты из группы этим методом нельзя.

Метод /v1/contact/subscribe создает события, поэтому вы можете настроить и запустить автоматический сценарий для контактов, которые передаются этим методом.

  • subscribeFromApi - название события, которое создается для новых контактов.
  • subscribeUpdateFromApi - название события, которое создается если контакт уже есть в системе.

У метода есть параметр formType. Его можно использовать если у вас есть несколько форм подписки или несколько источников сбора контактов. В этом случае вы прописываете значение, которое будет передаваться в систему eSputnik.

Например, вы выбрали свою форму подписки и назвали ее abc. Клиент подписывается на блог через эту форму и система создаст/обновит контакт, создавая такие события:

  • subscribeFromApi-abc - для новых контактов
  • subscribeUpdateFromApi-abc - для существующих

Теперь для всех контактов, которые подписались на блог через форму abc, вы можете создавать отдельные сценарии.

/v1/contacts

Тип метода: POST

Описание метода

Метод Post

Метод для добавления одного или множества контактов. Контакты создаются сразу подтвержденными.
Если контакт не существует в нашей системе - будет создан новый контакт
Если контакт существует - будет обновлен. Дубликаты не создаются.

События метод /v1/contacts не создает, поэтому настроить автоматический сценарий с помощью этого метода не получится. Зато можно добавлять и удалять контакты из какой-либо группы.

В методе можно настраивать свою уникальность идентификации контакта. То есть вы можете не ограничиваться стандартными идентификаторами по email или sms, а использовать свои переменные.

По сути этот метод заменяет импорт контактов из файла.

/v1/contact

Тип метода: POST

Описание метода

Тип метода: Post

Метод добавляет один контакт в систему (передает 1 контакт за 1 запрос). Контакт создается сразу подтвержденным, никакое событие при этом не создается. Поэтому настроить автоматический сценарий с помощью этого метода не получиться.

С помощью метода /v1/contact можно добавлять контакты в какую-либо группу. Удалять контакты из группы метод не позволяет

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

/v1/contact/{id}

Тип метода: PUT

Описание метода


Тип метода Put

Метод используется только для обновления данных о контакте. Обновление контакта возможно только по его ID в системе eSputnik.

/v1/contacts/upload

Тип метода: POST

Описание метода

Тип метода Post

Метод для добавления одного или множества контактов из внешнего файла (csv, excel). То есть должен подготовлен файл, где хранятся данные о контактах и система будет забирать данные оттуда. Контакты создаются сразу подтвержденными.

Если контакт не существует в нашей системе - будет создан новый контакт
Если контакт существует - будет обновлен. Дубликаты не создаются.

Метод /v1/contacts/upload создает события, поэтому вы можете настроить и запустить автоматический сценарий для контактов, которые передаются этим методом. Также можно добавлять и удалять контакты из какой-либо группы.

По сути метод заменяет импорт контактов.
 

Другие методы API, которые могут передавать данные о контакте.

Существует несколько методов API у которых другое предназначение, но при этом они могут передавать/создавать контакты.

Методы для отправки сообщений (email/sms):

  • /v1/message/email
  • /v1/message/sms
  • /v1/message/{id}/send
  • /v1/message/{id}/smartsend

Метод передачи заказов:

  • /v1/orders

Методы для отправки сообщений

При отправке сообщения система проверяет есть ли в базе уже контакт с таким email или номером телефона. Если такого контакта нет - система создаст новый контакт. Новый контакт будет содержать только email или номер телефона. Другие данные переданы не будут. Контакт создается подтвержденным и попадает в общий список контактов, а не в конкретную группу.

События эти методы не создают.

Метод передачи заказов

При передаче данных о заказе система проверяет есть ли в базе уже контакт с таким email или номером телефона. Если такого контакта нет - система создаст новый контакт. В новый контакт из заказа передаются такие данные:

  • email,
  • номер телефона,
  • имя,
  • фамилия.

Других данные не передаются. Контакт создается подтвержденным, но не попадает ни в какую группу.

Событие связанное с контактом не создается. Создается только событие связанное с заказом.
 

Просмотр источника с помощью которого добавлен контакт в систему

Вы всегда можете посмотреть каким методом контакт был добавлен в систему

Источник контакта

Для этого перейдите в Контакты → Все контакты и напротив нужного контакта нажмите на лупу.

Откроется окно, где будет информация по контакту

Просмотр контакта

В графе источник вы увидите необходимую информацию.

Названия источников для различных методов

Основные методы:

  • /v1/contact/subscribe (Форма подписки)
  • /v1/contacts (Импорт контактов)
  • /v1/contact (API)
  • /v1/contact/{id}
  • /v1/contacts/upload (Импорт контактов)

Методы для отправки сообщений (email/sms):

  • /v1/message/email (Одиночное сообщение)
  • /v1/message/sms (Одиночное сообщение)
  • /v1/message/{id}/send (Одиночное сообщение)
  • /v1/message/{id}/smartsend (Одиночное сообщение)

Метод передачи заказов:

  • /v1/orders (Интеграция заказов для RFM)