Интеграция с сервисом рассылок: как написать техническое задание

Вещи, которые по началу кажутся сложными, мы лучше понимаем на простых примерах.

Например, вы хотите, чтобы все данные с заявок на сайте автоматически попадали в список рассылки «Заказы с сайта». Давайте посмотрим, как ставить такие задачи программисту без необходимости хоть что-то понимать в программировании.

3 способа связать сайт с сервисом рассылок

Прежде всего, нужно решить, как связать сервис email-рассылок с вашим или CRM-системой.

Вы можете использовать:

1. Готовые интеграции. Например, сервис UniSender интегрируется с популярными CRM-системами ,  CMS-системами и интернет-магазинами.
2. Интеграции с помощью Zapier – специального сервиса, который позволяет связывать разные системы не привлекая программиста. Как связывать сервисы через Zapier.
3. Интеграции по API.

Последний способ используется, когда готовых интеграций нет или нужно сделать что-то, что они не позволяют.

Поэтому советую изучить для начала, что можно сделать с помощью готовых интеграций. И только если нужную вам задачу невозможно решить, обращаемся к API.

Что за зверь такой – API?

По сути, это «язык», с помощью которого две системы (например, сайт и система рассылки) могут понимать друг друга и обмениваться данными.

API-документация — это развернутая инструкция для программиста, как организовать «общение» вашего сайта с системой рассылки, чтобы она совершала нужные действия в нужный момент.

Для того чтобы программист понял, что именно вы от него хотите, ему нужно это максимально детально объяснять.

Я в работе использую такую схему:

Пример работы этой схемы легко понять на известном меме:

А теперь разберём первую схему детальнее.

Что проработать в техническом задании. 5 элементов

1. Источник

Источник – это система, откуда мы берём данные.

Например, какой-либо сайт example.com или ваша CRM-система.

2. Триггер

Триггер – это событие, по которому данные должны передаваться.

Например, могут быть такие триггеры:

• посетитель на сайте заполнил и отправил форму «N»;
• пользователь зарегистрировался на сайте;
• авторизированный пользователь обновил данные о себе в личном кабинете, отписался от рассылки или изменил условия её получения;
• менеджер обновил статус клиента в CRM-системе на «N»;
• пользователь совершил заказ.

То есть, триггеры зависят от возможных действий пользователя на сайте или смены статусов в CRM-системе.

3. Данные

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

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

Например, на сайте есть форма заявки с такими полями:

• Ваше имя.
• Ваш email.
• Телефон.
• Город.

И мы хотим, чтобы данные автоматически попадали в группу «Заявки».

В системе рассылки поля «имя», «email» и «телефон» уже существуют по умолчанию. А вот поле «Город» нам некуда передавать, поэтому для начала его нужно создать в системе рассылки.

В сервисе UniSender это делается так:

Новое поле мы создаем, перейдя в меню «Контакты — Дополнительные поля».

Обратите внимание на выбор типа поля: если вы выберете неправильный тип, то данные не будут передаваться. Тип поля «Строка» позволяет передавать в поле любые текстовые или цифровые значения.

4. Приёмник

В нашем случае это система рассылок UniSender.

Для работы с ней программисту, чтобы передать данные именно в ваш аккаунт, необходим так называемый «API-ключ».

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

Копируем цифры и буквы с вкладки «Интеграция и API» личного кабинета и передаём их программисту.

5. Реакция

Что система рассылки должна сделать, получив данные.

Примеры реакции системы рассылки:

• отправить письмо с названием «N»
• отправить письмо с подтверждением подписки
• добавить контакт в группу с названием «N»
• отправить SMS с текстом «N» контакту
• отписать пользователя от всех рассылок

Рекомендую просмотреть список методов API перед отправкой задачи программисту.В этом документе описано всё, что может сделать система рассылок, получив по API команду от вашего сайта или CRM-системы.

Например, вам нужно отправить письмо с благодарностью за регистрацию на мероприятие. При этом double opt-in (двойное подтверждение подписки) мы не хотим использовать.

Такую задачу можно выполнить двумя способами:

Способ 1. Использовать метод sendEmail, то есть автоматическую отправку одного письма конкретному пользователю, который заполнил форму.

Способ 2. Использовать метод Subscribe, то есть просто добавить пользователя в группу. А саму отправку письма настроить непосредственно в системе рассылки за три шага:

• Создаем письмо, которое будет отправлено в момент попадания email-адреса в список «Заявки».
• Переходим в меню «Рассылки — Письма и черновики — Создать email», заполняем все нужные поля и создаем письмо для нового подписчика.
• На этапе «Отправка» нажимаем кнопку «Запланировать письмо по событию». Выбираем условие «При попадании в список подписчиков».

То есть, в первом случае мы «просим» систему рассылки отправить конкретное письмо, а во втором «просим» добавить контакт в группу. А система рассылки уже сама «знает», что при добавлении контакта в группу нужно отправить пользователю приветственное письмо.

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

Итог

Написать техническое задание программисту для интеграции по API с сервисом рассылки вовсе не сложно. Разложите задачу максимально детально по схеме «Триггер – Данные – Реакция» и не бойтесь консультироваться со службой поддержки.