(API – inglise keeles Application Programming Interface)


API abil on võimalik Smaily võimalusi laiendada, seda teiste rakendustega andmevahetuseks siduda või teatud tegevusi automatiseerida.

Postitamine võib toimuda kolmel viisil:

  • opt-in – andmete import ühe kontakti kaupa – sobib nt vormi andmete postitamiseks, info uuendamiseks ühe kontakti kaupa jne. Tulemusena saadab automaatvastaja poolt määratud kirja lisatavale / uuendatavale aadressile. Tavaline liitumisvorm töötab selle abil.
  • multi-opt-in – mitme kontakti korraga uuendamine. Soovitavalt mitte rohkem kui 10 000-te pakkide kaupa. Saadab samamoodi kinnituskirja.
  • import – uuendab ainult kontakte, ilma automaatvastajat käivitamata. Vajab (hetkel veel) siiski ka automaatvastaja olemasolu.


Meetod

URL – https://<domeen>.sendsmaily.net/api/<viis>

Tavaline HTTP POST päring.


Süsteemsed parameetrid

key – kontoga seotud liidestusvõti (API key).

autoresponder – eelnevalt seadistatud automaatvastaja (automaatvastaja ID – numbriline väärtus).

remote – vastuse saatmise formaat (vaata altpoolt) (võimalikud väärtused – 0 või 1; 0 = ei, 1 = jah).

* rasvase tekstiga märgitud väljad on kohustuslikud.


Info parameetrid

email – e-posti aadress (API kontrollib emaili valideerumist).

* email väli on kohustuslik.

NB! võimalik on juurde lisada oma tekstilises vormingus andmeid, nt. name, age, jne. Juhul, kui välju andmebaasis ei eksisteeri, tekitatakse need automaatselt. Väljad ei tohi alata numbriga, ega sisaldada muid märke peale alakriipsu (_). Vastasel juhul need kaotatakse automaatselt.


Serverist tulevad vastused

101 – OK (päring õnnestus, kirjad saatmisjärjekorda lisatud).

201 – Data must be posted with POST method (andmed on saadetud millegi muu, kui HTTP POST meetodiga).

202 – Invalid or deprecated API key (liidestusvõtit on muudetud või ei ole see selle kasutajakonto oma).

203 – No data recieved (andmed on valesti struktuureeritud või ei saadetud midagi).

205 – No autoresponder data set (automaatvastaja ei eksisteeri või on valesti seadistatud).



Näidispäring


Postitatud andmed:

key=XDcsks...3sz&remote=1&0[email]=email@address.ee&0[name]=e-posti aadress&1[email]=email2@address.ee


Infoks, PHP-s andmete struktuur:

array('key' => 'XDcsks...3sz', 'remote' => 1, array('email' => 'email@address.ee', 'name' => 'e-posti aadress'), array('email' => 'email2@address.ee'))


Vastus


Juhul, kui on seadistatud remote = 1 parameeter, siis antakse vastus JSON-i formaadis:

{"code":101,"message":"OK"}



Kui soovid kasutada rohkem võimalusi, vaata kogu meie API dokumentatsiooni: Rakendusliides (API).