stripo-plugin-integration-comprehensive-guide-and-faq
5 дней назад

Интеграция плагина Stripo: подробный гайд и FAQ

Oleksii Burlakov
Oleksii Burlakov Content writer в Stripo
Оглавление
  1. Технические требования и совместимость
  2. Обзор процесса интеграции
  3. Кастомизация и гибкость на стороне клиента
  4. Основные проблемы при интеграции плагина
  5. Тестирование и контроль качества
  6. Постоянная техническая поддержка в течение всего процесса интеграции
  7. Контроль обновлений и устранение багов
  8. В завершение
1.
Технические требования и совместимость

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

  • drag-n-drop редактор: создавайте адаптивные письма, перетаскивая готовые блоки и сохраненные модули;
  • гибкость хранилища шаблонов: шаблоны писем могут храниться как на вашей стороне, так и на защищенной стороне Stripo, в зависимости от настроек интеграции;
  • одновременное редактирование в режиме реального времени: работайте синхронно с членами команды;
  • кастомные расширения: создавайте и интегрируйте собственные блоки писем и кастомные компоненты (доступно в тарифном плане Prime);
  • простая интеграция: плагин разработан как простой JavaScript-компонент для быстрой настройки.

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

Технические требования и совместимость

Старый плагин Stripo выполнен в виде простого JavaScript-компонента, в то время как новый плагин разработан на базе Angular. Он предназначен для встраивания в любое современное веб-приложение, независимо от используемого фреймворка (React, Vue, Angular или другие). Он упрощает процесс создания писем, обеспечивая интеграцию надежного редактора писем непосредственно в вашу платформу. Вот как это работает с технической точки зрения:

  • обработка HTML и CSS: интегрированный плагин Stripo получает и обрабатывает HTML- и CSS-код, позволяя вашим пользователям редактировать шаблоны писем напрямую через простой интерфейс. После редактирования он сразу возвращает чистый обновленный код, готовый к использованию.

Плагин Stripo легко интегрируется с такими популярными фреймворками, как Angular, React и т. п. Независимо от того, использует ли ваше приложение Angular, React или другой фреймворк на основе JavaScript, совместимость не является проблемой, так как Stripo разработан для гибкой интеграции практически в любую современную веб-платформу.

Более подробные пошаговые инструкции находятся в нашей документации по плагину.

Страница документации по плагину Stripo

Обзор процесса интеграции

Интеграция плагина Stripo в вашу систему осуществляется просто и быстро. Вот как обычно происходит первоначальная настройка:

Краткий мануал по запуску плагина

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

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

  • старый плагин: раньше редактор функционировал без структурированной внутренней модели. Он работал напрямую с необработанными HTML и CSS, воспринимая их просто как текст. Такой подход, хотя и был функциональным, имел свои ограничения: различные браузеры могли по-разному отображать один и тот же код, а расширения для браузеров могли непреднамеренно изменять контент во время редактирования. Эти проблемы иногда влияли на надежность и визуальную целостность шаблонов писем;
  • новый плагин: новый плагин представляет основанную на данных модель, которая создается для каждого шаблона письма при первой инициализации. Вместо того чтобы работать с необработанным кодом в виде обычного текста, Stripo теперь генерирует и управляет структурированной моделью под капотом. Это обеспечивает целостное отображение в браузерах, защищает код шаблона от нежелательного вмешательства (например со стороны расширений браузера) и открывает такие дополнительные возможности, как одновременное редактирование в режиме реального времени и комментирование в редакторе.

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

  1. Десктопный и мобильный вид: без проблем просматривайте и редактируйте письма, оптимизированные для десктопов и мобильных устройств, прямо в редакторе.
  2. Одновременное редактирование в режиме реального времени: работайте совместно в реальном времени, обеспечивая одновременный доступ нескольких пользователей к шаблонам писем.
  3. Упрощенное управление базой данных: поскольку Stripo управляет хранением HTML и CSS, нагрузка на внутреннюю базу данных значительно снижается, что позволяет вашей команде сосредоточиться на более приоритетных задачах.

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

Миграция со старого на новый плагин

