Список методов

• getLists - получить списки рассылки с их кодами
• createList - создать новый список рассылки
• subscribe - подписать адресата на один или несколько списков рассылки
• exclude - исключить адресата из списков рассылки
• unsubscribe - отписать адресата от рассылки
• sendSms - отправить SMS-сообщение одному адресату
• checkSms - проверить статус доставки SMS
• createEmailMessage - создать новое e-mail сообщение
• createCampaign - запланировать отправку e-mail сообщения
• register - зарегистрировать пользователя (для партнёрских сайтов)
• getUserInfo - получить информацию о пользователе (для партнёрских сайтов)
• transferMoney - перевести деньги на счёт пользователя (для партнёрских сайтов)

Общее описание

Работа с API бесплатна, достаточно самостоятельно включить доступ и получить ключ к нему в Личном кабинете. Ключ доступа не следует передавать другим или делать видимым в коде веб-страниц, т.к. в этом случае кто-нибудь может воспользоваться им и отправлять сообщения от вашего имени.

Доступ к API может работать в тестовом или полнофункциональном режиме. В тестовом режиме действия, могущие привести к изменению данных, снятию денег или отправке сообщений, сообщают об успешном завершении, но на самом деле не выполняются. Этот режим удобно использовать при первоначальной настройке. Режим можно самостоятельно переключить в Личном кабинете.

Вызов метода

Обращение к методам API - это HTTP-запрос к URL вида:

http://api.unisender.com/ru/api/METHOD?format=json&api_key=KEY&arg1=ARG_1&argN=ARG_N

где:

METHOD

название метода

KEY

ключ доступа к API

ARG_1 ... ARG_N

аргументы метода, свои для каждого метода

Все параметры должны быть в кодировке UTF-8. В примере выше параметры указаны в GET-запросе, но можно передавать их и в POST. Более того, параметр api_key мы настоятельно рекомендуем передавать через POST, чтобы он не сохранялся в логах прокси-серверов.

Ответ приходит в виде объекта формата JSON.

Успешный вызов метода

Если вызов успешен, то объект будет содержать поле "result", содержимое которого зависит от вызванного метода, и не будет содержать поля "error".

Но даже в случае успешного выполнения метода возможно наличие поля "warnings", содержащего массив объектов-предупреждений с единственным строковым полем "warning".

Пример успешного ответа:

{
  "result":523514,
  "warnings":[
    {"warning":"probably not a mobile phone"}
  ]
}

Ошибки при вызове метода

Признаком ошибки при выполнении метода является наличие в объекте ответа поля "error" с HTML-сообщением об ошибке. Кроме того, в объекте ответа в случае ошибки будет ещё и поле "code" со строковым кодом ошибки. А поле "result" в случае ошибки должно быть проигнорировано.

Стандартные коды ошибок:

unspecified

Тип ошибки не указан. Подробности смотрите в сообщении.

invalid_api_key

Указан неправильный ключ доступа к API. Проверьте, совпадает ли значение api_key со значением, указанным в личном кабинете.

access_denied

Доступ запрещён. Проверьте, включён ли доступ к API в личном кабинете и не обращаетесь ли вы к методу, прав доступа к которому у вас нет.

unknown_method

Указано неправильное имя метода

invalid_arg

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

not_enough_money

Не хватает денег на счету

Кроме этих ошибок, могут быть и другие, указанные в описаниях методов. Коды ошибок уникальны для всего API вне зависимости от метода.

Пример ответа с ошибкой:

{"error":"AK100310-02","code":"invalid_api_key"}