Любой пользователь, который создает одинаковые электронные письма, отправляет их каждый день. Структура письма часто подобна в каждой рассылке. Меняется только контент/наполнение письма (промокоды, баннеры, карточки товаров и т.д.).

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

Для начала мы начнем с подготовки шаблона и, затем, сгенерируем письмо на его основе. У нас есть верхний и нижний колонтитулы: хедер и футер, которые не меняются, они статичны. Затем необходимо определить динамическую часть шаблона, куда будут записываться данные: контент/наполнение в письме. И на выходе мы получаем уже готовое письмо. Все быстро и просто!

Полная документация Stripo API находится здесь.

Однако, все по порядку.

Сначала, чтобы начать генерировать письмо с помощью Stripo API, делим нашу подготовку на этапы.

Этап 1: Сохраняем наши элементы: баннеры и карточки товаров в модули.

Я сохранил этот простой баннер как модуль:

И задал модулю уникальный ID: structure_banner_top

Для структуры с 3 контейнерами с карточками товаров: создаем пустую структуру с 3 контейнерами и сохраняем как модуль. Карточки товаров будут определены и заполнены в эти контейнеры автоматически во время генерации письма.

И задал модулю уникальный ID: empty_structure_3_containers

Теперь подготовим наши карточки товаров.

Карточки товаров должны иметь Smart-свойства, чтобы данные автоматически проставлялись в них.

Как настроить Smart свойства?

Статья https://support.stripo.email/ru/articles/5462454-what-are-the-smart-element-and-how-to-use-them поможет вам в этом.

По сути, нужно установить уникальные переменные для элементов карточки товара:

Затем установить соответствующие уникальные классы для этих элементов в коде:

Сохраняем только один смарт-контейнер как модуль и устанавливаем его ID: product_card

Сохраните другие нужные структуры и модули и установите их ID.

Первый этап ГОТОВ!


Этап 2: Создаем автогенерируемую область в нужном шаблоне для создания электронного письма.

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

Самый простой пункт — последний. По сути, этот шаблон может иметь некоторые статические элементы, такие как верхний и нижний колонтитулы и т. д. Так же он должен иметь, по крайней мере, одну полосу со специальным классом, необходимым для определения места, куда именно будет вставляться контент при вызове метода Generate Email.

Для этого добавьте пустую полосу с одним столбцом и добавьте класс esd-email-gen-area="name_of_area" к тегу td полосы в редакторе кода, где name_of_area — заданное имя.

Пример полосы с областью автогенерации электронной почты, которая называется product-area.

<td class="esd-stripe" align="center" esd-email-gen-area="products-area">

Готово!


Этап 3: Токен JWT для аутентификации всех вызовов REST API

  • Получите токен JWT для аутентификации всех вызовов REST API.

Чтобы сгенерировать токен JWT, перейдите в настройки проекта > прокрутите вниз до раздела «Доступ к REST API» и скопируйте его.

  • REST API информация

Stripo API — это стандартный REST API, который поддерживает базовые операции CRUD и может использоваться сторонними приложениями для автоматизации создания шаблонов писем и планирования их дальнейшего экспорта и рассылки.

Каждый запрос POST ДОЛЖЕН ИМЕТЬ заголовок Content-Type. В настоящее время мы принимаем только контент типа 'application/json'.

Запрос данных передается в API путем отправки объектов JSON в конечные точки API с соответствующими параметрами. Документация для каждого вызова API будет содержать более подробную информацию о параметрах, принимаемых вызовом.

  • API Endpoint

Все URL-адреса API, перечисленные в этой документации, относятся к: https://stripo.email/emailgeneration/v1/

Например, вызов /email доступен по адресу: https://stripo.email/emailgeneration/v1/email

  • Скачиваем Postman

  • Аутентификация

Как только вы получите токен JWT, вам придется использовать его при каждом вызове API. Значение токена всегда должно быть указано в заголовке каждого запроса, как показано в примере ниже:

Stripo-Api-Auth: YOUR_JWT_TOKEN

Давайте проверим, что токен действителен:

Для этого нажмите "+" в левом верхнем углу скриншота и создайте новую коллекцию.

Затем установите метод GET и добавьте /validate к URL-адресу API.

