Technická podpora


Mailocator API

Rozhraní API je přístupné pouze ve verzi Mailocator Pro a v partnerských programech



K čemu je Mailocator API určeno?

Rozhraní je primárně určeno pro zakládání startovacích kampaní v affiliate programu.

Cílem API je snadná integrace Mailocatoru do aplikací třetích stran tak, aby mohly lépe a snadno propojit svou aplikaci s Mailocatorem - například automatizovat zakládání kampaní ve freemium režimu.







Popis rozhraní

Rozhraní poskytuje možnost vytvářet, řídit a ukončovat kampaně
Rozhraní je založeno na standardu JSON
Všechny odeslané hodnoty musí být zakódovány algoritmem Base64
K úspěšnému dokončení každého volání je třeba použít přidělený API klíč
Volání je možné pouze z uživatelem definované IP adresy














Adresa rozhraní

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



Příklad volání

{
  mode: 'test',
  apiKey: 'XFG8-JUj4557m-7875478a',
  espID: '123abcd#esp'
}





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


Odpověď serveru po úspěšném volání

{
  status: '1',
  statusText: 'Campaign exists',
  espID: '123abcd#esp',
  ...
}










Odpověď serveru po neúspěšném volání

{
  status: '0',
  statusText: 'API key is invalid or IP address not allowed',
  espID: '123abcd#esp',
  ...
}










Povinné parametry každého volání

Mailocator API vyžaduje následující 3 parametry v každém volání:


mode

Parametr určuje, zda jde o testovací volání nebo volání v reálném provozu.
Testovací volání vyžaduje platný API klíč, neověřuje se IP adresa a vrácená data jsou pouze ilustrativní pro účely ladění.

Přípustné hodnoty:
test - jde o testovací provoz
real - jde o ostrý provoz



apiKey

API klíč si můžete vygenerovat v aplikaci Mailocator API, pokud je vaše verze Mailocatoru ve verzi Pro, případně pokud máte jiným způsobem tuto aplikaci dostupnou. Každý klíč lze použít pouze pro volání z jedné uživatelsky definované IP adresy.

Přípustné hodnoty:
Platný API klíč, alfanumerické znaky



espID

Váš identifikátor kampaně Mailocatoru.
Identifikátor může být jakýkoliv unikátní alfanumerický řetězec nebo číslo sestavené na straně klienta, které identifikuje kampaň, která byla prostřednictvím API vytvořena. Na straně klienta tak není třeba vytvářet další strukturu pro indexaci založených kampaní, ale lze použít existující vlastní v daném systému - například GUID, hash, ID, emailovou adresu a pod.

Přípustné hodnoty:
alfanumerické znaky, znaky [. _- @ #] nebo celé číslo