Sistemski API

Sistemski API je namenjen celostni povezavi vaše aplikacije z aplikacijo SqualoMail.

Osnovni principi

 

Operacije, ki so vam na voljo

Vse naštete metode zahtevajo, da vedno pošljete tudi api_user in api_key! Tega v nadaljevanju ne bomo več poudarjali. Operacije, ki so vam na voljo:

  1. create-list
  2. get-lists
  3. create-newsletter
  4. create-newsletter-from-template
  5. create-recipient
  6. delete-newsletter
  7. delete-recipient
  8. get-data
  9. get-invalid-recipients
  10. get-subscribed-recipients
  11. get-unsubscribed-recipients
  12. send-newsletterr
  13. update-newsletter
  14. update-recipient

 

1. create-list

Metoda pošiljanja: POST

S to metodo lahko ustvarite nov seznam prejemnikov za pošiljanje. Metoda sprejema naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • listName – ime seznama
  • description – opis seznama
  • listTag – oznaka/kategorija seznama
  • color – barva seznama v hex
  • ordering – vrstni red seznama kot bo prikazan v aplikaciji – od 0 do 2147483647
  • published – ali je lista objavljena (boolean)

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"listName":"String content",
	"description":"String content",
	"listTag":"String content",
	"color":"String content",
	"ordering":2147483647,
	"published":true,
}

2. get-lists

Metoda pošiljanja: POST

S to metodo lahko pridobite vse podatke o seznamih prejemnikov, ki so na voljo v sistemu SqualoMail. Metoda sprejema naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • listIds – ID številke seznamov – ta parameter je opcijski, v kolikor boste vrednost izpustili oz. pustili prazno, bo sistem zajel vse ID številke
  • listNames – imena seznamov – ta parameter je opcijski, v kolikor boste vrednost izpustili oz. pustili prazno, bo sistem zajel vsa imena seznamov
  • listTags – oznake/kategorije seznamov – ta parameter je opcijski, v kolikor boste vrednost izpustili oz. pustili prazno, bo sistem zajel vse oznake/kategorije seznamov

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"listIds":[1, 2, 3],
        "listNames":["Ime1", "Ime2", "Ime3"],
        "listTags":["Slovenija", "Italija", "Hrvaška"],
}


3. create-newsletter

Metoda pošiljanja: POST

S to metodo lahko ustvarite nov newsletter in določite na katere sezname se bo poslal. Metoda sprejema naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • subject – Zadeva (Subject) newsletterja
  • body – besedilo newsletterja
  • altBody – tekstovna verzija vsebine newsletterja
  • fromEmail – email naslov pošiljatelja (opcijsko, sicer se nastavi privzeti)
  • fromName – ime pošiljatelja, kot ga vidi prejemnik (opcijsko, sicer se nastavi privzeti)
  • replyToEmail – email naslov za dogovor (opcijsko, sicer se nastavi privzeti)
  • replyToName – ime naslovnika za odgovor, kot ga vidi prejemnik (opcijsko, sicer se nastavi privzeti)
  • language – jezik newsletterja. Izbirate lahko med de, en, es, fr, hr, it in sl (opcijsko, privzeti je sl (slovensko))
  • listIds – ID številke seznamov, na katere so bo newsletter poslal (pošlje se kasneje, z drugo metodo). Primer fromata je sledeč: [4,6]. ID seznama najdete po teh navodilih.
  • published – datum objave (ne pošiljanja!). Datum je v UNIX Timestamp formatu (opcijsko)
  • visible – Ali je newsletter viden prejemnikom (se lahko nanj prijavijo/odjavijo sami). Možne vrednosti true ali false.

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"altBody":"String content",
	"body":"String content",
	"fromEmail":"String content",
	"fromName":"String content",
	"language":"String content",
	"listIds":[2147483647],
	"published":2147483647,
	"replyToEmail":"String content",
	"replyToName":"String content",
	"subject":"String content",
	"visible":true
}

 

4. create-newsletter-from-template