( https://stripo.email/emailgeneration/v1/validate )

Пожалуйста заполните поля Key и Value:

Key

Value

Stripo-Api-Auth:
YOUR_JWT_TOKEN
Content-Type
application/json

Теперь вы можете отправить вызов GET, нажав синюю кнопку «ОТПРАВИТЬ», и если у вас есть ответ «действителен»: true в теле, ваш токен действителен. Статус 200 оk.

Для получения дополнительной информации о кодах состояния, пожалуйста, следуйте здесь.

Этап 4: Начинаем генерировать письма с помощью Postman

В соответствии с этапом 3 создайте еще одну Новую коллекцию, нажав на значок "+".

Затем установите метод POST и добавьте /email к URL-адресу API.

( https://stripo.email/emailgeneration/v1/email )

Пожалуйста, установите те же два ключа на вкладке Заголовки:

Key

Value

Stripo-Api-Auth:
YOUR_JWT_TOKEN
Content-Type
application/json

Затем переключитесь на вкладку Body, выберите необработанный тип, и вы готовы создать свой канонический JSON.

Описание структуры необходимых параметров для JSON:

Прокрутите, пожалуйста, вниз до Приложения для описания каждого из следующих полей.

// FORMATTING AND FILLING IN THE DATA SOURCE
{
"dataSources": [
{
"name": "Test source for Demo", // DIFFERENT NAME
"type": "RAW",
"value": {
}
}
],
"transformers": [],
"composers": [],
"templateId": "555555", // THE ID OF YOUR TEMPLATE WITH esd-email-gen-area="products-area"
"emailName": "Test # 1" // THE NAME OF YOUR FURTHER GENERATED EMAIL
}

Для получения более подробной информации, пожалуйста, следуйте сюда.

Посмотрите наш образец JSON:

// INSERTED DATA
{
"dataSources":[
{
"name":"Test source for Demo",
"type":"RAW",
"value":[
{
"id":"structure_top_banner"
},
{
"id":"structure_title_dynamic",
"values":{
"p_name":"BEST DEALS!"
}
},
{
"id":"empty_structure_3_containers",
"content":[
{
"id":"container_product",
"values":{
"url":"https://viewstripo.email",
"p_name":"Leather Jacket",
"p_image":"https://hpy.stripocdn.email/content/guids/CABINET_9239c093ecdd07579968a78fedaa6e32/images/98571572875380318.png",
"p_price":"$199",
"p_old_price":"$399"
}
},
{
"id":"container_product",
"values":{
"url":"https://viewstripo.email",
"p_name":"Red shirt",
"p_image":"https://hpy.stripocdn.email/content/guids/CABINET_5317ac85fc16b8abe6584e030563da53/images/74801572874593362.png",
"p_price":"$99",
"p_old_price":"$149"
}
},
{
"id":"container_product",
"values":{
"url":"https://viewstripo.email",
"p_name":"Checkered shirt",
"p_image":"https://hpy.stripocdn.email/content/guids/CABINET_5317ac85fc16b8abe6584e030563da53/images/1191572880345345.png",
"p_price":"$99",
"p_old_price":"$149"
}
}
]
},
{
"id":"structure_discover_button"
}
]
}
],
"transformers":[
],
"composers":[
],
"templateId":"591945",
"emailName":"Test # 1",
"title":"Your title",
"preheader":"Your preheader"
}


Структура запроса:

// QUERY STRUCTURE
{
dataSources: DataSourceDto[],
transformers: TransformerDto[],
composers: ComposerDto[],
templateId: Long,
emailId: Long,
emailName: String,
title: String,
preheader: String
}

Приложение. Описание каждого поля:

Пожалуйста, обрати внимание!

  • Определение полей: M (mandatory) — обязательное, O (optional) — необязательное;

  • You should not send optional field in the request if you want to keep them empty.

dataSource (M)

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

DataSourceDto описание

{ name: String, //M type: String, //M value: Object //M }

где:

name — любое название источника данных

type — в настоящее время мы поддерживаем 2 типа:

  • RAW — в этом случае данные следует размещать непосредственно в поле значения;

  • LINK — данные будут загружены с указанного URL в поле значения;

value — данные источника или URL.

Подробнее о форматах источников данных с примерами см. Appendix C.


transformers (O)

Список трансформеров (преобразователей), которые можно применить к исходным данным для генерации письма.

TransformerDto описание

{ type: String, //M source: String, //O outputSource: String, //O config: JSON //M }

где:

type — типы трансформаторов. Подробнее о поддерживаемых типах трансформаторов см. в Appendix A;

source — необязательное поле, имя источника, к которому должен быть применен этот преобразователь. Если он не указан, будет использован первый;

outputSource — необязательное поле, имя целевого источника, куда будут записаны преобразованные данные после их модификации этим преобразователем. Если не указано, то результаты будут записываться в первоисточник;

config — конфигурация трансформатора. Каждый трансформатор имеет свой формат конфигурации. Подробнее о поддерживаемых трансформаторах см. в Appendix A.


composers (O)

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

ComposerDto описание

{ type: String, //O source: String, //O templateArea: String //O }

где:

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

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

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

source — необязательное поле, имя источника, из которого данные должны быть взяты и применены к области шаблона, определенной ниже. Если не указано, то данные будут браться из первого источника;

templateArea — необязательное поле. Это идентификатор зоны в шаблоне, куда вставлять записи. Если не указано, то используется первая найденная зона.


templateId (M)

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

Чтобы просмотреть все свои шаблоны, перейдите в меню «Шаблоны» в учетной записи Stripo.


emailId (O)

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


emailName (O)

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

Если поле пусто, то имя шаблона будет использоваться в качестве имени сгенерированного письма.


Для получения более подробной информации, пожалуйста, перейдите по данной ссылке.


Если у вас есть какие-либо вопросы, пожалуйста, напишите нам по адресу: support@stripo.email

Вы нашли ответ?