Знайомство з FEEDGEE API

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

Використання API допоможе отримати можливості сервісу не покидаючи ваш сайт або програму в якій вам зручно організувати роботу зі своїми піпдписчиками.

Можливості FEEDGEE API дозволяють автоматизувати роботу з усіма інструментами сервісу, починаючи від створення списку, імпорту підписчиків, створення та надсилання розсилок і закінчуючи отриманням аналітики з результатами розсилок.

Використання API відбувається за допомогою звернення до методів, які розділені на п'ять категорій:

Базові можливості API доступні як платним, так і безкоштовним користувачам, але використання деяких методів доступно тільки в платних облікових записах.

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

Увага! Пам'ятайте, що не слід передавати API ключі третім особам і зберігати їх у вільному доступі, так як ключ надає доступ до можливостей вашого профілю і ними можуть скористатися для відправки розсилок від вашого імені і отримання даних ваших підписчиків.

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 запитів.

Використання 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