Metoda pošiljanja: POST

S to metodo lahko ustvarite nov newsletter na podlagi že obstoječega. Predloga za newsletter je lahko katerikoli že obstoječi newsletter.

Na voljo so vam sledeči  parametri:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • subject – Zadeva (Subject) newsletterja
  • fromEmail – email naslov pošiljatelja (opcijsko, sicer se nastavi privzeti)
  • fromName – ime pošiljatelja, kot ga vidi prejemnik (opcijsko, sicer se nastavi privzeti)
  • replyToEmail – email naslov za odgovor (opcijsko, sicer se nastavi privzeti)
  • replyToName – ime naslovnika za odgovor, kot ga vidi prejemnik (opcijsko, sicer se nastavi privzeti)
  • language – jezik odjavne strani newsletterja. Izbirate lahko med de, en, es, fr, hr, it in sl (opcijsko, privzeti je sl (slovensko))
  • listIds – ID številke seznamov, na katere bo newsletter poslan (pošlje se kasneje, z drugo metodo). Primer fromata je sledeč: [4,6]. ID številke seznamov najdete po teh navodilih.
  • templateId – ID številka že obstoječega newsletterja, ki se bo uporabil kot osnova za izdelavo novega
  • templateCustomAttributes – Atributi po meri, ki se vstavijo v telo (body) obstoječega newsletterja oziroma predloge iz katere se ustvarja novi newsletter

TemplateCustomAtrributes

Ta sklop parametrov vam omogoča, da v sistemu SqualoMail vnaprej pripravite predlogo in vanjo vstavite posebno oznako (template tag), ki se potem ob klicu te funcije zamenja s konkretno vrednostjo.

Scenarij, ko je ta funkcionalnost uporabna je, da si želite uporabiti SqualoMail Drag&Drop urejevalnik za pripravo oblike newsletterjev, vnos same vsebine pa želite avtomatizirati.

Template tag se označuje z dvakratnimi zavitimi oklepaji – {{template_tag}}. Na voljo sta dva osnovna template tag-a:

  1. texts – S pomočjo tega lahko na označeno mesto vstavite poljuben tekst ali HTML.
  2. images – S pomočjo tega lahko označene slike v predlogi zamenjate z željenimi slikami končnega newsletterja

Texts

Tekste definirate kot tabelo (array) poljubnih identifikatorjev (na primer: heading, subheading, ipd.) in vrednosti, ki se bodo vstavile. Imena identifikatorjev so poljubna – pomembno je le, da ste konsistentni pri oblikovaju osnovne predloge in potem pri klicu te funkcije.

Primer:

V Drag&Drop urejevalnik vstavite sledeče oblikovano besedilo:

Po klicu funkcije s sledečimi parametri:

{
    ...
	"templateCustomAttributes":
	{"texts":
        [
            {
                "itemId":"column1-heading",
                "itemContent":
                {
                    "value":"NEW items for better zzzzzzs"
                }
            },
            {
                "itemId":"column1-subheading",
                "itemContent":
                {
                    "url":"http://www.google.com",
                    "value":"Everybody deserves a good night sleep :)"
                }
            },
			{
                "itemId":"column1-text",
                "itemContent":
                {
                    "value":"Fusce at tristique urna, sit amet elementum odio.	Nullam vulputate at felis ut eleifend. Pellentesque euismod libero diam, viverra placerat risus vestibulum non. Praesent at rutrum odio. Quisque vel suscipit sem."
                }
            }
        ]
    }
}

pa dobimo:

Tukaj velja posebej poudariti, da v kolikor želite stilizirati povezave, tega ni mogoče narediti v Drag&Drop urejevalniku, ampak morate to storiti tako, da ne dodate parametra “url”, ampak da sami dodate <a style=”…

Images

S template atributom “images” lahko na označena mesta v osnovni predlogi vstavite slike iz URL-ja.

Slike v Drag&Drop urejevalniku “označite” tako, da za sliko izberete sliko iz /images/SqualoMail-templates/_placeholders/.

