Меню раздела |
Smartresponder
.
API
Интерфейс прикладного программирования
АPI - это интерфейс, который позволяет с помощью специального набора команд
(функций) удаленно управлять каким-либо программным обеспечением (сервисом).
Иначе говоря, API - это интерфейс прикладного программирования для интеграции одного
программного обеспечения с другим (более подробно можно прочитать о том, что такое
API здесь).
API сервиса Smartresponder.ru дает вам возможность управлять вашим аккаунтом (аккаунтами) для ведения почтовых рассылок извне сервиса. Это означает, что вам не нужно больше заходить в свой аккаунт, чтобы проделывать какие-то повторяющиеся операции. Вы можете управлять своим аккаунтом, например, со своего сайта. Для чего используют API? API обычно используют для интеграции одной системы с другой, чтобы они взаимодействовали синхронно и обменивались данными. Самый простой пример - у вас на сайте происходит регистрация пользователей и вы хотите, чтобы одновременно с регистрацией происходила и подписка на вашу почтовую рассылку. API SmartResponder.ru помогает решить эту проблему легко и быстро. Еще API используют для создания сторонних приложений. Так, например, вы можете разработать свое собственное приложение для SmartResponder.ru и управлять своими рассылками вообще не посещая наш сайт. На самом деле API предоставляет фантастические возможности и сфера применения API-интерфейсов ничем не ограничена. Появление API-интерфейса у сервиса SmartResponder.ru поможет теперь нашим пользователям решать самые неординарные задачи, интегрируясь с нашим сервисом. А количество функций нашего API-интерфейса со временем будет только расти. API-интерфейсы представляют собой набор скриптов, вызываемых по HTTP-протоколу методом POST (в случаях запросов, не требующих передачи входных данных, чувствительных к кодировке UTF-8, допускается вызов методом GET). API-интерфейсы доступны любому автору рассылок, имеющему оплаченный аккаунт. Защита от несанкционированного доступа обеспечивается двумя способами: более простым с точки зрения реализации на стороне клиента (передача специального ключа-пароля в запросе) и более сложным, но более безопасным (передачей с каждым запросом специальной переменной, содержащей контрольную сумму всех параметров, вычисленной по алгоритму MD5). Способ защиты выбирается в аккаунте автора в разделе персональных настроек. Для всех входных и выходных данных API-интерфейсов используется кодировка UTF-8. Ответ сервера может быть получен в формате XML или JSON (определяется специальной переменной в запросе). Каждый запрос на выборку может содержать следующие параметры:
В случае, если вы выбрали защиту от несанкционированного доступа c помощью API-ключа, вам следует с каждым запросом передавать следующий параметр:
В случае, если вы хотите более надежной защиты, вам следует с каждым запросом передавать следующие параметры:
Формат ответа: <response> <result></result> <error code="" message=""/> <данные> ... <данные> </response>
S01. Общие функции
S0101. Список стран
S02. Рассылки
S0201. Получение списка рассылок
S0203. Удаление рассылки
S0204. Изменение типа рассылки
S03. Файлы
S0301. Получение списка файлов
S0302. Загрузка/обновление файла
S0303. Удаление файла
S04. Шаблоны писем
S0401. Получение списка шаблонов
S0403. Удаление шаблона
S0404. Прикрепление файла к шаблону
S0405. Удаление файла из шаблона
S0501. Получение списка подписчиков
S0601. Подписка на рассылку
S0701. Получение списка групп
S0801. Получение списка каналов
S0803. Удаление канала
S0901. Список категорий каталога
S1001. Получение данных автора
Обратные вызовы (callbacks) - это специальный блок функций API нашего сервиса, которые помогают Вам извне (например с Вашего сайта) следить в режиме реального времени за различными важными изменениями внутри Вашего авторского аккаунта на Smartresponder. Например, Вы можете постоянно считывать изменения состояний подписного листа, кто отписался или подписался и т.п. Для работы обратных вызовов Вам необходимо указать URL скрипта со своей стороны, который будет обрабатывать запросы от нашего сервера. Адрес скрипта указывается в разделе "Настройки Вашего аккаунта" во вкладке API. После нажатия "Сохранить" произойдет GET-запрос к указанному скрипту c переменной "action=test" для успешного принятия URL нашим сервисом, Ваш скрипт должен вернуть строку "TEST:OK". После каждого вызова Ваш скрипт должен возвращать строку, состоящую из ID запроса, кода действия (перечислены ниже), и слова "OK", разделив их сомволом двоеточия ":" (регистр символов не имеет значения). В противном случае запрос будет считаться неудачным и каждые 5 минут в течение 24 часов будет производиться попытка повторного вызова Вашего скрипта. Например, если наш сервис вызвал Ваш скрипт по URL http://somesite.com/smart_callback.html?request_id=123&action=subscriber_added..., то для подтверждения принятия нашего вызова, скрипт должен вернуть строку "123:subscriber_added:ok". Используемая для передачи данных кодировка - UTF-8. Данные приходят POST-запросом. Каждый запрос содержит следующие обязательные переменные:
Переменная action=subscriber_activated - подписчик активирован. |
Секреты email-маркетинга от Smartresponder!
Заработать у нас:
Следите за нами: |
Подписаться | Начать сейчас → |
Все права защищены © 2002-2022 ИП Хигер Максим Владимирович
Нужна помощь? Спросите! |