REST nad HTTPS s JSON na https://api.mujprofirest.cz/v2, smlouva OpenAPI 3.1.0 (openapi.json), 217 operací v 25 oblastech. Chyby jako application/problem+json (RFC 9457) se 118 stálými kódy.

REST over HTTPS with JSON at https://api.mujprofirest.cz/v2, an OpenAPI 3.1.0 contract (openapi.json), 217 operations in 25 areas. Errors as application/problem+json (RFC 9457) with 118 stable codes.

OAuth 2.0 authorization code s PKCE (S256): majitel restaurace aplikaci připojí, vybere provozovny a potvrdí oprávnění. Access token platí 30 minut, refresh token 90 dní od posledního použití. Granty POST /oauth/token: authorization_code (authorization code s PKCE, e-shopy a partnerské aplikace), refresh_token (obnova tokenů), urn:ietf:params:oauth:grant-type:device_code (device authorization grant, RFC 8628, jen párování vlastních zařízení Profirestu), urn:profirest:params:oauth:grant-type:v1-device (výměna identity API v1, jen vlastní zařízení Profirestu při přechodu z API v1). Grant client credentials ani API klíče API nemá. 41 oprávnění (scopes), z toho 19 pro partnerské aplikace – seznam.

OAuth 2.0 authorization code with PKCE (S256): the restaurant owner connects the application, picks the restaurants and grants the scopes. Access tokens live 30 minutes, refresh tokens 90 days since their last use. Grants of POST /oauth/token: authorization_code (authorization code with PKCE, online shops and partner applications), refresh_token (refreshing tokens), urn:ietf:params:oauth:grant-type:device_code (device authorization grant, RFC 8628, only for pairing Profirest's own devices), urn:profirest:params:oauth:grant-type:v1-device (exchanging an API v1 identity, only Profirest's own devices moving from API v1). There is no client credentials grant and no API keys. 41 scopes, 19 of them for partner applications – list.

Produkty, kategorie a ceny se přes API nezakládají ani nemění – sortiment API jen čte (getCatalog, změnu hlásí událost catalog.changed). Zapisovat jde jen dostupnost: zbývající porce a vyprodáno (setProductAvailability, oprávnění availability:write). K produktům si navíc můžete uložit vlastní ID a metadata (putExternalRef); otevírací dobu mění setOpeningHours.

Products, categories and prices cannot be created or changed through the API – the API only reads the catalog (getCatalog, a change is announced by the catalog.changed event). The only write is availability: portions left and sold out (setProductAvailability, scope availability:write). You can also store your own IDs and metadata on products (putExternalRef); setOpeningHours changes the opening hours.

Kalkulace košíku (createQuote – ceny, dopravu i DPH spočítá server), vytvoření objednávky rovnou do kuchyně (createOrder), potvrzení online platby (confirmOrderPayment) a zrušení (cancelOrder, dokud ji kuchyně nezačala připravovat). Stav hlásí webhooky a proud změn. Aplikace vidí objednávky, které sama vytvořila; změnu položek už vytvořené objednávky API nenabízí.

Pricing a basket (createQuote – the server works out prices, delivery and VAT), creating an order straight into the kitchen (createOrder), confirming an online payment (confirmOrderPayment) and cancelling (cancelOrder, until the kitchen starts preparing it). Webhooks and the event feed report the status. An application sees the orders it created; changing the items of an existing order is not offered.

Jediný zápis do skladu je inventura (createStockTaking), která nastaví stav skladu; položky k přepočítání čte listStockTakingItems. Oprávnění stock:read a stock:write jsou jen pro vlastní aplikace Profirestu – partnerská aplikace sklad nečte ani nezapisuje. Příjemky, výdejky ani jiné skladové pohyby API nemá; ze skladu odepisuje sama účtenka pokladny.

The only write to the stock is a stock taking (createStockTaking), which sets the stock levels; listStockTakingItems reads the items to count. The scopes stock:read and stock:write are for Profirest's own applications only – a partner application neither reads nor writes the stock. There are no goods receipts, issues or other stock movements; the register's receipt itself deducts from the stock.