Znotraj te mape se nahaja deset podmap označenih z 0 do 9. Te številke predstavljajo ID številko slike, kar pomeni, da vsaka od teh številk prestavlja eno sliko v predlogi. To pomeni, da morate za vsako označeno mesto izbrati sliko iz druge podmape.

V vsaki podmapi vam je na voljo več velikosti slik, ki se ločijo po razmerju stranic (aspect ratio). Izbrati morate tako sliko, ki ima za vas primerno razmerje stranic, potem pa po običajnem postopku prilagodite njeno velikost z drsnikom v Drag&Drop urejevalniku.

Velikost slike, ki jo boste vstavili tako ni pomembna, saj se bo njena velikost spremenila na tisto, kar ste nastavili z drsnikom. Je pa zelo pomembno, da vstavljate slike s pravilnim razmerjem stranic, saj bodo sicer le-te razpotegnjene.

Sliki lahko dodate še povezavo s parametrom “url”.

Primer:

1. Predloga

2. Klic funkcije s sledečimi parametri:

"templateCustomAttributes":
{
    "images":
    {
        [
            {
                "itemId":"0",
                "itemContent":
                {
                    "url":"https://www.google.com",
                    "value":"https://11.squalomail.net/images/image-3-column-placement-1-5x4.png"
                }
            },
            {
                "itemId":"1",
                "itemContent":
                {
                    "url":"https://www.yahoo.com",
                    "value":"https://11.squalomail.net/images/image-3-column-placement-2-5x4.png"
                }
            },
            {
                "itemId":"2",
                "itemContent":
                {
                    "url":"https://www.apple.com",
                    "value":"https://11.squalomail.net/images/image-3-column-placement-3-5x4.png"
                }
            }
        ]
    }
}

3. Rezultat:

 

Primer vseh možnosti, ki jih ponuja funkcija:

"apiKey":"String content",
"apiUser":"String content",
"fromEmail":"String content",
"fromName":"String content",
"language":"String content",
"listIds":[2147483647],
"published":true,
"replyToEmail":"String content",
"replyToName":"String content",
"subject":"String content",
"visible":true,
"templateId":2147483647,
"templateCustomAttributes":
{
    "images":
    [
        {
            "itemId":"String content", "itemContent":
            {
                "url":"String content",
                "value":"String content"
            }
        }
    ],
    "texts":
    [
        {
            "itemId":"String content",
            "itemContent":
            {
                "url":"String content",
                "value":"String content"
            }
        }
    ]
}

 

5. create-recipient

Metoda pošiljanja: POST

S to metodo lahko ustvarite novega prejemnika in ga hkrati dodate na nič ali več seznamov. Metoda sprejema naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • email – email naslov prejemnika
  • name – ime prejemnika
  • surname – priimek prejemnika
  • gender – spol prejemnika
  • listIds – ID številke seznamov, na katere bo prejemnik prijavljen. Primer formata je sledeč: [4,6]. ID seznama najdete po teh navodilih.
  • html – Ali prejemnik sprejema sporočila v HTML obliki ali samo v tekstovni.
  • confirmed – Ali se prejemnik strinja s prejemanjem sporočil (sporočila bodo poslana ne glede na to)
  • enabled – Ali je prejemnik omogočen (onemogočeni prejemniki ne obstajajo)
  • accept – Ali prejemnik sprejema sporočila
  • gdpr_can_send – GDPR soglasje za pošiljanje
  • gdpr_can_track – GDPR soglasje za profiliranje
  • customAttributes – seznam parov [ključ, vrednost] (key, value) za prejemnikova polja po meri. Za ime atributa uporabite polje “sistemsko ime”, ki vam je na voljo preko grafičnega uporabniškega vmesnika.

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"accept":true,
	"confirmed":true,
	"customAttributes":[
		{
		"name":"firstname",
		"value":"John"
		},
		{
		"name":"lastname",
		"value":"Smith"
		}
	],
	"email":"String content",
	"enabled":true,
	"html":true,
	"listIds":[2147483647],
	"name":"String content"
        "surname":"String content"
        "gender":null|"male"|"female"|"other"
        "gdpr_can_send":true
        "gdpr_can_track":true
}

 

