Referencia API

Verejné API koncové body pre vývojárov: formuláre, widget, konfigurátor produktov a viac.

Táto referencia opisuje výlučne skutočné, verejne použiteľné koncové body JSON -- metódu, cestu, typ autentifikácie, povinné parametre, príklad požiadavky a odpovede, ako aj zdokumentované chybové kódy pre každý koncový bod. Všeobecný systém API kľúčov pre vývojárov v Zentor neexistuje; prístup prebieha podľa cesty buď bez autentifikácie, alebo cez embed token widgetu s kontrolou pôvodu (Origin). Interné cesty dashboardu a koncové body Master Admin zámerne nie sú súčasťou tejto verejnej referencie, pretože sú dostupné výlučne cez bežnú prihlasovaciu reláciu.

Každý záznam koncového bodu obsahuje poznámku o živom teste, ktorá uvádza, či údaj pochádza zo schémy registra, z automatizovaného testu alebo zo skutočného živého pozorovania -- samotná podobnosť s funkčnou cestou v kóde sa pritom nepovažuje za úplný dôkaz. Technicky úspešné volanie navyše vždy potvrdzuje iba spracovanie samotnej požiadavky, nie automaticky následné procesy, ako je doručenie e-mailu, dokončenie platby alebo dokončené prihlásenie cez SSO.

Zabezpečenie závisí od príslušnej skupiny. Verejné právne, marketingové a formulárové koncové body nepotrebujú reláciu dashboardu. Chatový widget naopak používa hlavičku `X-Widget-Token` a zoznam povolených pôvodov (Origin allowlist). Prihlásenia do dashboardu poskytujú session JWT s platnosťou dvanásť hodín a refresh token s platnosťou sedem dní. Koncové body SSO pracujú s vlastnými jednorazovými kódmi a priebehmi callbacku.

Každú stránku koncového bodu čítajte ako samostatnú zmluvu. Rozhodujúce sú metóda HTTP, cesta, povinné parametre, dátové typy, telo požiadavky, štruktúra odpovede, chybové kódy a idempotencia. Príklad ukazuje možný formát, nenahrádza však kontrolu skutočnej odpovede. Stav konfigurácie, validácie, oprávnenia a externí poskytovatelia môžu výsledok zmeniť.

Potvrdený rate limit pre celú platformu je 2.000 požiadaviek v priebehu 15 minút. Samostatné limity pre jednotlivé koncové body nie sú všade zdokumentované. Klienti by preto nemali používať zbytočne husté slučky pollingu. Pri neidempotentných operáciách môžu automatické opakovania vytvoriť duplicitné záznamy alebo správy.

Citlivé hodnoty nepatria do logov. Patria k nim heslá, tokeny na obnovenie hesla, overovacie kódy, tokeny widgetu, ID relácií a skutočné osobné vzorové údaje. V dokumentácii a testoch používajte anonymizované hodnoty. Poznámky o živých testoch musia správne odrážať skutočný dôkaz.

Autentifikácia (5)Prihlásenie, obnovenie tokenu, obnovenie hesla, výmena SSO.Verejné formuláre (11)Kontakt, dopyt na konzultáciu, žiadosť o prístup, aktivácia účtu.Konfigurátor produktov (5)Zoznam balíkov, prehľad cien, overenie e-mailu, odovzdanie konfigurácie.Verejný obsah (6)Právne texty, marketingové stránky, konfigurácia tém a farieb textu.Chat widget (9)Všetky koncové body, ktoré využíva vložený chat widget na webových stránkach zákazníkov.Demo chatbot a SSO (13)Verejný demo chatbot a koncové body Single Sign-On (SSO).
← Späť na prehľad