Главная страница>Исходный код PHP>Другие категории
Скачать

API умной электронной почты v3

Оболочка API для API умной электронной почты.

  • Установка
  • Использование
  • Поддерживает
  • Расширенная документация
  • Вклад или переопределение
  • Обновление
  • Авторские права и лицензия
  • Умный API электронной почты

Установка

Требования

Для этого пакета требуется PHP 7.4 и выше.

Установить через композитор 

 composer require pion/smart-emailing-v3

Использование

Создайте экземпляр API с вашим именем пользователя и ключом API. 

 use SmartEmailing  v3  Api ;

. . .
$ api = new Api ( ' username ' , ' api-key ' );

затем используйте $api с нужным методом/компонентом. 

 // Creates a new instance
$ api -> importRequest ()-> addContact ( new Contact ( ' [email protected] ' ))-> send ();

или 

 // Creates a new instance
$ import = $ api -> importRequest ();
$ contact = new Contact ( ' [email protected] ' );
$ contact -> setName ( ' Martin ' )-> setNameDay ( ' 2017-12-11 11:11:11 ' );
$ import -> addContact ( $ contact );

// Create new contact that will be inserted in the contact list
$ contact2 = $ import -> newContact ( ' [email protected] ' );
$ contact2 -> setName ( ' Test ' );

// Create new contact that will be inserted in the contact list
$ import -> newContact ( ' [email protected] ' )-> setName ( ' Test ' );
$ import -> send ();

Обработка ошибок

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

 use SmartEmailing  v3  Exceptions  RequestException ;

try {
    $ api -> ping ();
} catch ( RequestException $ exception ) {
    $ exception -> response (); // to get the real response, will hold status and message (also data if provided)
    $ exception -> request (); // Can be null if the request was 200/201 but API returned error status text
}

Поддерживает

  • Импортировать контакты
  • Импорт заказов
  • Пинг
  • Реквизиты для входа
  • Список контактов
  • Пользовательские поля
    • Пользовательские поля – создать
    • Пользовательские поля – поиск/список
    • Пользовательские поля – остальное
    • Пользовательские поля – параметры
  • Контакты
  • Контакты в списке
  • Пользовательские электронные письма
  • Электронная почта
  • Информационный бюллетень
  • Вебхуки
  • (УСТАРЕЛО) Интернет-магазины

Расширенная документация

Импортировать контакты

Импорт содержит две основные точки данных:

  1. Настройки $import->settings()->setUpdate(true)
  2. Контакты $import->newContact() : Contact , $import->contacts() : array и $import->addContact($contact) : self

Пример использования выше.

Контакт

Импорт содержит 3 основные точки данных:

  1. Все данные доступны через общедоступные свойства. Метод Fluent set имеет базовую логику проверки и преобразования даты.
  2. CustomFields $contact->customFields() для добавления новых полей
  3. ContactLists $contact->contactLists() для добавления нового списка контактов

См. исходный код для всех методов/свойств, которые вы можете использовать.

Пользовательские поля и списки контактов

Использует держатель данных с методами create / add / get / isEmpty / toArray / jsonSerialize . 

 $ field = $ contact -> customFields ()-> create ( 12 , ' test ' )
$ list = $ contact -> contactLists ()-> create ( 12 , ' confirmed ' )

Импорт заказов

Импорт содержит две основные точки данных:

  1. Настройки $import->settings()->setSkipInvalidOrders(true)
  2. Заказы $import->newOrder() : Order , $import->orders() : array и $import->addOrder($order) : self

Пример использования выше.

Пользовательские поля

CustomFields использует оболочку для каждого запроса, связанного с настраиваемыми полями. Чтобы создать новый экземпляр, вызовите $api->customFields() . На этом объекте можно создать любой запрос, который реализован на данный момент. См. ниже.

Создавать

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

 use SmartEmailing  v3  Models  CustomFieldDefinition ;

. . .
// Create the new customField and send the request now.
$ customField = new CustomFieldDefinition ( ' test ' , CustomFieldDefinition:: TEXT );
$ data = $ api -> customFields ()-> create ( $ customField );

 // Get the customField in data
$ customFieldId = $ data -> id ;

или 

 $ request = $ api -> customFields ()-> createRequest (); // You can pass the customField object

// Setup customField
$ customField = new CustomField ();
$ request -> setCustomField ( $ customField );

