eDirect API (Application programming interface)

Pre prepojenie eDirectu s inými systémami slúži predovšetkým jeho API. Prostredníctvom API môžete spravovať databázu adresátov a pripravovať či rozposielať letáky. Môžete takto plne využiť možnosti vášho systému a využiť eDirect tam, kde je najsilnejší – v sofistikovanom odosielaní e-mailov a v štatistikách efektívnosti e-mailových kampaní.

API používa na komunikáciu SOAP. V prípade záujmu o prepojenie eDirectu s vašim systémom alebo aplikáciou nás, prosím, kontaktujte. Pri komunikácii s eDirectom môžete využiť nižšie uvedené funkcie. Hlavička v SOAP komunikácii obsahuje vaše meno a heslo, ktorým overujete vaše požiadavky. Komunikácia s API je zabezpečená SSL certifikátom s 256-bitovým šifrovaním, server sa nachádza na adrese https://api.edirect.sk/.

getGroups(header)

  • vracia pole objektov / skupín

getGroupSubscribers(header, group id)

  • vracia pole objektov / adresátov

addGroup(header, data)

  • vracia objekt / skupina

updateGroup(header, group id, data)

  • vracia objekt / skupina

getSubscriber(header, subscriber id)

  • vracia objekt / adresát

addSubscriber(header, group id, data)

  • vracia objekt / adresát

updateSubscriber(header, subscriber id, data)

  • vracia objekt / adresát

addSubscriberToGroup(header, subscriber id/email, group id)

  • vracia true / false

removeSubscriberFromGroup(header, subscriber id/email, group id)

  • vracia true / false

getNewsletters(header)

  • vracia pole objektov / letákov

getNewsletter(header, newsletter id)

  • vracia objekt / leták

addNewsletter(header, data)

  • vracia objekt / leták

updateNewsletter(header, newsletter id, data)

  • vracia objekt / leták

sendNewsletter(header, newsletter id)

  • pridá leták do fronty na odoslanie, leták sa začne posielať do 30 minút, ako pri naplánovaní odoslania (schedule)
  • vracia objekt, premenné: sent true / false, count number

getNewsletterSchedule(header, newsletter id)

  • vracia objekt, premenné: value unixtime

setNewsletterSchedule(header, newsletter id, data)

  • vracia objekt, premenné: value unixtime