FOODZI je připraven na EET 2.0 (evidence tržeb, povinná od 2027) – žádné nové pokladny, žádné starosti.Připraveni na EET 2.0 (od 2027) – bez nových pokladenPřipraveni na EET 2.0
Menu, objednávky, rezervace, zákazníci, sklad i tržby dostupné programově. FOODZI API propojí váš provoz s účetnictvím, vlastní aplikací nebo BI nástrojem. Přístup vydáváme individuálně po posouzení žádosti.
FOODZI API pracuje s provozními a osobními daty restaurací, proto k němu nevydáváme klíče automaticky. Každou žádost posuzujeme individuálně: probereme, co má integrace dělat, a vydáme klíč omezený jen na oblasti, které k tomu potřebuje. Dokumentaci s konkrétními endpointy dostanete se schválením přístupu.
Možnosti
Co lze přes FOODZI API dělat
Data jsou rozdělená do oblastí. Klíč vydáváme jen k těm, které vaše integrace opravdu potřebuje.
Menu a produkty
Kategorie, položky, ceny, dostupnost
Čtení i zápis celého jídelního lístku. Externí systém může vytvářet a upravovat kategorie a produkty, měnit ceny, přepínat dostupnost položek a udržovat varianty, přílohy a alergeny v souladu s vaším hlavním katalogem.
Načtení celého menu včetně variant a příloh
Vytvoření a úprava kategorií a produktů
Hromadná změna cen a dostupnosti
Alergeny, popisy a fotky položek
Objednávky
Příjem, stavy a historie objednávek
Nejčastěji poptávaná oblast. Umožňuje číst objednávky ze všech kanálů (web, POS, kiosek, QR u stolu), zakládat objednávky z vlastního rozhraní a měnit jejich stav stejně, jako to dělá obsluha v administraci.
Seznam a detail objednávek s filtrem podle stavu a data
Založení objednávky z externího kanálu
Změna stavu objednávky včetně odeslání do kuchyně
Položky, doprava, platba a poznámky zákazníka
Rezervace stolů
Dostupnost, vytvoření, změna stavu
Napojení rezervačního modulu na externí systém. Vhodné pro hotelové PMS, rezervační portály nebo vlastní widget, který má pracovat se stejnou obsazeností jako administrace FOODZI.
Dotaz na volné termíny a kapacitu
Vytvoření a zrušení rezervace
Potvrzení, přesun a změna počtu hostů
Přiřazení ke stolu a k provozovně
Zákazníci
Databáze, historie a souhlasy
Přístup k zákaznické databázi pro CRM, věrnostní program nebo marketing automation. Respektuje GDPR nastavení: marketingové souhlasy a žádosti o výmaz zůstávají řízené z administrace.
Seznam zákazníků a historie objednávek
Vytvoření a aktualizace zákaznického profilu
Štítky, poznámky a segmentace
Stav marketingového souhlasu
Sklad a suroviny
Stav zásob, pohyby, inventury
Obousměrné propojení skladu s dodavatelským nebo účetním systémem. Naskladnění z externí faktury, odpisy a inventurní rozdíly se propíší do stejných dat, ze kterých počítá administrace.
Aktuální stav zásob a jednotky
Naskladnění, odpis a korekce
Historie skladových pohybů
Podklady k inventuře
Prodeje a uzávěrky
Tržby, DPH a denní uzávěrka
Data pro účetnictví a reporting. Tržby rozpadené podle sazby DPH 12 % a 21 %, způsobu platby a kanálu, včetně denní uzávěrky s počátečním stavem pokladny a odvodem.
Denní a intervalové tržby
Rozpis DPH podle sazeb
Uzávěrky pokladny a odvody hotovosti
Účtenky a jejich fiskální náležitosti
Dárkové poukazy
Vydání, ověření, uplatnění
Napojení poukazů na externí prodejní kanál nebo věrnostní systém. Poukaz vydaný přes API platí v POS i v online objednávce a čerpá se ze stejného zůstatku.
Vydání poukazu s nastavenou hodnotou
Ověření platnosti a zůstatku
Uplatnění a částečné čerpání
Historie transakcí poukazu
Provozní stav
Otevírací doba, příjem objednávek, doručení
Řízení provozu z nadřazeného systému. Hodí se pro sítě, které centrálně otevírají a zavírají provozovny, mění doručovací zóny nebo dočasně vypínají příjem objednávek.
Otevírací doba včetně výjimek a svátků
Zapnutí a vypnutí příjmu objednávek
Doručovací zóny, ceny a minimální objednávka
Odhadovaná doba přípravy
Webhooky
Události v reálném čase místo dotazování
Místo pravidelného dotazování vám FOODZI pošle HTTPS požadavek ve chvíli, kdy událost nastane. Každý požadavek je podepsaný, takže si na své straně ověříte, že opravdu přišel od nás.
Nová objednávka a změna jejího stavu
Nová a zrušená rezervace
Dokončená uzávěrka pokladny
Podpis požadavku a opakované doručení při výpadku
Technicky
Jak API funguje
Standardní REST rozhraní bez vlastních SDK a bez proprietárních formátů. Nic, co byste museli studovat týden.
Protokol
REST nad HTTPS, požadavky i odpovědi ve formátu JSON
Autentizace
API klíč v hlavičce požadavku, vázaný na jednu provozovnu
Oprávnění
Zvlášť pro čtení a zápis, jen ke schváleným oblastem
Události
Podepsané webhooky s opakovaným doručením při výpadku
Chyby
Standardní HTTP kódy se strojově čitelným popisem chyby
Stránkování
Kurzorové stránkování pro velké výpisy objednávek a zákazníků
Verzování
Verze v cestě požadavku, změny se nikdy nezavádí zpětně
Testování
Testovací prostředí s testovacími daty před vydáním ostrého klíče
Ukázky kódu
Napojíte se z jakéhokoli jazyka
Žádné vlastní SDK ani knihovna. Stačí HTTPS klient, který umí poslat hlavičku a přečíst JSON.
Načtení nových objednávek
# Načtení nových objednávekcurl-XGET"$FOODZI_API_URL/v1/orders?status=new" \
-H"Authorization: Bearer $FOODZI_API_KEY" \
-H"Accept: application/json"# Změna stavu objednávkycurl-XPATCH"$FOODZI_API_URL/v1/orders/ord_8f21" \
-H"Authorization: Bearer $FOODZI_API_KEY" \
-H"Content-Type: application/json" \
-d '{"status":"preparing"}'# Založení objednávky z vlastního kanálucurl-XPOST"$FOODZI_API_URL/v1/orders" \
-H"Authorization: Bearer $FOODZI_API_KEY" \
-H"Content-Type: application/json" \
-d '{"channel":"app","items":[{"id":"prd_21","qty":2}]}'
# Požadavek, který vám FOODZI pošle. Podpis se počítá# jako HMAC SHA-256 z nezpracovaného těla požadavku.POST/webhooks/foodzi HTTP/1.1Content-Type: application/json
X-Foodzi-Event: order.created
X-Foodzi-Delivery: whd_9c41
X-Foodzi-Signature: 5f2b8c1e...{"event":"order.created","data":{"id":"ord_8f21"}}# Stejný podpis si spočítáte i v shellu:
printf '%s'"$RAW_BODY" \
| openssl dgst -sha256 -hmac "$FOODZI_WEBHOOK_SECRET"
Ukázky vychází z běžného tvaru volání. Adresu API, klíč a přesné endpointy dostanete s dokumentací až se schválením přístupu, proto je v příkladech čteme z proměnných prostředí.
Typické případy
K čemu se API používá
Nejčastější důvody, se kterými za námi provozovatelé a jejich dodavatelé chodí.
Účetnictví bez ručního přepisování
Denní tržby s rozpisem DPH 12 % a 21 %, uzávěrky pokladny a účtenky se přenášejí přímo do účetního softwaru. Odpadá měsíční přepisování dokladů.
Vlastní mobilní aplikace
Aplikace čte menu a zakládá objednávky ve FOODZI. Objednávka z aplikace dorazí do kuchyně a na kuchyňský displej stejně jako objednávka z webu.
Věrnostní program a CRM
Externí věrnostní systém pracuje se stejnou zákaznickou databází a historií objednávek. Body se počítají z reálných útrat, ne z odhadu.
Reporting nad více provozovnami
BI nástroj si stahuje tržby ze všech provozoven do jednoho dashboardu. Vhodné pro sítě, které chtějí vlastní pohled na čísla.
Hotelový systém a rezervace
Hotelové PMS zakládá rezervace stolů a účtuje konzumaci na pokoj. Obsazenost restaurace zůstává v jednom kalendáři.
Dodavatelský a skladový systém
Dodavatel naskladní zboží automaticky po vystavení faktury. Stav zásob v administraci sedí bez ručního zadávání.
Bezpečnost
Co chrání data vaší provozovny
Přístup k API je vždy omezený, sledovaný a kdykoli odvolatelný.
Klíč vázaný na provozovnu
Každý klíč patří jedné provozovně a jednomu partnerovi. Nikdy se nedostane k datům jiného podniku na platformě.
Rozsah jen na schválené oblasti
Klíč otevírá pouze oblasti, které jsme schválili, a to zvlášť pro čtení a pro zápis. Integrace na reporting nikdy nezmění vaše menu.
Limity volání
Každý klíč má limit požadavků za minutu. Chrání provoz vaší pokladny před tím, aby ho vyčerpala chybující integrace.
Auditní log
Zaznamenáváme každé volání i to, který klíč ho provedl. Klíč lze kdykoli okamžitě zneplatnit z naší strany i na vaši žádost.
Zpracování osobních údajů se řídí zásadami ochrany osobních údajů. Pokud integrace pracuje se zákaznickými daty, uzavíráme k ní zpracovatelskou smlouvu.
Postup
Jak získáte přístup
Od žádosti k ostrému klíči vedou čtyři kroky. První odpověď dostanete do dvou pracovních dnů.
1. Odešlete žádost
Ve formuláři popíšete, co má integrace dělat, jaký systém napojujete a které oblasti dat potřebujete. Žádost posuzujeme individuálně.
2. Projdeme si záměr
Ozveme se do dvou pracovních dnů. Probereme rozsah, objem volání a to, zda váš případ dává smysl řešit přes API, nebo existuje jednodušší cesta.
3. Vydáme klíč a dokumentaci
Dostanete API klíč omezený na schválené oblasti, technickou dokumentaci s přesnými endpointy a přístup do testovacího prostředí.
4. Spustíte integraci
Integraci nejprve ověříte proti testovacím datům. Po odsouhlasení klíč přepneme na ostrý provoz vaší provozovny.
Žádost
Požádejte o přístup k API
Vyplňte formulář a ozveme se vám do dvou pracovních dnů s dalším postupem.
Projdu si s vámi záměr integrace a řeknu rovnou, jestli na něj API potřebujete, nebo to jde jednodušeji.
Žádost o přístup k API
Zaškrtněte oblasti, se kterými má integrace pracovat, a popište její záměr.
Časté dotazy
Otázky k API
Je FOODZI API veřejné?
Není. API není veřejně dostupné a nemá otevřenou registraci klíčů. Přístup vydáváme individuálně na základě žádosti, po posouzení záměru integrace a rozsahu dat, ke kterým má přistupovat.
Proč není API veřejné?
API pracuje s provozními a osobními daty restaurací: objednávkami, zákazníky a tržbami. Individuální schvalování nám dovoluje vydat klíč jen na potřebné oblasti, nastavit odpovídající limity a vědět, kdo s daty pracuje. To by u otevřené registrace nešlo.
Kdo může o přístup požádat?
Provozovatel s aktivním předplatným FOODZI pro napojení vlastních systémů a dodavatel software, který integraci staví pro konkrétního zákazníka FOODZI. V druhém případě potřebujeme vědět, pro kterou provozovnu se integrace vyvíjí.
Kolik stojí přístup k API?
Přístup k API není součástí předplatného ani jednorázové licence a oceňuje se podle rozsahu integrace a objemu volání. Cenu potvrdíme spolu se schválením žádosti, ještě než začnete vyvíjet. Pravidla přístupu upravuje článek XXI obchodních podmínek.
Jak dlouho trvá vyřízení žádosti?
Na žádost odpovídáme do dvou pracovních dnů. Pokud je záměr jasný a rozsah odsouhlasený, klíč do testovacího prostředí vydáváme obvykle do několika dnů.
V jakém formátu API komunikuje?
Jde o REST API nad HTTPS. Požadavky i odpovědi jsou ve formátu JSON, autentizace probíhá pomocí API klíče v hlavičce požadavku. Chyby vracíme se standardními HTTP kódy a strojově čitelným popisem.
V jakém programovacím jazyce mohu integraci napsat?
V jakémkoli. Jde o běžné REST rozhraní nad HTTPS, takže vám stačí HTTP klient, který umí poslat hlavičku a přečíst JSON. Na této stránce najdete ukázky pro cURL, JavaScript, PHP, Python, C# a Javu včetně ověření podpisu webhooku. Vlastní SDK nevydáváme, žádnou knihovnu instalovat nemusíte.
Jak se dozvím o nové objednávce bez neustálého dotazování?
Přes webhooky. Zaregistrujete si HTTPS adresu a FOODZI na ni odešle podepsaný požadavek ve chvíli, kdy událost nastane: nová objednávka, změna stavu, nová rezervace nebo dokončená uzávěrka. Podpis si ověříte na své straně.
Můžu si integraci vyzkoušet, než ji nasadím?
Ano. Ke schválené žádosti dostanete přístup do testovacího prostředí s testovacími daty. Ostrý klíč pro vaši provozovnu vydáváme až po odladění, aby vývoj nikdy nezasáhl do reálného provozu.
Co když integraci nepotřebuji, protože stačí hotová funkce?
Na to se v prvním kroku ptáme sami. Řada požadavků jde vyřešit bez vývoje: exporty pro účetnictví, marketingové integrace nebo napojení na Wolt a Foodoru už v platformě jsou. Pokud vám stačí ony, doporučíme je a ušetříte si vývoj.
Máte konkrétní záměr?
Popište nám, co potřebujete napojit. Když na to API není potřeba, řekneme vám to rovnou a ušetříme vám vývoj.