API

Veřejný rozcestník integrace.

API běží samostatně na api.ezakaznik.cz. Pokrývá účtenky, věrnostní programy, kredit a platby, EET, souhlasy a SPZ. Pro vyzkoušení je k dispozici integrátorský portál s POS simulátorem.

Veřejně

Popis scénářů, slovník pojmů, základní endpointy, ukázky requestů a odpovědí.

Po registraci integrátora

Sandbox, API klíče, testovací obchodník, logy volání a technická podpora.

První scénáře API

API má vracet výsledek konkrétní situace.

Nechceme nutit zákazníka chápat techniku. Systém má vědět, jestli výsledkem má být účtenka, karta, založení profilu, souhlas, platba, parkovací oprávnění nebo jiná akce.

POI kontext

Kód určí obchodníka, provozovnu, místo a typ interakce.

Účtenka / karta

Výsledek může být elektronická účtenka, použití existující karty nebo vytvoření nové.

Souhlas a preference

Srozumitelný souhlas, preferovaná účtenka, platba nebo komunikace jen tam, kde dává smysl.

Oblasti API

POI

Identifikace místa a typu interakce.

Účtenky

Vystavení, archivace a dohledání.

Věrnost

Razítková karta, body, obrat a kredit (přes platební metody) — vždy podle zvoleného typu programu.

Souhlasy

Účel, rozsah, platnost a odvolání.

Vozidla / SPZ

Parkování, oprávnění a platby.

Platby

Virtuální platební automat a open-banking scénáře.