Сменить старый плагин Stripo на новый проще, чем вы думаете. Мы оптимизировали процесс, чтобы обеспечить максимально комфортный переход.

Миграция редактора Stripo v2

Этапы перехода

Миграция со старого плагина на новый требует нескольких технических обновлений с вашей стороны. Речь идет не только о смене UI, логика интеграции также меняется. Вот что необходимо настроить:

  1. Встраивание плагина: в новой версии редактор встраивается с помощью одного контейнера <div>, а не двух отдельных контейнеров, как требовалось ранее. Это упрощает процесс встраивания.
  2. Вызов инициализации: способ инициализации плагина изменился. Структура вызова функции изменилась, и теперь она содержит новые параметры, необходимые для правильного поведения плагина.
  3. Логика аутентификации: параметр userId теперь является обязательным при инициализации плагина. Если ваша старая интеграция не предусматривала идентификацию на уровне пользователя, то необходимо соответствующим образом обновить процесс аутентификации.
  4. Экспорт и сохранение HTML: функции, используемые для получения и сохранения HTML (скомпилированного или необработанного), изменились. Новый плагин использует обновленные методы API, и вам также необходимо изменить конфигурацию запуска и выполнения автосохранения.
  5. Кастомные расширения (если применимо): если вы создали кастомные блоки или расширения для старого плагина, необходимо адаптировать или переписать их, используя обновленную документацию и структуру, разработанную для нового плагина.
  6. Метод переключения инициализации: обновите процесс инициализации вашей системы, чтобы при дальнейшем редактировании отправлять только ID письма. С этого момента Stripo будет автоматически обрабатывать получение HTML и CSS.

Этапы миграции редактора Stripo v2

Кастомизация и гибкость на стороне клиента

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

Степень доступности кастомизации

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

Редизайн продукта

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

Добавление и удаление кастомных блоков

Доступность и гибкость добавления и удаления кастомных блоков во многом зависят от тарифного плана:

  • тарифный план Free / Basic: пользователи могут удалять или отключать стандартные блоки, но добавление кастомных блоков недоступно;
  • тарифный план Prime: клиенты могут создавать и интегрировать собственные расширения, добавляя новые возможности в редактор для удовлетворения уникальных потребностей.

Разработка кастомных расширений

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

Основные проблемы при интеграции плагина

Давайте рассмотрим некоторые распространенные проблемы, которые следует учитывать, чтобы обеспечить плавный переход.

Опыт и ресурсы разработчиков

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

Совместимость с кастомными расширениями

Многие клиенты полагаются на кастомные расширения — специфические блоки, разработанные с учетом конкретных потребностей. Пока полная совместимость с кастомными блоками находится в активной разработке для нового плагина Stripo, пользователи Prime уже могут начать подготовку к интеграции, обновив свои кастомные блоки. Команда Stripo активно работает над обеспечением полной поддержки кастомных расширений в ближайшее время, что приведет к плавному и успешному переходу.

Предстоящие решения и сроки

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

Обязанности клиента

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

Тестирование и контроль качества

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

Настройка специального тестового окружения

Лучший способ обеспечить плавный переход — создать специальное тестовое окружение. Вот наши рекомендации:

  • отдельные окружения: используйте специальные тестовые плагины и отдельные от рабочего окружения. Это позволит вашей команде безопасно тестировать интеграции, выявлять потенциальные ошибки и устранять их до релиза на лайве;
  • реалистичные сценарии: тестируйте реалистичные сценарии и шаблоны писем, которые очень похожи на используемые в реальной жизни. Такая практика помогает выявить нестандартные ситуации, которые в противном случае могут остаться незамеченными;
  • непрерывный цикл обратной связи: поддерживайте постоянную обратную связь с тестировщиками или ранними пользователями, чтобы быстро решать любые проблемы и улучшать работоспособность.

Поддержка Stripo в тестировании

Мы в Stripo понимаем, насколько важно тестирование, поэтому активно содействуем вашей работе по обеспечению качества:

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

Постоянная техническая поддержка в течение всего процесса интеграции

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

Каналы технической поддержки Stripo