Na HTTPS adresu registrovanou u klienta, podpis podle Standard Webhooks (HMAC-SHA256; hlavičky webhook-id, webhook-timestamp, webhook-signature), opakování po 1 min, 5 min, 30 min, 2 h a 12 h. Tytéž události jsou v proudu změn s kurzorem (listEvents) a živě přes Server-Sent Events (streamEvents). 29 typů událostí, každé připojení dostane ty, které dovolují jeho oprávnění.

To an HTTPS address registered with the client, signed per Standard Webhooks (HMAC-SHA256; headers webhook-id, webhook-timestamp, webhook-signature), retried after 1 min, 5 min, 30 min, 2 h and 12 h. The same events are in the event feed with a cursor (listEvents) and live over Server-Sent Events (streamEvents). 29 event types; each connection gets those its scopes allow.

Samostatné pískoviště není: API běží jen na https://api.mujprofirest.cz nad skutečnými daty. Zkouší se testovacím přístupem (/zadost/test – client_id a tajemství hned po potvrzení e-mailu, jen k veřejnému ukázkovému účtu profirestdemo; SMS ani e-maily se neposílají, do EET 2.0 nic nejde, webhooky chodí jako obvykle a data se každou noc obnoví), na testovacích provozovnách (Restaurant.is_test, Profirest je přidá k vašemu připojení) a v playgroundu nad příklady ze smlouvy bez přístupu.

There is no separate sandbox: the API runs only at https://api.mujprofirest.cz on live data. You test with test access (/zadost/test – a client_id and a secret right after confirming your e-mail, only for the public demo account profirestdemo; no SMS or e-mails are sent, nothing goes to EET 2.0, webhooks arrive as usual and the data is reset every night), on test restaurants (Restaurant.is_test, Profirest adds them to your connection) and in the playground with the contract's examples, without access.

Zdarma a bez přihlášení, česky i anglicky: reference s ukázkami v curl a v 10 jazycích u každé operace, návody, katalog chyb, changelog, playground, OpenAPI 3.1.0 (openapi.json) a pro jazykové modely llms.txt a llms-full.txt.

Free and without signing in, in Czech and English: the reference with examples in curl and 10 languages at every operation, guides, the error catalog, the changelog, the playground, OpenAPI 3.1.0 (openapi.json) and, for language models, llms.txt and llms-full.txt.

Partnerské aplikace: restaurants:read, catalog:read, availability:write, opening_hours:write, orders:write, orders:read, customers:read, customers:write, loyalty:read, vouchers:redeem, accounting:read, reports:read, reservations:read, reservations:write, lodging:read, lodging:write, housekeeping:read, housekeeping:write, guest_passes:check. Jen vlastní aplikace Profirestu (x-first-party-scopes): staff:read, staff:authenticate, attendance:read, attendance:punch, kitchen:read, kitchen:write, deliveries:read, deliveries:write, settings:read, queue:read, directory:read, calls:write, receipts:read, receipts:write, stock:read, stock:write, backups:read, backups:write, diagnostics:write, table:sync, lodging_desk:read, lodging_desk:write. Co které dovoluje, je v tabulce níže.

Partner applications: restaurants:read, catalog:read, availability:write, opening_hours:write, orders:write, orders:read, customers:read, customers:write, loyalty:read, vouchers:redeem, accounting:read, reports:read, reservations:read, reservations:write, lodging:read, lodging:write, housekeeping:read, housekeeping:write, guest_passes:check. Profirest's own applications only (x-first-party-scopes): staff:read, staff:authenticate, attendance:read, attendance:punch, kitchen:read, kitchen:write, deliveries:read, deliveries:write, settings:read, queue:read, directory:read, calls:write, receipts:read, receipts:write, stock:read, stock:write, backups:read, backups:write, diagnostics:write, table:sync, lodging_desk:read, lodging_desk:write. What each allows is in the table below.

listEvents vrací události po kurzoru (next_cursor), streamEvents tytéž živě jako text/event-stream s obnovou přes Last-Event-ID. Typy událostí: order.created, order.updated, order.status_changed, catalog.changed, availability.changed, promotions.changed, restaurant.changed, grant.changed, grant.revoked, attendance.updated, kitchen.ticket_created, kitchen.ticket_updated, kitchen.shift_closed, call.received, receipt.created, receipt.cancelled, receipt.updated, pos_shift.closed, tab.updated, tab.closed, sale.created, sale.cancelled, shift.closed, table.inbox_received, reservation.created, reservation.updated, reservation.status_changed, courier.position, courier.shift_changed.

