API reference

Veřejné API endpointy pro vývojáře: formuláře, widget, konfigurátor produktů a další.

Tato reference popisuje výhradně skutečné, veřejně použitelné JSON endpointy -- metodu, cestu, typ autentizace, povinné parametry, ukázkový request a response a zdokumentované chybové kódy pro každý endpoint. Obecný systém vývojářských API klíčů Zentor nemá; přístup probíhá podle routy buď bez autentizace, nebo pomocí tokenu pro vložení widgetu s kontrolou originu. Interní routy dashboardu a endpointy Master Admin záměrně nejsou součástí této veřejné reference, protože jsou dostupné výhradně přes běžnou přihlášenou relaci.

Každý záznam endpointu nese poznámku o živém testu, která uvádí, zda údaj pochází ze schématu registru, z automatizovaného testu, nebo ze skutečného živého pozorování -- pouhá podobnost s funkční cestou v kódu se přitom nepovažuje za úplný důkaz. Technicky úspěšné volání navíc vždy potvrzuje pouze zpracování samotného requestu, nikoli automaticky navazující procesy, jako je doručení e-mailu, dokončení platby nebo dokončené přihlášení přes SSO.

Zabezpečení závisí na příslušné skupině. Veřejné právní, marketingové a formulářové endpointy nevyžadují relaci dashboardu. Chatovací widget naopak používá hlavičku `X-Widget-Token` a seznam povolených originů. Přihlášení do dashboardu vrací relační JWT s platností dvanáct hodin a refresh token platný sedm dní. SSO endpointy pracují s vlastními jednorázovými kódy a callback procesy.

Každou stránku endpointu čtěte jako samostatnou smlouvu. Rozhodující jsou HTTP metoda, cesta, povinné parametry, datové typy, tělo requestu, struktura odpovědi, chybové kódy a idempotence. Příklad ukazuje možný formát, nenahrazuje však kontrolu skutečné odpovědi. Stav konfigurace, validace, oprávnění a externí poskytovatelé mohou výsledek změnit.

Potvrzený rate limit pro celou platformu je 2 000 requestů během 15 minut. Samostatné limity pro jednotlivé endpointy nejsou soustavně zdokumentovány. Klienti by proto neměli používat zbytečně husté polling smyčky. U neidempotentních operací mohou automatická opakování vytvořit duplicitní záznamy nebo zprávy.

Citlivé hodnoty nepatří do logů. Patří k nim hesla, tokeny pro reset, ověřovací kódy, tokeny widgetu, ID relací a reálná osobní ukázková data. V dokumentaci a testech používejte anonymizované hodnoty. Poznámky o živém testu musí správně odrážet skutečný důkaz.

Autentizace (5)Přihlášení, obnova tokenu, reset hesla, výměna SSO.Veřejné formuláře (11)Kontakt, žádost o poradenství, žádost o přístup, aktivace účtu.Konfigurátor produktu (5)Seznam balíčků, náhled ceny, ověření e-mailu, odeslání konfigurace.Veřejné obsahy (6)Právní texty, marketingové stránky, konfigurace barev motivu a textu.Chat-widget (9)Všechny koncové body, které vložený chat widget využívá na webových stránkách zákazníků.Demo chatbot a SSO (13)Veřejný demo chatbot a také koncové body Single Sign-On.
← Zpět na přehled