Мы предоставляем несколько удобных каналов поддержки, чтобы вы всегда могли получить необходимую помощь:

  • профильные встречи: клиентам Prime доступны индивидуальные технические встречи с нашими разработчиками. Такие запланированные собрания гарантируют, что сложные вопросы будут немедленно рассмотрены специалистами. Кроме того, мы часто создаем общие каналы Slack между вашей и нашей командой, что позволяет общаться в режиме реального времени и обеспечивать сверхбыструю поддержку. Такая прямая линия значительно ускоряет решение технических вопросов и задач по интеграции;
  • поддержка через чат: мгновенная поддержка в чате доступна с понедельника по пятницу, с 8 до 24 часов. Быстрые вопросы и проблемы, как правило, решаются в чате в течение нескольких минут;
  • поддержка по электронной почте: если ваш запрос не срочный или не требует детального изучения, всегда можно связаться с нашей службой поддержки по электронной почте. Мы отвечаем быстро и детально, как правило, в течение того же рабочего дня.

Когда необходима прямая помощь разработчиков

В некоторых сценариях может потребоваться непосредственное участие разработчиков Stripo, например:

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

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

Непрерывная поддержка на протяжении всего цикла эксплуатации

Наша техническая поддержка не прекращается после первоначальной интеграции. Stripo остается вашим партнером на протяжении всего жизненного цикла использования плагина. От первоначальной настройки и устранения неполадок до постоянных обновлений и улучшений — наша команда всегда готова оказать поддержку и дать рекомендации. Мы активно поможем разобраться с изменениями, обновлениями и любыми возникающими техническими вопросами, чтобы вы всегда получали максимальную пользу от нашего плагина.

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

Контроль обновлений и устранение багов

Когда речь заходит о работе с обновлениями и исправлениями багов в плагине Stripo, у вас есть два основных варианта: автоматические обновления или ручной контроль версий. Каждый из них имеет свои преимущества в зависимости от предпочтений вашей команды и операционных требований.

Автоматическое и ручное обновление

Автоматические обновления («свежая» версия)

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

Ручное управление версиями

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

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

Плюсы:

  • немедленный доступ к новым функциям и быстрое исправление критических багов;
  • снижение нагрузки на разработчиков при техобслуживании;
  • всегда самая оптимизированная и безопасная версия.

Минусы:

  • небольшой риск возникновения непредвиденных проблем, если ваше окружение имеет специфическую кастомизацию или уникальные зависимости;
  • требует доверия к процессу непрерывного функционирования Stripo.

Мгновенное применение исправленных ошибок и обновлений

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

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

Скорость загрузки редактора и информация о хостинге

Еще один распространенный вопрос, особенно от клиентов, проживающих за пределами Европы: можно ли ускорить время загрузки редактора? По умолчанию ресурсы плагина Stripo размещаются на серверах AWS в Ирландии. Для пользователей, получающих доступ к редактору из отдаленных регионов (например, Азии или Южной Америки), время начальной загрузки может варьироваться в зависимости от скорости интернета и времени ожидания сети. Иногда это занимает от 4 до 8 секунд.

Если быстрая загрузка является критическим требованием, можете повысить производительность, самостоятельно захостив ресурсы фронтенда редактора. Мы предоставляем открытый доступ к файлам плагина на GitHub, что позволяет:

Такой подход позволяет полностью контролировать предоставление ресурсов и значительно сократить время загрузки для конечных пользователей в удаленных регионах.

В завершение

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

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

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

  • подготовка и планирование: начните с четко составленных планов интеграции и миграции;
  • тестирование: используйте специальные окружения, чтобы выявлять и устранять проблемы на ранней стадии;
  • кастомизация: используйте гибкие возможности кастомизации, помня о том, что для создания кастомных блоков требуются внутренние ресурсы разработчиков;
  • обновления: выберите стратегию обновления (автоматически или вручную), которая наилучшим образом соответствует вашим операционным потребностям;
  • поддержка: положитесь на надежные каналы технической поддержки Stripo в течение всего периода эксплуатации плагина.
Интегрируйте плагин Stripo без лишних усилий уже сегодня!
Была ли статья полезна?
Tell us your thoughts
Спасибо за ваш отзыв!
0 комментариев