listEvents returns events after a cursor (next_cursor), streamEvents the same ones live as text/event-stream, resuming with Last-Event-ID. Event types: order.created, order.updated, order.status_changed, catalog.changed, availability.changed, promotions.changed, restaurant.changed, grant.changed, grant.revoked, attendance.updated, kitchen.ticket_created, kitchen.ticket_updated, kitchen.shift_closed, call.received, receipt.created, receipt.cancelled, receipt.updated, pos_shift.closed, tab.updated, tab.closed, sale.created, sale.cancelled, shift.closed, table.inbox_received, reservation.created, reservation.updated, reservation.status_changed, courier.position, courier.shift_changed.

Propojení zákazníka s databází klientů účtu podle telefonu – vytvoření, úprava, smazání (createCustomer, updateCustomer, deleteCustomer), ověření telefonu kódem, věrnostní body ověřených zákazníků (getCustomerLoyalty) a ověření dárkového voucheru (checkVoucher).

Linking a customer with the account's customer database by phone – create, update, delete (createCustomer, updateCustomer, deleteCustomer), phone verification by code, loyalty points of verified customers (getCustomerLoyalty) and checking a gift voucher (checkVoucher).

Seznam zaměstnanců a jejich rolí bez PINů (listStaff), přihlášení na zařízení PINem nebo čipem (createStaffSession), odhlášení a změna vlastního PINu. Zakládání, úpravy a mazání zaměstnanců API nemá. Jen vlastní aplikace Profirestu.

The list of employees and their roles without PINs (listStaff), signing in on a device with a PIN or a card (createStaffSession), signing out and changing one's own PIN. Creating, changing or deleting employees is not offered. Profirest's own applications only.

Stejné API používají pokladny, kuchyňské displeje, docházkové terminály a telefony kurýrů Profirestu. Oblasti Reception, Staff, Attendance, Kitchen, Deliveries, Receipts, Stock, Backups, Diagnostics, Device settings, Customer directory, Table ordering jsou celé jen pro vlastní aplikace Profirestu; partnerská aplikace má k dispozici 90 z 217 operací.

The same API serves Profirest's registers, kitchen displays, attendance terminals and couriers' phones. The areas Reception, Staff, Attendance, Kitchen, Deliveries, Receipts, Stock, Backups, Diagnostics, Device settings, Customer directory, Table ordering are entirely for Profirest's own applications; a partner application can use 90 of the 217 operations.

external_id a až 20 dvojic metadata u provozoven, kategorií, produktů, objednávek a zákazníků (putExternalRef, hledání podle vašeho ID listExternalRefs); vidí je jen vaše připojení.

An external_id and up to 20 metadata pairs on restaurants, categories, products, orders and customers (putExternalRef, look-up by your ID with listExternalRefs); only your connection sees them.

Verze smlouvy RR.M.N (aktuální 26.11.28 z 13. 11. 2026), 37 vydání v changelogu s porovnáním dvou verzí. Slib stability: ve v2 se jen přidává – nic se neodebírá ani nepřejmenovává; ukončovanou funkci označí hlavička Deprecation, konec v2 ohlásí Sunset nejméně 12 měsíců předem.

Contract versions YY.M.N (current 26.11.28 of 13 November 2026), 37 releases in the changelog with a comparison of two versions. Stability promise: v2 only adds – nothing is removed or renamed; a feature being retired gets the Deprecation header, the end of v2 is announced by Sunset at least 12 months ahead.

Oficiální knihovny: JavaScript, PHP, Java / Kotlin, C# / .NET, Python, TypeScript, Swift, Dart / Flutter, Go. Ukázky u každé operace v curl a v jazycích JavaScript, TypeScript, PHP, Java, Kotlin, C#, Python, Swift, Dart, Go.

Official libraries: JavaScript, PHP, Java / Kotlin, C# / .NET, Python, TypeScript, Swift, Dart / Flutter, Go. Examples at every operation in curl and JavaScript, TypeScript, PHP, Java, Kotlin, C#, Python, Swift, Dart, Go.

