API | Newsletter+ Software

Newsletter+ API

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.add
format формат ответа: json, jsonp или xml по умолчанию
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_settings
ignore_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.update
format формат ответа: 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_settings
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.delete
format формат ответа: json, jsonp или xml по умолчанию
id ID подписчика

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data: пустое, не используется

Информация по ID

Этот метод возвращает информацию о подписчике по ID.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method subscribers.get_by_id
format формат ответа: json, jsonp или xml по умолчанию
id ID подписчика

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data: пустое или массив, информация о подписчике

Информация по Email

Этот метод возвращает информацию о подписчике по Email адресу.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method subscribers.get_by_email
format формат ответа: json, jsonp или xml по умолчанию
email email подписчика

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data: пустое или массив, информация о подписчике

Количество подписчиков

Этот метод возвращает количество существующих подписчиков.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method subscribers.get_count
format формат ответа: 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_list
format формат ответа: 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_subscriptions
format формат ответа: 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.subscribe
format формат ответа: 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.unsubscribe
format формат ответа: 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_settings
format формат ответа: 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.add
format формат ответа: 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.update
format формат ответа: 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.update
format формат ответа: json, jsonp или xml по умолчанию
name название опционально

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data: пустое, не используется

Информация по ID

Этот метод возвращает информацию о существующем списке ID.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method mailing_lists.get_by_id
format формат ответа: 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_count
format формат ответа: json, jsonp или xml по умолчанию

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data.count: количество существующих списков

Массив списков

Этот метод возвращает массив существующих списков.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method mailing_lists.get_list
format формат ответа: 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_subscribers
format формат ответа: 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_subscriptions
format формат ответа: json, jsonp или xml по умолчанию
id ID списка

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data: пустое, не используется

Geo

Список стран

Этот метод возвращает массив стран.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method countries.get_countries_list
format формат ответа: json, jsonp или xml по умолчанию

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data: массив стран

Список регионов

Этот метод возвращает массив регионов.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method countries.get_regions_list
format формат ответа: 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_list
format формат ответа: json, jsonp или xml по умолчанию
region_id ID региона
search поисковая фраза для фильтрации

ОТВЕТ (массив)

msg.err_code: ID Ошибки, смотрите ниже, 0 - успех

data: массив городов

Определение расположения по IP

Этот метод возвращает массив с расположением по IP адресу.

URL
http://your_newsletter_installation/api/

ПАРАМЕТРЫ (GET/POST)

username логин от аккаунта
password пароль от аккаунта
method countries.detect
format формат ответа: 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_list
format формат ответа: 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_list
format формат ответа: 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_message
format формат ответа: 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+ API. С другой стороны, Newsletter+ может сгенерировать HTML код формы подписки для размещения на вашем сайте. Просто перейдите в раздел 'Формы', создайте новую форму, нажмите на 'HTML код', скопируйте код и разместите его на вашем сайте.

Newsletter+ плагин для Wordpress →

Этот плагин для Wordpress предоставляет простой, легкий способ подписаться на ваши списки в Newsletter+. Вы можете использовать его для размещения формы подписки в левой панели вашего сайта. Email автоматически првоеряется на корректность ввода.

Newsletter+ Библиотека PHP →

PHP класс для построения коммуникации вашего сайта или приложения с Newsletter+ API.