Technická podpora


API: Create

Vytvoření kampaně

Toto volání založí kampaň, která bude po úspěšném vytvoření k dispozici pod interním označením předeným v unikátním identifikátoru espID.
Identifikátor espID si navrhujete sami a musí být složeno z celého čísla nebo alfanumerických znaků rozšířených o znaky [@ . _ - #]

Pro všechna další volání bude třeba znát espID, které je v praxi odvozené od vaší vlastní identifikace klienta - ID, GUID, e-mailová adresa atd.

Identifikátor espID je na straně Mailocatoru neveřejný a nelze jej nikde zobrazit.

Nově založená kampaň má nastaven výchozí obsah a není aktivní, aktivaci je třeba po úspěšném založení provést voláním metody update.






Adresa požadavku

https://api.mailocator.com/1.0/create/



Příklad požadavku

{
  mode: 'test',
  apiKey: 'XFG8-JUj4557m-7875478a',
  espID: '123abcd#esp',
  hostname: 'domain.org',
  email: 'name[at]domain.org'
}





Hodnoty je třeba před odesláním zakódovat algoritmem Base64.




Seznam požadovaných hodnot

Doplňující povinné hodnoty při požadavku na vytvoření kampaně

hostname
Text
Platný název domény, ve které bude kampaň umístěna (bez www)


email
Email address
E-mailová adresa klienta pro zaslání notifikací







Seznam vrácených hodnot

Vrácené hodnoty po úspěšném požadavku

status
1 | 0
vrací 1, pokud je volání úspěšné a kampaň byla vytvořena


statusText
Text
Komentář k výsledku, popis chyby