E-pastu datu apmaiņa ar Traffic sistēmu

Vispārīga sistēmas informācija

Atkarībā no noslēgtās vienošanās starp Jums un SIA "Sales.lv", Jūsu kontam var būt vai nu mēneša kvota e-pastu sūtīšanai (pēcapmaksas līgumiem) vai arī e-pastu apjoma limits (priekšapmaksas līgumiem) atkarībā no apmaksātā apjoma. Mēneša kvotas apmērs tiek uzstādīts abpusēji vienojoties un ir paredzēts galvenokārt drošības labad, lai nejaušu (vai arī tīšu) darbību rezultātā netiktu nosūtīts pārlieku liels e-pastu daudzums.

API informācija

Visi dati jāpadod HTTP POST pieprasījumos. Pamatadrese, uz kuru notiek datu padošana, ir https://traffic.sales.lv/API:1.0/, taču atkarībā no nepieciešamās darbības, adresei tiek pievienots komandas nosaukums. Pilnā adrese ir norādīta arī katras komandas aprakstā.

E-pasta nosūtīšana

Adrese, uz kuru jāveic pieprasījums:
https://traffic.sales.lv/API:1.0/Email/Send/

Parametri:

APIKey (string): jums piešķirtā API atslēga
From (string): sūtītāja adreses kods (tas tiek izveidots, kad mūsu sistēmā jūs pievienojat jaunu sūtītāja adresi). Šis kods tiek izmantots, lai nebūtu nepieciešams atsevišķi norādīt gan sūtītāja vārdu, gan adresi, kā arī lai atvieglotu nosūtīto vēstuļu uzskaiti.
To (string/JSON array): vai nu viena saņēmēja adrese (string), vai arī masīvs ar vairākām adresēm JSON formātā. Vēlams vienā pieprasījumā padot līdz 1000 adresēm.
Subject (string): Subject teksts
Content (JSON object): JSON objekts ar diviem parametriem:
HTML (string): HTML versijas saturs
Plain (string): Teksta versijas saturs

Ja kāda no satura versijām nav norādīta, tā tiks izveidota automātiski, t.i., ja HTML versija netiek padota (parametrs Content -> HTML), tad tā tiek automātiski izveidota no teksta versijas, un otrādi.

Lai e-pasta saturā ievietotu atteikšanās saiti, ko automātiski apstrādātu mūsu sistēma, to nepieciešams norādīt šādi: “[unsubscribe]” (bez pēdiņām). Tā tiks aizvietota ar katram saņēmējam unikālu saiti, kas viņu pievienos pie atteikušos lietotāju saraksta un šiem lietotāji vairs vēstules no mūsu sistēmas nevarēs nosūtīt. Kļūdu gadījumos, protams, ir iespējams viņus no šī saraksta arī izņemt.

Atbildes tekstā tiek padots e-pastu izsūtīšanas identifikators - tas attiecas uz visu šo epastu izsūtīšanu kopumā. Piemēram, ja vienā API izsaukumā padosiet e-pastu ar 50 adresātiem, saņemsiet vienu skaitli, kas identificēs e-pastu izsūtīšanu visām 50 adresēm kopā, bet katrā nākamajā izsaukumā izsūtīšanas identifikators jau būs cits.

Atskaites par e-pastu atvēršanu, klikšķiem, u.c.

Brīdī, kad nosūtītā e-pasta vēstule tiek atvērta, tiek klikšķināts uz kādas no tajā esošajām saitēm, lietotājs atsakās no turpmākas e-pastu saņemšanas vai arī, ja vēstule tiek atgriezta atpakaļ, šie notikumi tiek apstrādāti mūsu sistēmā un, ja nepieciešams, ir iespējams tos nodot arī tālāk jūsu sistēmai.

No jūsu puses tam nepieciešams uzzināt adresi, uz kuru padot datus (dati tiek padoti HTTP pieprasījuma veidā, tāpēc tai jābūt HTTP vai HTTPS adresei), kā arī, ja jūsu pusē tiek realizēti kādi ierobežojumi attiecībā uz to, no kādām IP adresēm tiek pieņemti dati, ielūkojieties rakstā Mūsu IP adreses.

Atskaites uz jūsu norādīto adresi tiek padotas kā HTTP POST pieprasījumi ar šādiem parametriem:

Address (string): E-pasta adrese, uz kuru šī informācija attiecas.
Batch (int): E-pastu izsūtīšanas identifikators, kas tiek atgriezts pēc e-pasta padošanas mums (sk. iepriekš).
Event (string): Par kādu notikumu ir šis paziņojums - iespējamie varianti:
- Open: saņēmējs ir atvēris e-pasta vēstuli. Šo notikumu iespējams fiksēt tikai tad, ja saņēmējs ir atļāvis attēlu parādīšanu vēstulē, un ja viņš apskata vēstules pilno (HTML) versiju. Tas nozīmē to, ka reāli atvērto vēstuļu skaits būs lielāks.
- Click: saņēmējs atvēris vēstuli un ir uzklikšķinājis uz kādas saites e-pasta saturā. Šajā gadījumā attiecīgās saites adrese tiek padota papildus parametrā URL.
- Dropped: Vēstuli nav iespējams piegādāt (adrese uz kuru e-pasts tiek sūtīts, jau iepriekš ir bijusi atgriezta)
- Deferred: Vēstules piegāde atlikta. Parasti tā notiek, ja saņēmēja e-pasta serveris nevar uzreiz pieņemt vēstuli un/vai pieprasa to nosūtīt vēlāk.
- Bounce: Vēstule ir atgriezta atpakaļ, to nav bijis iespējams piegādāt (kļūdaina adrese, neeksistējošs lietotājs, utt.)
- Spam: Saņēmējs vēstuli ir atzīmējis kā spamu. (Lielākā daļa e-pastu serveru šādus paziņojumus nesūta, tā kā reālais skaits šādu vēstuļu var būt lielāks).
URL (string): Ja šis paziņojums ir par klikšķi e-pastā, tad šis parametrs satur klikšķināto adresi.
Reason (string): Ja šis paziņojums ir par atgrieztu vēstuli, tad šis parametrs satur tekstu no atgrieztās vēstules par atgriešanas iemeslu.

Atjaunināts: 22/06/2021