Jednoduché API aneb synchronizujeme kontakty

Jak je známo, emailkampane.cz disponují komplexním API rozhraním pro integraci různých online služeb a systémů třetích stran. Díky komplexnímu API je možno plně ovládat účet klienta, spravovat kontakty v adresáři, vytvářet kampaně, stahovat si statistiky aj.

Z důvodu zjednodušení implementace nejvyužívanějších příkazů jsme kromě komplexního API rozhraní pro klienty připravili i jednoduché API.

Jednoduché API Vám pomocí zabezpečených URL dotazů umožňuje snadno přidávat a odebírat kontakty do/z vybraných Kontakt listů pod Vaším účtem. Kontakty je možné vkládat vč. libovolného množství atributů. API naleznete v sekci Kontakty => API rozhraní, kde příkaz snadno vygenerujete (včetně identifikátorů).

Kdy jednoduché API využiji?

Mezi nejčastější příklady využití jednoduchého API patří:

  • Přidání kontaktu po dokončení objednávky v e-shopu
  • Přidání kontaktu a údajů o obsahu košíku při opuštění nákupního košíku v e-shopu
  • Přidání kontaktu po vyplnění poptávkového formuláře na webu
  • Přidání kontaktu po uložení do firemního CRM
  • Odebrání kontaktu po odhlášení obchodních sdělení na webu
  • a další…

Na výše uvedené události bývají zpravidla navázány automatické kampaně reagující na událost přidání kontaktu (např. zaslání slevového kupónu, emailový seriál s představením společnosti, email s hodnocením přístupu obchodníka aj.)

Příklad API příkazu pro přidání kontaktu*

https://www.emailkampane.cz/action/api.php?action=add_contact&us_guid=K31MS7W0-LE3A-NA02-6DH7-82ASW8X81MQ&cm_guid=kd7ms02gx8p1al73b&cl_guid=KFT98DL52M1O83DS9&email=EMAIL&jmeno=JMENO&prijmeni=PRIJMENI

* Zvýrazněné části textu pouze nahradíte hodnotami, které se mají vkládat.

Příklad API příkazu pro odebrání kontaktu**

https://www.emailkampane.cz/action/api.php?action=remove_contact&us_guid=K31MS7W0-LE3A-NA02-6DH7-82ASW8X81MQ&cm_guid=kd7ms02gx8p1al73b&cl_guid=KFT98DL52M1O83DS9&email=EMAIL

** V příkazu pouze nahradíte zvýrazněný text EMAIL e-mailovou adresou kontaktu, který má být odebrán.

Volitelné atributy API dotazu pro přidání kontaktu

Parametr Popis Příklad
jmeno Křestní jméno jmeno=Milan
prijmeni Příjmení prijmeni=Novák
pohlavi Pohlaví osoby (muž/žena/neznámé).
Nabývá hodnot m/f/0
pohlavi=m
"Volitelný atribut" Lze použít libovolné volitelné atributy kontaktu telefon=00420777123456
keep-status Zachovává stav kontaktu v kontakt listu.
Hodnota 0 přepíše stav kontaktu, hodnota 1 jej zachová.
keep-status=1

Data jsou vždy zasílána v kódování typu UTF-8. V případě požadavku na jiné kódování nebo s dotazem ohledně API nás kontaktujte.

Menu