6. delete-newsletter

Metoda pošiljanja: GET

S to metodo lahko izbrišete newsletter. Metoda sprejema sledeče parametere:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • newsletterId – ID številka newsletterja, ki ga želite izbrisati

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"newsletterId":2147483647,
}

 

7. delete-recipient

Metoda pošiljanja: GET

S to metodo lahko izbrišete prejemnika. Metoda sprejema samo en parameter:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • recipientId – ID številka prejemnika, ki ga želite izbrisati

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"recipientId":2147483647,
}

 

8. get-data

Metoda pošiljanja: GET ali POST

S to metodo lahko pridobite vse podatke, ki so na voljo v sistemu SqualoMail. Metoda sprejema naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • entity – navedete entiteto, ki definira tip elementa, ki ga želite pridobiti. Na voljo so vam entitete Field, History, List, ListMail, ListSub, Mail, Recipient, Stats, Url, UrlClick, UserStats. Podrobnejši opisi so spodaj.
  • filter – s tem parametrom definirate katere entitete (na podlagi atributov), želite pridobiti.

Primer:

http://api.squalomail.com/get-data?apiUser={APIUSER}&apiKey={APIKEY}&entity=Subscriber&filter=email.Endswith(%22gmail.com%22)

 

V nadaljevanju bomo predstavili, katere entitete so na voljo, katere atribute imajo in katere filtre lahko uporabljate.

 

ENTITETE IN ATRIBUTI

Tukaj so naštete vse entitete in njihovi atributi, ki jih lahko uporabljate, ko sestavljate filter za metodo get-data.

Field

Ta entiteta predstavlja SqualoMail prejemnikove atribute po meri (kot so poimenovani v GUI-ju). Ta entiteta podipra naslednje atribute:

  • fieldid – ID številka atributa po meri
  • fieldname – oznaka atributa (lepo ime za uporabnike)
  • namekey – ime atributa (sistemsko, brez presledkov)
  • type – tip je lahko text, checkbox, radio ali textarea
  • value – privzeta vrednost atributa po meri
  • published – ali je atribut na voljo za uporabo
  • ordering – vrstni red v primerjavi z ostalimi – naravno število

History

Entitete tega tipa so dogodki, ki so jih naredili prejemniki v sistemu SqualoMail. Primeri so npr. klik na povezavo, odprt email, odjava, dodajanje na seznam, ipd. Parametri, ki so vam na voljo, so sledeči:

  • subid – ID številka prejemnika
  • date – datum, ko se je dogodek zgodil v UNIX Timestamp formatu
  • action – akcija, ki se je zgodila

List

Entiteta list predstavlja Seznam. Na voljo ima naslednje atribute:

  • listIds – ID številka seznama
  • listNames – ime seznama
  • listTags – ime oznake/kategorije seznama
  • color – barva v GUI-ju
  • visible – ali je seznam viden prejemnikom
  • alias – Vrednost Google analytics utm_campaign parametera

Mail

Ta entiteta predstavlja newsletter. Na voljo so naslednji atributi:

  • mailid – ID številka newsletterja
  • subject – zadeva (subject) newsletterja
  • body – vsebina newsletterja
  • altbody – tekstovna verzija vsebine
  • published – “0” pomeni, da ni objavljen, “1”, da je objavljen (viden prejemikom), “2”, da je v vrsti za pošiljanje
  • senddate – datum pošiljanja v UNIX Timestamp formatu
  • created – datum, ko je bil newsletter ustvarjen v UNIX Timestamp formatu
  • fromemail – email naslov pošiljatelja. Če je prazen je bil uporabljen privzeti.
  • fromname – ime pošiljatelja. Če je prazno je bil uporabljen privzeti.
  • replytoemail – email naslov za odgovor. Če je prazen je bil uporabljen privzeti.
  • replytoname – ime za odgovor, vidno prejemniku. Če je prazen je bil uporabljen privzeti.
  • language – jezik newsletterja; lahko je eden od de, en, es, fr, hr, it ali sl.

