Newsletter+ API основан на простых HTTP GET/POST запросах. Используйте API для интеграции Newsletter+ программно с Вашим сайтом или приложением. Некоторые методы API или готовые библиотеки могут потребовать новейшую версию Newsletter+. Мы всё еще работаем над API, новыми методами и библиотеками.
Этот метод создаёт нового подписчика. Вы не сможете использовать этот метод для обновления существующего подписчика. С другой стороны, вы можете встроить форму подписки на ваш сайт используя Newsletter+ и HTML код формы подписки. Посетите Формы, добавьте новую форму, нажмите 'HTML код', скопируйте и разместите код на вашем сайте.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
Важно: Настраиваемые поля не доступны через API на данный момент. Используйте формы для этого.
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.addformat
формат ответа: json, jsonp или xml по умолчаниюfname
имя опциональноsname
фамилия опциональноemail
email подписчикаphone
номер телефона подписчикаsubscriber_language
язык для уведомлений о подтверждении подпискиlists
массив с ID списков, в которые нужно добавить подписчика. ID являются числами и могут быть получены через метод mailing_lists.get_listlists_statuses
массив со статусами подписок на списки, 0 - не подписан или не подтвердил подписку, 1 - подписан. Ключи массива являются ID списков, Значения массива содержат статусыcheck_email
установите в "1" чтобы проверить Email на существование. Не доступно если Администратор отключил эту функцию, сначала проверьте настройки через метод subscribers.get_settingsignore_autoresponders
установите в "1" для игнорирования Email автоответчиковignore_triggers
установите в "1" для игнорирования Email триггеровconfirmation
установите в "1" для отправки подтверждения подписки на список со статусом 0. Не доступно, если Администратор отключил эту функцию, сначала проверьте настройки через метод subscribers.get_settingsОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data.subscriber_id: ID подписчика
Этот метод обновляет существующего подписчика. Вы не сможете использовать этот метод для создания нового подписчика.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
Важно: Настраиваемые поля не доступны через API на данный момент. Используйте формы для этого.
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.updateformat
формат ответа: json, jsonp или xml по умолчаниюid
ID подписчикаfname
имя опциональноsname
фамилия опциональноemail
email подписчикаphone
номер телефона подписчикаsubscriber_language
язык для уведомлений о подтверждении подпискиlists
массив с ID списков, в которые нужно добавить подписчика. ID являются числами и могут быть получены через метод mailing_lists.get_list. Подписчик будет удален из других списков, не находящихся в этом массиве, если в массиве есть элементыlists_statuses
массив со статусами подписок на списки, 0 - не подписан или не подтвердил подписку, 1 - подписан. Ключи массива являются ID списков, Значения массива содержат статусыcheck_email
установите в "1" чтобы проверить Email на существование. Не доступно если Администратор отключил эту функцию, сначала проверьте настройки через метод subscribers.get_settingsignore_autoresponders
установите в "1" для игнорирования Email автоответчиковignore_triggers
установите в "1" для игнорирования Email триггеровconfirmation
установите в "1" для отправки подтверждения подписки на список со статусом 0. Не доступно, если Администратор отключил эту функцию, сначала проверьте настройки через метод subscribers.get_settingsОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод удаляет существующего подписчика.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.deleteformat
формат ответа: json, jsonp или xml по умолчаниюid
ID подписчикаОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод возвращает информацию о подписчике по ID.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.get_by_idformat
формат ответа: json, jsonp или xml по умолчаниюid
ID подписчикаОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое или массив, информация о подписчике
Этот метод возвращает информацию о подписчике по Email адресу.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.get_by_emailformat
формат ответа: json, jsonp или xml по умолчаниюemail
email подписчикаОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое или массив, информация о подписчике
Этот метод возвращает количество существующих подписчиков.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.get_countformat
формат ответа: json, jsonp или xml по умолчаниюmailing_list_id
ID списка используется для фильтрации, 0 - все подписчики по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data.count: количество существующих подписчиков
Этот метод возвращает список существующих подписчиков.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.get_listformat
формат ответа: json, jsonp или xml по умолчаниюmailing_list_id
ID списка используется для фильтрации, 0 - все подписчики по умолчаниюpage
номер страницы, для пагинацииcount
количество элементов на странице, для пагинацииorder
сортировка по информации о подписчике: email, phone, fname, sname, date_created по умолчанию, и т.д.order_type
направление сортировки: asc или desc по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив, список существующих подписчиков
Этот метод возвращает список всех подписок существующего подписчика.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.get_subscriptionsformat
формат ответа: json, jsonp или xml по умолчаниюid
ID подписчикаОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив, ключи массива содержат ID списков, а значения содержат статусы (0 - не подписан или не подтвердил подписку, 1 - подписан)
Этот метод добавляет существующего подписчика в список.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.subscribeformat
формат ответа: json, jsonp или xml по умолчаниюid
ID подписчикаlist_id
ID спискаstatus
0 - не подписан или не подтвердил подписку, 1 - подписанignore_autoresponders
установите в "1" для игнорирования Email автоответчиковignore_triggers
установите в "1" для игнорирования Email триггеровconfirmation
установите в "1" для отправки подтверждения подписки на список со статусом 0. Не доступно, если Администратор отключил эту функцию, сначала проверьте настройки через метод subscribers.get_settingsОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод убирает существующего подписчика из списка.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.unsubscribeformat
формат ответа: json, jsonp или xml по умолчаниюid
ID подписчикаlist_id
ID спискаignore_autoresponders
установите в "1" для игнорирования Email автоответчиковignore_triggers
установите в "1" для игнорирования Email триггеровОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод возвращает настройки подписчиков.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
subscribers.get_settingsformat
формат ответа: json, jsonp или xml по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data.confirmation: 0 - Функция отключена, 1 - пользователь решает использовать или нет, 2 - всегда отправляет подтверждение без участия пользователя
data.check_email: 0 - Функция отключена, 1 - пользователь решает использовать или нет, 2 - всегда проверяет существование Email
Этот метод создает новый список. Вы не сможете использовать этот метод для обновления существующего списка.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.addformat
формат ответа: json, jsonp или xml по умолчаниюname
название опциональноОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data.list_id: ID списка
Этот метод обновляет существующий список. Вы не сможете использовать этот метод для создания нового списка.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.updateformat
формат ответа: json, jsonp или xml по умолчаниюid
ID спискаname
название опциональноОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод удаляет существующий список.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.updateformat
формат ответа: json, jsonp или xml по умолчаниюname
название опциональноОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод возвращает информацию о существующем списке ID.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.get_by_idformat
формат ответа: json, jsonp или xml по умолчаниюid
ID спискаОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: empty or array, list's data
Этот метод возвращает количество существующих списков.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.get_countformat
формат ответа: json, jsonp или xml по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data.count: количество существующих списков
Этот метод возвращает массив существующих списков.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.get_listformat
формат ответа: json, jsonp или xml по умолчаниюpage
номер страницы, для пагинацииcount
количество элементов на странице, для пагинацииorder
сортировка по информации о подписчике: name, date_created по умолчанию, и т.д.order_type
направление сортировки: asc или desc по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив существующих списков
Этот метод удаляет всех подписчиков в списке.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.delete_subscribersformat
формат ответа: json, jsonp или xml по умолчаниюid
ID спискаОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод отписывает всех от списка без удаления.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
mailing_lists.delete_subscriptionsformat
формат ответа: json, jsonp или xml по умолчаниюid
ID спискаОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
Этот метод возвращает массив стран.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
countries.get_countries_listformat
формат ответа: json, jsonp или xml по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив стран
Этот метод возвращает массив регионов.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
countries.get_regions_listformat
формат ответа: json, jsonp или xml по умолчаниюcountry_code
ISO код страныОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив регионов
Этот метод возвращает массив городов.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
countries.get_cities_listformat
формат ответа: json, jsonp или xml по умолчаниюregion_id
ID регионаsearch
поисковая фраза для фильтрацииОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив городов
Этот метод возвращает массив с расположением по IP адресу.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
countries.detectformat
формат ответа: json, jsonp или xml по умолчаниюip
IP адрес пользователяОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив расположения, data.country, data.region, data.city
Этот метод возвращает количество причин.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
contact_us.get_reasons_listformat
формат ответа: json, jsonp или xml по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data.count: количество причин
Этот метод возвращает массив причин для связи.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
contact_us.get_reasons_listformat
формат ответа: json, jsonp или xml по умолчаниюpage
номер страницы, для пагинацииcount
количество элементов на странице, для пагинацииorder
сортировка по информации о причине: name, date_created по умолчанию, и т.д.order_type
направление сортировки: asc или desc по умолчаниюОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: массив причин
Этот метод отправляет сообщение обратной связи.
URL
http://your_newsletter_installation/api/
ПАРАМЕТРЫ (GET/POST)
username
логин от аккаунтаpassword
пароль от аккаунтаmethod
contact_us.send_messageformat
формат ответа: json, jsonp или xml по умолчаниюreason_id
ID причины для связиfrom_email
Email посетителяfrom_name
имя посетителяsubject
тема сообщенияmessage
текст сообщенияОТВЕТ (массив)
msg.err_code: ID Ошибки, смотрите ниже, 0 - успех
data: пустое, не используется
1: Ошибка авторизации
2: Ошибка при добавлении в базу
3: Нет Адресной Базы с указанным id
4: Нет Подписчика с указанным id
5: Подписчик уже убран из Адресной Базы
6: Не правильный формат Email
7: Email адрес не существует
8: Подписчик уже существует
9: Достигнуто максимальное количество адресных баз (перейдите в платные списки подписчиков)
10: Достигнуто максимальное количество адресных баз (перейдите в платные пакеты услуг)
11: Достигнуто максимальное количество подписчиков (перейдите в платных подписчиков)
12: Достигнуто максимальное количество подписчиков (перейдите в платные пакеты услуг)
13: Подписчик уже добавлен в Адресную Базу
14: Пользователь уже существует
15: Регистрация отключена
16: Email уже используется
17: Пароль не верен
18: Достигнуто максимальное количество email рассылок (перейдите в платные рассылки)
19: Достигнуто максимальное количество email рассылок (перейдите в платные пакеты услуг)
20: Не правильный формат Email отправителя
21: Не правильный формат Email для ответов
999: Неизвестная ошибка
Ниже вы можете скачать несколько скриптов, что решить как использовать Newsletter+ API. С другой стороны, Newsletter+ может сгенерировать HTML код формы подписки для размещения на вашем сайте. Просто перейдите в раздел 'Формы', создайте новую форму, нажмите на 'HTML код', скопируйте код и разместите его на вашем сайте.
Newsletter+ плагин для Wordpress →
Этот плагин для Wordpress предоставляет простой, легкий способ подписаться на ваши списки в Newsletter+. Вы можете использовать его для размещения формы подписки в левой панели вашего сайта. Email автоматически првоеряется на корректность ввода.
PHP класс для построения коммуникации вашего сайта или приложения с Newsletter+ API.