API. Что это?

API - набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (сервисом) для использования во внешних программных продуктах.

API сервиса MassDelivery позволяет управлять вашим аккаунтом автора, не заходя в него, то есть удалённо. Управление аккаунтом может происходить, например, с вашего сайта.

Аутентификация

Для аутентификации и получения права на отправку запросов используется уникальный 32-символьный API-ключ. Узнать его можно в настройках аккаунта автора во вкладке "API-ключ".

api_key* Является обязательным параметром для передачи в каждом запросе.

Срок действия ключа не ограничен. Если вы желаете приостановить обработку запросов по вашему ключу, вы можете отключить API-интерфейс для вашего аккаунта в настройках.


Общие параметры

Любой из запросов может включать в себя следующие параметры:

format Формат ответа сервера - доступные варианты JSON и XML. Формат ответа по умолчанию JSON.
fields Принимает в качестве значения названия полей которые могут быть получены в результате запроса. Например, вам необходимы только названия рассылок, нужно будет указать fields=title в запросе к соответствующему интерфейсу. По умолчанию возвращается весь список доступных полей.
fields_exclude Принимает в качестве значения названия полей которые должны быть исключены из результата запроса. Например, вам необходимо получить все поля из интерфейса списка шаблонов за исключением html_body, тогда нужно будет указать fields_exclude=html_body.
out Для читаемого вида результата Api запроса в браузере, передается параметр out со значением text out=text.

Для параметров fields и fields_exclude разделителем названий полей является запятая.


Форматы ответа

В случае возникновения ошибки будет получен ответ следующего вида

{
   "result":0,
   "error":{
      "code": "здесь будет код ошибки",
      "message":"здесь будет описание ошибки"
   }
}

А в случае успешного такой

{  
   "result":1,
   "данные":{
      "Вывод данных согласно параметрам запроса"
   }
}
result Результат исполнения запроса.


1 - запрос исполнен успешно
0 - запрос не исполнен или исполнен с ошибками

error В данном поле будет показана информация в виде кода ошибки code, и текста поясняющего причину ошибки message, в случае их возникновения во время запроса. В противном случае поле error будет отсутствовать.
данные Набор полей с данными того или иного API-интерфейса. Поля разнятся в зависимости от выбранного интерфейса. Если интерфейс не возвращает никаких данных, данные могут отсутствовать.
2018 MassDelivery