Recipient

Ta entiteta predstavlja prejemnika. Ta metoda ne omogoča iskanja po prejemnikovih atributih po meri. Na voljo pa so sledeči atributi:

  • subid – ID številka prejemnika
  • email – email naslov prejemnika
  • name – ime prejemnika
  • enabled – ali je prejemnik omogočen (če najverjetneje ne obstaja)
  • ip – IP naslov prejemnika
  • html – ali prejemnik sprejema sporočila v HTML formatu
  • accept – ali prejemnik sprejema sporočila (se ni odjavil)
  • created – datum, ko je bil prejemnik ustvarjen v UNIX Timestamp formatu
  • confirmed – ali je prejemnik potrdil prijavo
  • confirmed_date – datum, ko je bil prejemnik potrdil prijavo v UNIX Timestamp formatu
  • lastopen_date – datum, ko je bil prejemnik nazadnje odprl kak newsletter v UNIX Timestamp formatu
  • lastclick_date – datum, ko je bil prejemnik nazadnje kliknil na kako povezavo v newletterju v UNIX Timestamp formatu
  • lastsent_date – datum, ko je bil prejemniku poslan kak newsletter v UNIX Timestamp formatu

ListMail

Povezovalna entiteta med entitetama List in Mail za realizacija many-to-many relacije. Na voljo sta sledeča atributa:

  • listIds – ID številka seznama
  • mailid – ID številka newsletterja

ListSub

Povezovalna entiteta med entitetama List in Recipient za realizacijo many-to-many relacije. Na voljo sta sledeča atributa:

  • listIds – ID številka seznama
  • subid – ID številka prejemnika
  • subdate – datum, ko se je prejemnik prijavil na seznam v UNIX Timestamp formatu
  • unsubdate – datum, ko se je prejemnik odjavil iz seznama v UNIX Timestamp formatu
  • status – “1” pomeni prijavljen, “-1” pomeni odjavljen

Stats

Entitea Stats predstavlja statistiko posameznega newsletterja. Atributi, ki so na voljo so:

  • mailid – ID številka newsletterja
  • senthtml – število poslanih sporočil v HTML formatu
  • senttext – število poslanih sporočil v tekstovnem formatu
  • senddate – datum pošiljanja v UNIX Timestamp formatu
  • openunique – število edinstvenih odprtih sporočil (če je nek prejemnik odprl sporočilo večkrat se ta akcija šteje samo enkrat)
  • opentotal – število odprtih sporočil (če je nek prejemnik večkrat odprl isto sporočilo, se to tudi večkrat šteje)
  • cliclunique – število edinstvenih klikov (če je nek prejemnik kliknil isto povezavo večkrat se ta akcija šteje samo enkrat)
  • clicktotal – število vseh klikov (če je nek prejemnik večkrat kliknil isto povezavo, se to tudi večkrat šteje)
  • bounceunique – število odbojev (hard + soft bounces)
  • fail – število neuspešno dostavljenih sporočil
  • unsub – število odjav
  • forward – število preposlanih sporočil

UserStats

Ta entiteta predstavlja statistične podatke vsakega uporabnika glede na newsletter. Na voljo so naslednji atributi:

  • subid – ID številka prejemnika
  • mailid – ID številka newsletterja
  • open – ali je prejemnik odprl newsletter
  • opendate – kdaj je prejemnik odprl newsletter
  • bounce – ali je bilo sporočilo odbito
  • fail – ali je pošiljanje sporočila spodletelo
  • browser – kateri brskalnik uporablja prejemnik (na voljo samo, če je prejemnik odprl sporočilo; npr. firefox, chorme, msie, …)
  • browser_version – verzija brskalinka (na voljo samo, če je prejemnik odprl sporočilo)
  • is_mobile – ali je prejemnik odprl sporočilo na mobilni napravi
  • mobile_os – s katerim operacijskim sistemom je prejemnik odprl sporočilo
  • user_agent – podatki o prejemnikovem brskalniku

