Как перейти с Mailgun на SendGrid
Опубликовано: 2018-11-10Если Mailgun является вашим текущим поставщиком услуг электронной почты и вы хотите внести изменения, это руководство поможет вам перейти на SendGrid, выделив различия между двумя службами.
Если вы хотите осмотреться перед тем, как начать, ознакомьтесь с документацией SendGrid, которая включает в себя отличные ресурсы, прежде чем погрузиться в справку по API и подробности.
Терминология
Если вы ищете эквивалент определенных функций Mailgun в SendGrid, вам поможет следующая таблица:
Термин SendGrid | Срок действия почтового пистолета |
замены/разделы | подстановочные данные |
категории | теги |
уникальные_аргументы | X-Mailgun-Переменные |
Несколько учетных данных | Многопользовательский доступ |
субпользователь | Mailgun не предоставляет дискретных субпользователей. |
подавления | подавления |
X-SMTPAPI | Mailgun использует отдельный X-заголовок для каждого параметра конфигурации, например X-Mailgun-Recipient-Variables. |
Входящий веб-перехватчик синтаксического анализа | Маршруты |
Веб-перехватчик событий | Вебхуки |
Маркетинговые кампании | Нет эквивалента |
Получение ключа API
Во-первых, вам понадобится учетная запись SendGrid. Далее вам нужно создать ключ API, который вы будете использовать для отправки. Перейдите в Настройки -> Ключи API или воспользуйтесь этой ссылкой. Лучшая практика SendGrid и безопасности — использовать разные ключи API для каждого из ваших разных приложений. Ключи API имеют детализированные разрешения, поэтому вы можете включать или отключать доступ на чтение или запись для отдельных конечных точек. Убедитесь, что созданный ключ API имеет полный доступ к Mail Send . (Примечание. Прежде чем вы сможете создать ключ API, ваша учетная запись должна пройти подготовку.)
Библиотеки API
У нас есть ряд официально поддерживаемых библиотек API, чтобы упростить интеграцию для наших клиентов. Если вы переписываете какой-либо код или реорганизуете способ взаимодействия с вашим ESP в рамках миграции, сейчас самое время оценить эти библиотеки:
- sendgrid-csharp — официальная библиотека C#
- sendgrid-go — официальная библиотека Go
- sendgrid-java — официальная библиотека Java
- sendgrid-nodejs — официальная библиотека NodeJS
- sendgrid-php — официальная библиотека PHP
- sendgrid-python — официальная библиотека Python
- sendgrid-ruby — официальная библиотека Ruby
SMTP
Если вы отправляете через SMTP, есть несколько отличий, о которых вы должны знать. Для аутентификации укажите строку «apikey» в качестве имени пользователя SMTP и используйте ключ API в качестве пароля. Затем укажите свое имя хоста на smtp.sendgrid.net .
Вы можете подключиться с помощью SMTP через незашифрованный или TLS через порты 25, 2525 и 587. Вы также можете подключиться через SSL через порт 465. В целом, мы рекомендуем порт 587, так как это приводит к наименьшему количеству проблем с хостинг-провайдерами.
Механизм настройки электронной почты, отправляемой через SMTP, — это наш заголовок X-SMTPAPI. Этот заголовок позволит вам определять замены, отправлять пакетные запросы в стиле слияния и контролировать фильтры (например, отслеживание кликов), которые активны для вашей отправки.
HTTP
Основной конечной точкой для отправки электронной почты является конечная точка Mail. Запросы к этой конечной точке аутентифицируются через заголовок авторизации с вашим ключом API, представленным в виде токена-носителя. Вы можете найти более подробный пример в нашей документации.
Персонализация позволяет вам определять получателей и метаданные для каждого сообщения, например значения замены для настройки содержимого или custom_args для связывания сообщений с идентификаторами пользователей или номерами заказов. Существует ряд примеров персонализации для распространенных случаев использования. Вы также можете найти примеры вызовов cURL.
Такие функции, как отслеживание кликов, настраиваются с помощью параметров tracking_settings и mail_settings. Вы также можете запланировать отправку на срок до 72 часов, используя параметр «send_at».
Вложения, отправленные через HTTP, обрабатываются иначе, чем Mailgun. Mailgun требует POST multipart/form-data, содержащий прикрепляемые файлы. С помощью SendGrid контент кодируется как Base64 и встраивается непосредственно в полезную нагрузку JSON вместе с информацией MIME, сохраняя все ваше сообщение в одной полезной нагрузке и упрощая ваш HTTP-запрос. Вы можете узнать больше о включении вложений в следующем разделе нашего Класса документации.
Вебхуки
SendGrid предоставляет два веб-перехватчика: веб-перехватчик событий для публикации событий в реальном времени и веб-перехватчик входящего анализа для получения электронных писем и программного ответа на них. Формы данных и полезная нагрузка немного отличаются от того, что предоставляет Mailgun. В настоящее время мы также не поддерживаем маршрутизацию входящих сообщений на разные URL-адреса обратного вызова; вам нужно будет обрабатывать такую логику в коде, а не на уровне API.
Конечные точки API без электронной почты
Для конечных точек API, которые не отправляют электронную почту, ознакомьтесь с обзором API v3. В большинстве случаев мы используем интуитивно понятные HTTP-методы и коды ответов, а также применяем ограничения скорости для вызовов. API v2 устарел, хотя сроков прекращения его поддержки нет. Все новые интеграции должны отдавать предпочтение v3. Аутентификация API v3 выполняется с помощью заголовка аутентификации с токеном носителя.
Маркетинговые кампании
У нас есть полнофункциональная платформа для управления списками контактов, создания и разработки шаблонов, A/B-тестирования различных шаблонов и планирования кампаний. Все это упаковано в пользовательский интерфейс, который прост в использовании для не-разработчиков. И, конечно же, вы также можете получить доступ ко всем этим функциям через наш API маркетинговых кампаний.
Несколько часто задаваемых вопросов
В: Поддерживаете ли вы шаблоны для транзакционных писем?
A: Да, и они динамичны! Шаблоны транзакций SendGrid имеют встроенную поддержку синтаксиса Handlebars. В дополнение к базовой замене и подстановке вы можете использовать перечисления/перебирать списки, использовать условные операторы и многое другое. Чтобы узнать больше, нажмите сюда.
В: Есть ли песочница или способ проверить мои электронные письма, не отправляя их?
A: Вы можете включить режим песочницы при отправке через HTTP. Существует также адрес «приемника», который вы можете использовать для тестирования.
В: Можно ли перенести мой IP-адрес/репутацию отправителя в SendGrid?
О: Мы не можем перенести IP-адрес или репутацию, но мы можем помочь вам автоматически подготовить новый IP-адрес.
Вопрос. Поддерживает ли SendGrid принудительный TLS ?
О: Абсолютно. Вы можете потребовать, чтобы принимающие серверы поддерживали TLS и отбрасывали сообщения, идущие на серверы, которые не соответствуют требованиям.
В: Могу ли я разрешить своим получателям определять типы электронных писем, которые они хотят получать?
О: Да. Предоставление вашим получателям большего контроля над своей электронной почтой позволяет вам отправлять электронные письма, которые нужны людям, что лучше для всех. Посетите группы отписки для получения дополнительной информации.
Если вы заинтересованы в переходе на SendGrid, дополнительную информацию можно найти на странице sendgrid.com/pricing.