// Setup data
$ customField -> setType (CustomField:: RADIO )-> setName ( ' test ' );

// Send the request
$ response = $ request -> send ();
$ data = $ response -> data ();
$ customFieldId = $ data -> id ;

Поиск/Список

API-документы

Включает поиск по настраиваемым полям с поддержкой фильтрации/сортировки. Количество результатов ограничено 100 на страницу. Ответ возвращает метаданные (MetaDataInterface) и массив ModelsCustomFieldDefinition путем вызова $response->data() .

Ответ

  • data() возвращает массив ModelsCustomFieldDefinition
  • Meta() возвращает stdClass со свойствами (определенными в MetaDataInterface ).

Получить список без расширенного поиска

Создает поисковый запрос и настраивает только $page или $limit . Полный ответ от API с помощью customfield_options_url или 

 $ data = $ api -> customFields ()-> list ();

/** @var SmartEmailingv3ModelsCustomFieldDefinition $customField */
foreach ( $ data as $ customField ) {
    echo $ customField -> id ;
    echo $ customField -> name ;
    echo $ customField -> type ;
}

Расширенный поиск – фильтр/сортировка/и т.д. 

 $ request = $ api -> customFields ()-> searchRequest ( 1 );

// Search by name
$ request -> filter ()-> byName ( ' test ' );
$ request -> sortBy ( ' name ' );

// Send the request
$ response = $ request -> send ();
$ data = $ response -> data ();
Методы запроса
  • Геттеры находятся через общественную собственность
    • страница
    • предел
    • выбирать
    • расширять
    • сортировать
  • Свободные сеттеры (с проверкой) — подробнее ниже.
  • filter() возвращает настройку фильтров — подробнее ниже.
expandBy(строка: $expand)

При использовании этого параметра свойство «customfield_options_url» будет заменено на «customfield_options», содержащее расширенные данные. См. примеры ниже. Для получения дополнительной информации см. конечную точку «/customfield-options».

Допустимые значения: «customfield_options»

выбрать (строка: $select)

Список свойств, разделенных запятыми, для выбора. например. "?select=id,name" Если не указано, выбираются все поля.

Допустимые значения: «id», «имя», «тип».

sortBy (строка: $ сортировка)

Список ключей сортировки, разделенный запятыми, слева. Добавьте «-» к любой клавише для направления по убыванию, например. "?sort=тип,-имя"

Допустимые значения: «id», «имя», «тип».

setPage(int: $page)

Устанавливает текущую страницу

предел (целое: $лимит)

Устанавливает предел результата в одном запросе

фильтр()

Позволяет фильтровать настраиваемые поля с несколькими условиями фильтрации.

  • Геттеры находятся через общественную собственность
    • имя
    • тип
    • идентификатор
  • Свободные сеттеры (с проверкой)
    • поИмя($значение)
    • потипу($значение)
    • поId($value)

Получить по имени

Запускает поисковый запрос с фильтром имен и проверяет, найдено ли данное имя в customFields. Возвращает false или CustomFieldsCustomField . Использует логику отправки (выдает RequestException). 

 // Can throw RequestException - uses send.
if ( $ customField = $ api -> customFields ()-> getByName ( ' name ' )) {
    return $ customField -> id ;
} else {
    throw new Exception ( ' Not found! ' , 404 );
}

Отправка / Транзакционные электронные письма

Реализация вызова API send/transactional-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_transactional_emails

Полный пример транзакционного электронного письма 

 $ transactionEmail = $ api -> transactionalEmailsRequest ();

$ credentials = new SenderCredentials ();
$ credentials -> setFrom ( ' [email protected] ' );
$ credentials -> setReplyTo ( ' [email protected] ' );
$ credentials -> setSenderName ( ' Jean-Luc Picard ' );

$ recipient = new Recipient ();
$ recipient -> setEmailAddress ( ' [email protected] ' );

$ replace1 = new Replace ();
$ replace1 -> setKey ( ' key1 ' );
$ replace1 -> setContent ( ' content1 ' );

$ replace2 = new Replace ();
$ replace2 -> setKey ( ' key2 ' );
$ replace2 -> setContent ( ' content2 ' );

$ templateVariable = new TemplateVariable ();
$ templateVariable -> setCustomData ([
    ' foo ' => ' bar ' ,
    ' products ' => [
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc1 ' ],
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc2 ' ]
    ]
]);