UrlClick

Ta entiteta predstavlja prejemnikov klik na neko povezavo. Vsaka povezava ima svojo ID številko, katere vrednost je potem shranjena kot entiteta URL (opis spodaj). Atributi, ki so na voljo, so sledeči:

  • mailid – ID številka newsletterja
  • subid – ID številka prejemnika
  • urlid – ID številka povezave
  • click – številko klikov prejemnika na neko povezavo
  • date – datum, ko se je (zadnjič) zgodil klik
  • ip – IP naslov iz katerega se je (nazadnje) zgodil klik

Url

Ta entiteta predstavlja povezavo v newsletterju. Vsaka povezava v vsakem newsletterju je ločena entiteta, ne glede na to, da je mogoče cilj povezave isti. Na voljo so naslednji atributi:

  • urlid – ID številka povezave
  • name – ime povezave
  • url – cilj povezave

 

FILTRI

Filtre sestavljamo znotraj parametra filter.

Zapis

Filter sestavite tako, da vpišete ime, operator in vrednost. Za znakovne nize (string-e) morajo biti vrednosti v dvojnih narekovajih, za števila pa ne.

Primer:

email=="test@gmail.com"
created>1451606400

Operatorji

Primerjava

  • == – primerjava, če se vrednost natančno ujema
  • >=
  • <=
  • >
  • <
  • !=

Logični operatorji

Filtri so sestavljeni iz pogojev, ki so med seboj lahko povezujemo z enim od operatorjev:

  • && – logični IN
  • || – logični ALI

Primer:

created>1451606400&&created<1454284800

Funkcije

Za atribute, ki so znakovni nizi (stringi), vam je na voljo tudi več funkcij:

  • Startwith(“str”) – Vrednost se začne s str
  • Endswith(“str”) – Vrednost se konča s str

Opomba: Funkcijo neenakosti (not equals) lahko naredimo kot negacijo Equals.

Primer:

email.Endswith("gmail.com")


Negacija

Filter lahko negiramo z uporabo operatorja ! (pred imenom atributa).

Primer:

!email.Endswith('gmail.com')

Primer celotnega zahtevka

Filter je vedno potrebno URL zakodirati.

Primer:

https://api.squalomail.com/v1/get-data?apiUser=[api_user]&apiKey=[api_key]&entity=recipient&filter=created%3E1451606400%26%26created%3C1454284800

 

Opombe

Funkcija get-data ne omogoča filtriranja po prejemnikovih atributih po meri.

 

9. get-invalid-recipients

Metoda pošiljanja: GET

S to metodo dobite vse prejemnike, ki so onemogočeni. Navadno je razlog za to neveljaven ali neaktiven email naslov. Ta metoda nima nobenih posebnih parametrov razen avtentikacije:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
}

 

10. get-subscribed-recipients

Metoda pošiljanja: GET

Ta metoda vrne vse prejemnike, ki so prijavljeni na nek seznam. To ne vključuje odjavljenih prejemnikov, vključuje pa onemogočene (enabled=0). Parameteri, ki so vam na voljo so:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • listIds – ID številka seznama, za katerega želite dobiti prijavljene prejemnike

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"listIds":"2147483647"
}

 

11. get-unsubscribed-recipients

Metoda pošiljanja: GET

Ta metoda vrne vse prejemnike, ki so odjavljeni od nekega seznama. To so prejemniki, ki so se odjavili in ne prejemniki, ki niso bili nikoli naročeni na nek seznam. Rezultat vključuje tudi onemogočene prejemnike (enabled=0). Parameter, ki je na voljo, je samo eden:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • listIds – ID številka seznama, za katerega želite dobiti odjavljene prejemnike

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"listIds":"2147483647"
}

 

12. send-newsletter