Příděl požadavků za minutu má každé připojení a vlastní každé spárované zařízení; stav ukazují hlavičky RateLimit-Limit, RateLimit-Remaining a RateLimit-Reset, po překročení přijde 429 rate_limited s Retry-After. Pevné číslo přídělu smlouva neuvádí – server ho posílá v RateLimit-Limit.

Every connection, and separately every paired device, has a per-minute request allowance; the headers RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset show it, and going over it returns 429 rate_limited with Retry-After. The contract states no fixed number – the server sends it in RateLimit-Limit.

Idempotency-Key u každého POST: opakování se stejným klíčem nikdy nevytvoří druhý záznam, konečné výsledky se drží 24 hodin. PUT a DELETE jsou idempotentní samy. Objednávka má navíc pojistky quote_already_used a external_id_conflict.

Idempotency-Key on every POST: a retry with the same key never creates a second object, final results are kept for 24 hours. PUT and DELETE are idempotent by themselves. Orders are also guarded by quote_already_used and external_id_conflict.

Změny s If-Match a ETag (updateCustomer, updateReservation, updateStay, moveStay, putExternalRef, putTab, closeTab, moveTabLines), při souběžné změně 412 precondition_failed. Podmíněné čtení If-None-Match s odpovědí 304 nabízí 21 operací, mimo jiné getCatalog a getAvailability.

Changes with If-Match and the ETag (updateCustomer, updateReservation, updateStay, moveStay, putExternalRef, putTab, closeTab, moveTabLines), 412 precondition_failed on a concurrent change. 21 operations offer conditional reads with If-None-Match and 304, among them getCatalog and getAvailability.

Seznamy jako {"data": […], "next_cursor": "…"}; kurzor je neprůhledný, nikdy se neskládá ručně.

Lists as {"data": […], "next_cursor": "…"}; the cursor is opaque and never built by hand.

Názvy chyb (title) česky nebo anglicky podle Accept-Language (cs výchozí, en); dokumentace česky i anglicky. Názvy polí, hodnoty výčtů, typy událostí a kódy chyb jsou jen anglicky; texty restaurace (názvy produktů) přicházejí tak, jak byly zadány.

Error titles (title) in Czech or English by Accept-Language (cs by default, en); the documentation in Czech and English. Field names, enum values, event types and error codes are English only; the restaurant's texts (product names) come as they were entered.

Ceny konečné včetně DPH, částky jako celé číslo v nejmenší jednotce s měnou ISO 4217; DPH, dopravu, slevy z akcí provozovny a zaokrouhlení spočítá server v kalkulaci.

Prices are final including VAT, amounts are integers in the smallest unit with an ISO 4217 currency; the server works out VAT, delivery, the restaurant's promotions and rounding in the quote.

Tržby z objednávek a účtenek eviduje do EET 2.0 (od 1. 1. 2027) server Profirestu certifikátem provozovny; aplikace finanční správě nic neposílá a certifikát nepotřebuje. Platby online se neevidují.

Sales from orders and receipts are recorded in EET 2.0 (from 1 January 2027) by Profirest's server with the restaurant's certificate; your application sends nothing to the tax authority and needs no certificate. Online payments are not recorded.

CORS jen pro adresy registrované u klienta, API nikdy nepoužívá cookies; tajemství klienta do prohlížeče nepatří (veřejný klient s PKCE).

CORS only for addresses registered with the client, the API never uses cookies; the client secret does not belong in a browser (a public client with PKCE).

Případné poplatky za přístup sjednáváme zvlášť; bez takové dohody je přístup bezplatný. (Podmínky použití API, bod Přístup.) Ke zkoušení slouží playground s ukázkovými daty, který přístup nepotřebuje. Dokumentace je zdarma a bez přihlášení.

Any fees for access are agreed separately; without such an agreement access is free of charge. (API terms of use, Access.) For trying the API there is the playground with sample data, which needs no access. The documentation is free and needs no sign-in.

Ostrý přístup ke skutečným restauracím po schválení žádosti (posuzuje se ručně); restaurace pak aplikaci připojí tlačítkem „Připojit přes Profirest“ a připojení může kdykoli zrušit. Testovací přístup hned na /zadost/test. Kontakt: info@profirest.cz.

Production access to real restaurants once the request is approved (reviewed by hand); a restaurant then connects the application with the “Connect with Profirest” button and can cancel the connection at any time. Test access straight away at /zadost/test. Contact: info@profirest.cz.