Знакомство с FEEDGEE API

FEEDGEE API — это наш программный интерфейс для вашего сайта, программы и приложения, который позволяет им использовать функции вашего аккаунта.

Наши методы API разделены на группы согласно основных функций сервиса

В бесплатных аккаунтах недоступны методы API для экспорта.

Для работы с API вам необходимо ключ доступа API Key, который можно сгенерировать на странице Мои данные → API Keys. Для безопасности вы можете сгенерировать несколько API ключей, если используете интеграцию вашего feedgee-аккаунта одновременно с несколькими своими ресурсами (например, с сайтом, мобильным приложеним и CRM программой), чтобы в случае потери ключей вы могли запретить его использование в своем feedgee-аккаунте с помощью деактивации.

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

FEEDGEE API (версия 1.0)

Вызов методов

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

http://api.feedgee.com/1.0/Method?apikey=APIKEY&arg1=ARG1&argN=ARG_N&output=xml

где:

  • Method — название метода
  • APIKEY — ключ доступа к API
  • arg1 … argN — аргументы метода, свои для каждого метода
  • ARG1 … ARG_N — значения аргументов, свои для каждого вызова
  • OUTPUT — опциональный аргумент необходимый для вывода данных в формате json. Без его указания по умолчанию вывод происходит в формате XML

В запросе необходимо указывать все аргументы, описанные в методах (кроме OUTPUT) .

Опциональные аргументы могут не содержать значения, но названия самих аргументов должны обязательно присутствовать в запросе. Значения опциональных аргументов в этом случае автоматически заменяются сервисом на значения по умолчанию.

Примеры

Описание каждого метода содержит синтаксис и форму запроса, структуру и примеры возвращаемого значения, примеры PHP и SOAP запросов. Вы можете использовать для работы с методами API любой другой используемый вами язык программирования.

Использование POST, GET

Все передаваемые значения должны быть в кодировке UTF-8.

Параметры передаются как в GET запросе, так и в POST запросе.

Для увеличения безопасности параметр APIKEY рекомендуется передавать через POST запрос.

Типы запросов и их особенности:

  • Поддерживаются JSON, SOAP, JSONP запросы;
  • При использовании JSON POST запроса все значения аргументов должны быть заключены в кавычки (требование формата JSON);
  • Также API поддерживает возможность выполнять асинхронные запросы (AJAX) к серверу на основе JSONP;
  • При этом возможно сразу поместить возвращаемые данные в вызов клиентской функции;
  • Пример вызываемой функции: someCallback (d:{ one: «1», two: «2» });
  • Чтобы получить данные в виде JSONP, к запросу необходимо добавить название функции-callback, в которую будут «завернуты” возвращаемые данные. Указанная выше ссылка будет выглядеть так

http://api.feedgee.com/beta/METHOD?apikey=APIKEY&arg1=ARG1&argN=ARG_N&output=json&callback=someCallback

Сотрудничество и поддержка

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

Коды ошибок

общие ошибки системы

ServerError_MethodUnknown -32601
ServerError_InvalidParameters -32602
Unknown_Exception -99
Request_TimedOut -98
Zend_Uri_Exception -92
PDOException -91
Avesta_Db_Exception -91
XML_RPC2_Exception -90
XML_RPC2_FaultException -90
Too_Many_Connections -50
Parse_Exception 0

ошибки доступа пользователя (100)

User_Unknown 100
ApiKey_Disabled 101
User_DoesNotExist 102
User_NotApproved 103
Invalid_ApiKey 104
User_UnderMaintenance 105
Invalid_AppKey 106
Invalid_IP 107
User_DoesExist 108
User_ReputationNotEnough 109

неверные действия пользователя (120)

User_InvalidAction 120
User_MissingEmail 121
User_CannotSendCampaign 122
User_MissingModuleOutbox 123
User_ModuleAlreadyPurchased 124
User_ModuleNotPurchased 125
User_NotEnoughCredit 126
MC_InvalidPayment 127
User_IncompleteDetails 128

ошибки при работе со списками И ПОДПИСЧИКАМИ (200)

List_DoesNotExist 200
//210: List — Basic Actions
List_InvalidInterestFieldType 210
List_InvalidOption 211
List_InvalidUnsubMember 212
List_InvalidBounceMember 213
List_AlreadySubscribed 214
List_NotSubscribed 215
//220: List — Import Related
List_InvalidImport 220
MC_PastedList_Duplicate 221
MC_PastedList_InvalidImport 222
//230: List — Email Related
Email_AlreadySubscribed 230
Email_AlreadyUnsubscribed 231
Email_NotExists 232
Email_NotSubscribed 233
Phone_NotExists 234
//250: List — Merge Related
List_MergeFieldRequired 250
List_CannotRemoveEmailMerge 251
List_Merge_InvalidMergeID 252
List_TooManyMergeFields 253
List_InvalidMergeField 254
//270: List — Interest Group Related
List_InvalidInterestGroup 270
List_TooManyInterestGroups 271

ошибки при работе с рассылками (300)

Campaign_DoesNotExist 300
Campaign_StatsNotAvailable 301
//310: Campaign — Option Related Errors
Campaign_InvalidAbsplit 310
Campaign_InvalidContent 311
Campaign_InvalidOption 312
Campaign_InvalidStatus 313
Campaign_NotSaved 314
Campaign_InvalidSegment 315
Campaign_InvalidRss 316
Campaign_InvalidAuto 317
MC_ContentImport_InvalidArchive 318
Campaign_BounceMissing 319
Campaign_NotScheduled 320
//330: Campaign — Ecomm Errors
Invalid_EcommOrder 330
//350: Campaign — Absplit Related Errors
Absplit_UnknownError 350
Absplit_UnknownSplitTest 351
Absplit_UnknownTestType 352
Absplit_UnknownWaitUnit 353
Absplit_UnknownWinnerType 354
Absplit_WinnerNotSelected 355

ошибки при работе с данными АНАЛИТИКИ (500)

//500: Generic Validation Errors
Invalid_Analytics 500
Invalid_DateTime 501
Invalid_Email 502
Invalid_SendType 503
Invalid_Template 504
Invalid_TrackingOptions 505
Invalid_Options 506
Invalid_Folder 507
Invalid_URL 508
Invalid_Phone 509
//550: Generic Unknown Errors
Module_Unknown 550
MonthlyPlan_Unknown 551
Order_TypeUnknown 552
Invalid_PagingLimit 553
Invalid_PagingStart 554
Max_Size_Reached 555