Vlastní web pizzerie, objednávková aplikace na míru nebo napojení na jiný systém: všechno to potřebuje komunikovat s pokladnou. ProfiREST má veřejné REST API v2, stejné rozhraní, které používají jeho vlastní aplikace. K němu patří veřejná dokumentace v češtině i angličtině, oficiální knihovny pro deset programovacích jazyků a playground, ve kterém lze každou operaci vyzkoušet v prohlížeči. Článek shrnuje, co je nové, pro koho to je a jak se k API dostat.
Co je nové
- Veřejné API v2 na adrese api.mujprofirest.cz/v2/. Dokumentace popisuje každou operaci s ukázkami v curl a v oficiálních knihovnách.
- Knihovny (SDK) pro JavaScript, TypeScript, PHP, Javu, Kotlin, C#, Python, Swift, Dart a Go.
- Playground: každou operaci spustíte v prohlížeči nad příklady z dokumentace, nebo naostro s vlastním přístupem. Bez programování.
- Testovací přístup hned. Vývojář ho dostane po potvrzení e-mailu, bez schválení, a připojí se s ním k veřejnému ukázkovému účtu.
- Připojení přes souhlas. Aplikace se k vašemu účtu připojí tlačítkem Připojit přes Profirest a vy v administraci povolíte, co smí. Heslo aplikaci nedáváte.
- Události živě. Proud změn po stránkách nebo živě přes Server-Sent Events, stejné události doručují i webhooky.
Co API umí
| Oblast | Co v ní aplikace najde |
|---|---|
| Objednávky | Kalkulace košíku a odeslání objednávky do kuchyně, potvrzení online platby, storno a stav objednávky. |
| Sortiment a ceny | Kategorie, produkty a ceny provozovny, zbývající porce, akce a slevové kódy, denní menu. |
| Provozovny a přehledy | Otevírací doba, rozvozové zóny a časy, na které lze objednat. Účetní export pro Pohodu a Money, uzávěrky, souhrn tržeb, prodej položek, spropitné, DPH podle sazeb, prodejní doklady a pokladní kniha. |
| Zákazníci | Propojení zákazníků aplikace s vaší databází klientů, ověření telefonu, věrnostní body a ověření dárkového voucheru. |
| Události | Změny objednávek a dalších dat živě nebo přes webhooky. |
| Vlastní ID | Vlastní identifikátory a metadata u provozoven, kategorií, produktů, objednávek a zákazníků. |
Další oblasti se týkají zařízení ProfiRESTu: pokladny a účtenek, kuchyňského displeje, rozvozu a kurýrů, docházky, inventury nebo objednávání od stolu. Kdo je smí používat, popisuje dokumentace.
Pro koho to je
Pro provozovny, které mají nebo chtějí vlastní web či aplikaci a nechtějí přepisovat objednávky ručně, a pro vývojáře a agentury, kteří jim je programují. Typické použití je vlastní e-shop, jehož objednávky chodí do stejné kuchyňské fronty jako objednávky z pokladny. Aplikace, ve kterých objednávají zákazníci sami, se řídí otevírací dobou, rozvozovými zónami a pravidly pro objednávky na čas a potřebují licenci s webem, tedy tarif Profi. Aplikace pro personál, třeba pokladna nebo kuchyně, objednávají kdykoli.
Jak se k API dostat
- Vývojář si projde dokumentaci na api.mujprofirest.cz/v2/docs: referenční popis operací, návody s celými scénáři, changelog a strojově čitelnou specifikaci OpenAPI.
- Vyzkouší si to. S testovacím přístupem, který dostane po potvrzení e-mailu, pracuje nad veřejným ukázkovým účtem a operace pouští v playgroundu.
- Požádá o ostrý přístup na vývojářském portálu formulářem Žádost o přístup. Žádost schvaluje ProfiREST.
- Vy aplikaci připojíte. V aplikaci kliknete na Připojit přes Profirest, v administraci zkontrolujete oprávnění, zaškrtnete provozovny a potvrdíte Povolit přístup. Žádost platí 15 minut a povolit ji smí jen majitel.
Aplikace s testovacím přístupem se k vám nepřipojí
Dokud má aplikace jen testovací přístup, připojí se jen k veřejnému ukázkovému účtu. U vás stránka místo formuláře napíše, že ji nelze připojit. K vašim provozovnám ji připojíte, až její vývojář dostane ostrý přístup.
Co máte pod kontrolou
Připojené aplikace najdete v administraci v Integrace › Připojené aplikace; stránku vidí jen majitel. Každá aplikace má kartu s provozovnami, které vidí, a s oprávněními, která jste jí dali. Provozovnu můžete kdykoli přidat nebo odebrat, oprávnění odškrtnout. U aplikací, které posílají objednávky, vyberete, jestli zákazníkům píše o objednávce sama aplikace, nebo jim ProfiREST pošle SMS z vašeho kreditu. Zrušením připojení aplikace hned ztratí přístup; objednávky, které už poslala, zůstanou.
Pravidla pro objednávky z aplikací zákazníků nastavíte v Nastavení › Objednávky z aplikací: příjem lze pozastavit, třeba když kuchyně nestíhá, zvlášť vypnout rozvoz nebo osobní odběr a určit, jak daleko dopředu lze objednávat. Otevírací doba platí vždy.
Starší napojení přístupovým klíčem provozovny (Webové API v1) dál funguje. Přechod na API v2 popisuje dokumentace v oddílu Přechod z API v1.
Kde je víc
Pohled z administrace, tedy připojení, oprávnění a objednávky z aplikací, popisuje kapitola nápovědy Integrace a napojení. Přehled všech napojení je na stránce Integrace a jak API využívají rezervační partneři, ukazuje článek Rezervace přes API v2: napojení platforem, webů a aplikací. Pokud vám web nebo aplikaci programuje dodavatel, pošlete mu odkaz na dokumentaci; víc nepotřebuje, aby mohl začít.