API. Что это?
API - набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (сервисом) для использования во внешних программных продуктах.
API сервиса Falconsender позволяет управлять вашим аккаунтом автора, не заходя в него, то есть удалённо. Управление аккаунтом может происходить, например, с вашего сайта. Это очень удобно.
Дополнительные данные
API доступно только авторам, использующим платные тарифы.
Для передачи всех данных используется кодировка UTF-8.
Любой из запросов может включать в себя следующие параметры:
format Формат ответа сервера - XML (по умолчанию) или JSON (если в запросе указана специальная переменная).
fields Наименования полей, указанные через запятую, которые могут быть получены в результате запроса. Например, вам необходимо получить лишь ID и названия рассылок, нужно будет указать fields=id,title в запросе к соответствующему интерфейсу и т.д. По умолчанию возвращаются все наименования полей.
fields_exclude Наименования полей, указанные через запятую, которые должны быть исключены из результата запроса. Например, вам необходимо получить все поля из интерфейса списка шаблонов за исключением html_body и text_body, тогда нужно будет указать fields_exclude=html_body,text_body.
Аутентификация
В качестве аутентификации используется уникальный 32-символьный API-ключ.
api_key* Уникальный 32-символьный API-ключ. Получить данный ключ можно в настройках аккаунта автора в разделе "API". Чтобы получить доступ ко всем API-интерфейсам необходим только данный ключ.
Формат ответа
<response>
<result></result>
<error code="" message=""/>
<данные>
...
<данные>
</response>
result Результат исполнения запроса.
1 - запрос исполнен удачно (не возникло системных ошибок)
0 - запрос не исполнен или исполнен с ошибками
error Если во время выполнения возникли какие-либо ошибки, то данное поле содержит код ошибки (code) и текст сообщения об ошибке (message). Если ошибок не возникло, поле error отсутствует
данные Набор полей с данными того или иного API-интерфейса. Поля разнятся в зависимости от выбранного интерфейса. Если интерфейс не возвращает никаких данных, данные могут отсутствовать.
