Preskoči na glavno vsebino

Používateľské e-mailové šablóny v REST API

Tvorba a načítanie používateľských e-mailových šablón v REST API

Avtor: Petr Pech

Cez REST API (aj webové rozhranie) možno vytvoriť a získať e-mailové šablóny pre odosielanie dokladov a Aktualizáciu miezd. Táto evidencia je dostupná iba pre licenciu Premium.

Ak chceme získať šablónu, štandardne použijeme URL

/c/{firma}/sablona-mail/{id}.

Samozrejme možno použiť aj úroveň detailu.

Pre vytvorenie šablóny odošleme XML/JSON na URL /c/{firma}/sablona-mail.

Ak chceme šablónu pripojiť k typu dokladu (tu konkrétne typ vydanej faktúry), na vyššie uvedenú URL odošleme napríklad takéto XML:

<?xml version="1.0"?><winstrom version="1.0">  <typ-faktury-vydane>    <kod>{kod}</kod>    <nazev>FAV se &#x161;ablonou</nazev>    <modul>FAV</modul>    <radaPrijem>code:FAKTURA-STANDARD</radaPrijem>    <typDoklK>typDokladu.faktura</typDoklK>    <sablonaMail> {text-sablony} </sablonaMail>    <poznam>&#x160;ablona pro faktury vydan&#xE9;</poznam>  </typ-faktury-vydane></winstrom>

Príklad šablóny a Freemarker premenné

Využíva sa šablónovací systém FreeMarker.

Pred uložením šablóny program skontroluje, či šablóna neobsahuje nepovolené výrazy.

V šablónach je možné použiť nasledujúce premenné:

  • ${application} – Názov aplikácie, teda „ABRA Flexi"

  • ${user} – Objekt používateľa, s ktorým môžeme ďalej pracovať

  • ${company} – Nastavenie firmy

  • ${uzivatelJmeno} – Vaše krstné meno

  • ${uzivatelPrijmeni} – Vaše priezvisko

  • ${titulJmenoPrijmeni} – Vaše celé meno vrátane dosiahnutých titulov

  • ${nazevFirmy} – Názov firmy

  • ${object} – Všeobecný prístup k odovzdávanému objektu

  • ${doklad} – Doklad určený na odoslanie

Príklad použitia týchto premenných v šablóne

Dobrý den, zasílám Vám doklad ${doklad}, jehož interní číslo je ${doklad.kod}. Jmenuji se ${uzivatelJmeno} ${uzivatelPrijmeni}, včetně mého titulu ${titulJmenoPrijmeni}, pracuji pro ${nazevFirmy}. Mé telefonní číslo je ${user.mobil}, DIČ firmy je ${company.dic}.
Ste s tem dobili odgovor na svoje vprašanje?