Регистрация | Личный кабинет
Войти на сайт
Забыли свой пароль?
Закрыть


8 (800) 100-99-29
звонок по России бесплатный

API для разработчиков

Хотите быть впереди конкурентов? Попробуйте БЕСПЛАТНО прямо сейчас.

Документация API «МайлСофт» 1.0

Как обращаться к API?

Работа с API осуществляется при помощи отправки HTTP-запросов (методы GET, POST) по адресу:

api.mailsoft.org

Возможно использование протоколов HTTP либо HTTPS. Кодировка: UTF-8. Пример запроса:

http://api.mailsoft.org/?method=lists.get&username=example&password=example&format=xml

Обязательные параметры запроса

·         method (вызываемый метод вида "категория.метод", например 'lists.get')

·         username (логин для авторизации)

·         password (пароль для авторизации)

Возвращаемые данные

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

·         JSON (default)

·         JSONP

·         XML

Печкин возвращает данные структурированные следующим образом:

·         <msg> сообщение о выполнении действия в виде массива с ключами <err_code> - числовой код ошибки (0 - нет ошибок), <text> - текстовое сообщение, <type> - тип сообщения (message – нет ошибок, notice и error – ошибки)

·         <data> запрашиваемые данные в виде массива, если есть.



Коды ошибок

errors

Таблица известных ошибок, возвращаемых сервисом.

 

Категории методов

lists - Для работы с Адресными Базами

campaigns - Для работы с Кампаниями

reports - Для работы с Отчетами

 

Методы работы с Адресными Базами 

lists.get ( int list_id )

Получаем список баз пользователя


lists.add ( string namestring abuse_emailstring abuse_namestring companystring addressstring citystring zip

string countrystring url,string phone )

Добавляем адресную базу


lists.update ( int list_idstring abuse_emailstring abuse_namestring companystring addressstring city

string zipstring countrystring url,string phone )

Обновляем контактную информацию адресной базы


lists.delete ( int list_id )

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


lists.get_members ( int list_idstring stateint startint limitstring orderint member_idstring email )

Получаем подписчиков в адресной базе с возможность фильтра и регулировки выдачи.


lists.upload ( int list_idstring fileint emailint merge_1int merge_2int merge_3int merge_4int merge_5

string typestring updateintsheet_indexstring sheet_name )

Импорт подписчиков из файла


lists.add_member ( int list_idstring emailstring merge_1string merge_2string merge_3string merge_4

string merge_5string update )

Добавляем подписчика в базу


lists.update_member ( int member_idstring merge_1string merge_2string merge_3string merge_4

string merge_5 )

Редактируем подписчика в базе


lists.delete_member ( int member_id )

Удаляем подписчика из базы.


lists.unsubscribe_member ( int member_idstring emailstring list_idstring reason )

Отписываем подписчика из базы.


lists.move_member ( int member_idint list_id )

Перемещаем подписчика в другую адресную базу.


lists.copy_member ( int member_idint list_id )

Копируем подписчика в другую адресную базу.


lists.add_merge ( int list_idstring typeserialized array choicesstring titlestring reqstring var )

Добавить дополнительное поле в адресную базу.


lists.update_merge ( int list_idint merge_idserialized array choicesstring titlestring reqstring var )

Обновить настройки дополнительного поля в адресной базе.


lists.delete_merge ( int list_idint merge_id )

Удалить дополнительное поле из адресной базы.


 

Методы работы с Рассылками 

campaigns.get ( int campaign_idstring statusint list_idstring type )

Получаем список рассылок пользователя


campaigns.create ( serialized array list_idstring namestring subjectstring from_namestring from_email

string personalizeToEmailstringto_emailstring track_opensstring track_clicks

string plain_clicksstring no_images_addstring analyticsstring analytics_tagstring html,string plain_text

serialized array esegment )

Создаем рассылку.


campaigns.update ( int campaign_idserialized array list_idstring namestring subjectstring from_namestring from_emailstringpersonalizeToEmail

string to_emailstring track_opensstring track_clicksstring plain_clicks

string no_images_addstring analyticsstringanalytics_tagstring htmlstring plain_text

string statusserialized array esegment )

Обновляем параметры рассылки.


campaigns.delete ( int campaign_id )

Удаляем кампанию


 

Методы работы с Отчетами 

reports.sent ( int campaign_idint startint limitstring order )

Список отправленных писем в рассылке


reports.delivered ( int campaign_idint startint limitstring order )

Список доставленных писем в рассылке


reports.opened ( int campaign_idint startint limitstring order )

Список открытых писем в рассылке


reports.unsubscribed ( int campaign_idint startint limitstring order )

Список писем отписавшихся подписчиков в рассылке


reports.bounced ( int campaign_idint startint limitstring order )

Список возвратившихся писем в рассылке


reports.clickstat ( int campaign_id )

статистика по кликам по различным url в письме


reports.bouncestat ( int campaign_id )

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


reports.summary ( int campaign_id )

краткая статистка по рассылке


reports.clients ( int campaign_id )

статистика по браузерам, ОС и почтовым клиентам


reports.geo ( int campaign_id )

статистика по регионам открытия