Metoda pošiljanja: GET

Nastavite pošiljanje nekega newsletterja ob določenem času. Na katere sezname se bo poslal lahko nastavite ob ustvarjanju newsletterja (create-newsletter) ali pa z metodo update-newsletter. Metoda sprejme naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • newsletterId – ID številka newsletterja, ki ga želite poslati.
  • sendDate – Datum pošiljanja v UNIX Timestamp formatu.

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"newsletterId":2147483647,
	"sendDate":2147483647,
 }

 

13. update-newsletter

Metoda pošiljanja: POST

S to metodo lahko spremenite atribute nekega newsletterja. Metoda sprejema naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • id – ID številka newsletterja, kateremu želite spremeniti atribute
  • subject – Zadeva (Subject) newsletterja
  • body – besedilo newsletterja
  • altBody – tekstovna verzija vsebine newsletterja
  • fromEmail – email naslov pošiljatelja (opcijsko, sicer se nastavi privzeti)
  • fromName – ime pošiljatelja, kot ga vidi prejemnik (opcijsko, sicer se nastavi privzeti)
  • replyToEmail – email naslov za dogovor (opcijsko, sicer se nastavi privzeti)
  • replyToName – ime naslovnika za odgovor, kot ga vidi prejemnik (opcijsko, sicer se nastavi privzeti)
  • language – jezik newsletterja. Izbirate lahko med de, en, es, fr, hr, it in sl (opcijsko, privzeti je sl (slovensko))
  • listIds – ID številke seznamov, na katere so bo newsletter poslal (pošlje se kasneje, z drugo metodo). Primer fromata je sledeč: [4,6]. ID seznama najdete po teh navodilih. Vrednost se, v primeru, da je nastavljena, prepiše.
  • published – datum objave (ne pošiljanja!). Datum je v UNIX Timestamp formatu (opcijsko)
  • visible – Ali je newsletter viden prejemnikom (se lahko nanj prijavijo/odjavijo sami). Možne vrednosti true ali false.

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"id":2147483647,
	"altBody":"String content",
	"body":"String content",
	"fromEmail":"String content",
	"fromName":"String content",
	"language":"String content",
	"listIds":[2147483647],
	"published":2147483647,
	"replyToEmail":"String content",
	"replyToName":"String content",
	"subject":"String content",
	"visible":true
}

 

14. update-recipient

Metoda pošiljanja: POST

S to metodo lahko spremenite atribute nekega prejemnika. Metoda sprejema naslednje parametre:

  • apiUser – uporabniško ime za dostop do API-ja
  • apiKey – ključ za dostop do API-ja
  • id – ID številka prejemnika, kateremu želite spremeniti atribute
  • email – email naslov prejemnika
  • name – ime prejemnika
  • listIds – ID številke seznamov, na katere bo prejemnik prijavljen. Primer fromata je sledeč: [4,6]. ID seznama najdete po teh navodilih. Če je bil prejemnik prej že prijavljen na druge sezname, se bodo stare prijave pobrisale in nadomestile z novimi.
  • html – Ali prejemnik sprejema maile v HTML obliki ali samo v tekstovni.
  • confirmed – Ali se prejemnik strinja s prejemanjem pošte (sporočila bodo poslana ne glede na to)
  • enabled – Ali je prejemnik omogočen (onemogočeni prejemniki neobstajajo)
  • accept – Ali prejemnik sprejema sporočila
  • customAttributes – seznam parov [ključ, vrednost] (key, value) za prejemnikova polja po meri. Za ime atributa uporabite polje “sistemsko ime”, ki vam je na voljo preko grafičnega uporabniškega vmesnika.

Primer:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"id":2147483647,
	"accept":true,
	"confirmed":true,
	"customAttributes":[
		{
		"name":"firstname",
		"value":"John"
		},
		{
		"name":"lastname",
		"value":"Smith"
		}
	],
	"email":"String content",
	"enabled":true,
	"html":true,
	"listIds":[2147483647],
	"name":"String content"
}