$ attachment1 = new Attachment ();
$ attachment1 -> setContentType ( ' image/png ' );
$ attachment1 -> setFileName ( ' picture.png ' );
$ attachment1 -> setDataBase64 ( ' data1 ' );

$ attachment2 = new Attachment ();
$ attachment2 -> setContentType ( ' image/gif ' );
$ attachment2 -> setFileName ( ' sun.gif ' );
$ attachment2 -> setDataBase64 ( ' data2 ' );

$ task = new Task ();
$ task -> setRecipient ( $ recipient );
$ task -> addReplace ( $ replace1 );
$ task -> addReplace ( $ replace2 );
$ task -> setTemplateVariables ( $ templateVariable );
$ task -> addAttachment ( $ attachment1 );
$ task -> addAttachment ( $ attachment2 );

$ messageContents = new MessageContents ();
$ messageContents -> setTextBody ( ' text_body ' );
$ messageContents -> setHtmlBody ( ' html_body ' );
$ messageContents -> setSubject ( ' subject ' );

$ transactionEmail -> setTag ( ' tag_tag ' );
$ transactionEmail -> setEmailId ( 5 );
$ transactionEmail -> setSenderCredentials ( $ credentials );
$ transactionEmail -> addTask ( $ task );
$ transactionEmail -> setMessageContents ( $ messageContents );

$ transactionEmail -> send ();

Отправка/массовая рассылка пользовательских писем

Реализация вызова API send/custom-emails-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_emails

Полный пример индивидуального электронного письма 

 $ transactionEmail = $ api -> customEmailsBulkRequest ();

$ credentials = new SenderCredentials ();
$ credentials -> setFrom ( ' [email protected] ' );
$ credentials -> setReplyTo ( ' [email protected] ' );
$ credentials -> setSenderName ( ' Jean-Luc Picard ' );

$ recipient = new Recipient ();
$ recipient -> setEmailAddress ( ' [email protected] ' );

$ replace1 = new Replace ();
$ replace1 -> setKey ( ' key1 ' );
$ replace1 -> setContent ( ' content1 ' );

$ replace2 = new Replace ();
$ replace2 -> setKey ( ' key2 ' );
$ replace2 -> setContent ( ' content2 ' );

$ templateVariable = new TemplateVariable ();
$ templateVariable -> setCustomData ([
    ' foo ' => ' bar ' ,
    ' products ' => [
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc1 ' ],
        [ ' name ' => ' prod1 ' , ' desc ' => ' desc2 ' ]
    ]
]);

$ task = new Task ();
$ task -> setRecipient ( $ recipient );
$ task -> addReplace ( $ replace1 );
$ task -> addReplace ( $ replace2 );
$ task -> setTemplateVariables ( $ templateVariable );

$ transactionEmail -> setTag ( ' tag_tag ' );
$ transactionEmail -> setEmailId ( 5 );
$ transactionEmail -> setSenderCredentials ( $ credentials );
$ transactionEmail -> addTask ( $ task );

$ transactionEmail -> send ();

Отправка / Массовая рассылка SMS-сообщений

Реализация вызова API send/custom-sms-bulk : https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_SMS

Пример полной отправки смс 

 $ bulkCustomSms = $ api -> customSmsBulkRequest ();

$ recipient = new Recipient ();
$ recipient -> setEmailAddress ( ' [email protected] ' );
$ recipient -> setCellphone ( ' +420777888777 ' );

$ replace1 = new Replace ();
$ replace1 -> setKey ( ' key1 ' );
$ replace1 -> setContent ( ' content1 ' );

$ replace2 = new Replace ();
$ replace2 -> setKey ( ' key2 ' );
$ replace2 -> setContent ( ' content2 ' );

$ task = new Task ();
$ task -> setRecipient ( $ recipient );
$ task -> addReplace ( $ replace1 );
$ task -> addReplace ( $ replace2 );

$ bulkCustomSms -> setTag ( ' tag_tag ' );
$ bulkCustomSms -> setSmsId ( 5 );
$ bulkCustomSms -> addTask ( $ task );

$ bulkCustomSms -> send ();

Обновление

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

Вклад или переопределение

См. CONTRIBUTING.md, чтобы узнать, как внести изменения. Все вклады приветствуются.

Авторские права и лицензия

smart-emailing-v3 был написан Мартином Клуской и выпущен под лицензией MIT.

Copyright (c) 2016–2022 Мартин Клуска и участники

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все