Плагин

Каталог шаблонов для плагина

Мы предоставляем возможность клиентам, приобретающим плагин использовать в своих продуктах шаблоны писем и блоков галереи EmailMaker. Это предложение ограничено во времени и действует для клиентов, заключающих договора на использование плагина до мая 2025 года.

Организовывать хранение и вывод шаблонов в вашей платформе можно разными способами:

  1. Реализация хранения, администрирования и вывода полностью на стороне вашего продукта;
  2. Использование для хранения и администрирования шаблонов вашего аккаунта, в EmailMaker, в котором авторизуется плагин в процессе своей работы. В данном случае каталогизацию для фильтрации и шаблоны вы сможете получать с нашего бэкэнда по API и останется только позаботиться о выводе списка полученных таким образом шаблонов в личном кабинете вашего продукта.

Рассмотрим более подробно второй вариант

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

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

Порядок действий для формирования галереи шаблонов писем в настоящий момент:

  1. Вы копируете письма, которые будут формировать вашу галерею в ваш проект, в который авторизуется плагин;
  2. Отправляете в поддержку EmailMaker список писем, которые необходимо сделать шаблонами, доступными по API;
  3. Также отправляете дерево каталога. Возможно несколько произвольных категорий, к которым можно атрибутировать шаблоны писем.

API получения шаблонов писем и категорий каталогизации

Получение токена

curl --location 'https://api.emailmaker.ru/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=****' \
--data-urlencode 'client_secret=****' \
--data-urlencode 'grant_type=client_credentials'

Запрос возвращает ответ вида:

{
    "access_token": "*******",
    "expires_in": 3600,
    "token_type": "bearer",
    "scope": "project_XXXXXX"
}

OAuth токен, который находится в значении access_token ответа на запрос необходим для выполнения всех остальных запросов.

client_id и client_secret в настоящий момент генерируются и выдаются поддержкой сервиса, в скором будущем будет возможно создание приложения для плагина и получение данных для авторизации внутри личного кабинета EmailMaker.

Получение списка категорий

curl --location 'https://api.emailmaker.ru/wp-json/wp/v2/group?lang=ru' \
--header 'Authorization: Bearer *******'

Запрос возвращает ответ вида:

....

Получение списка шаблонов

curl --location 'https://api.emailmaker.ru/wp-json/wp/v2/email?page=1&per_page=20&_fields=id%2Ctitle%2Cmodified&lang=ru&acf_format=standard' \
--header 'Authorization: Bearer *******'

Запрос возвращает ответ вида:

[
    {
        "id": 810423,
        "modified": "2024-12-16T15:57:07",
        "type": "email",
        "title": {
            "rendered": "Название шаблона 1"
        },
        "group": []
    },
    {
        "id": 810424,
        "modified": "2024-12-16T15:57:07",
        "type": "email",
        "title": {
            "rendered": "Название шаблона 2"
        },
        "group": []
    }
]

Общее количество страниц и шаблонов возвращается в заголовках ответа X-WP-TotalPages и X-WP-Total соответственно.

Получение одного шаблона по ID

curl --location 'https://api.emailmaker.ru/wp-json/wp/v2/email/810423?page=1&per_page=20&_fields=id%2Ctitle%2Cmodified%2Ctype%2Chash%2Cgroup%2Cacf.html&lang=ru&acf_format=standard' \
--header 'Authorization: Bearer *******'

Получение скриншота шаблона

curl --location 'https://scr.emcdn.ru/screenshot?minHeight=620&delay=1000&width=800&fullPage=true&deviceScaleFactor=0.755&format=png&force=false&cacheControl=true&cache-hash=5eeb37fd55ad1258d8733eaa91df4b94&url=https%3A%2F%2Fapp.emailmaker.ru%2Fgetemail%2F810423%3Fsecret_hash%3Dc4a0f18a17cd0095a71d0ffbcbf73b1c%26raw%3Dtrue'

Postman-коллекция всех запросов

EmailMaker_Plugin_Prod.postman_collectionСкачать