API referencia.
Nyilvános API végpontok fejlesztők számára: űrlapok, widgetek, termékkonfigurátor és még sok más.
Ez a referencia kizárólag valós, nyilvánosan használható JSON-végpontokat ír le -- végpontonként a metódust, az útvonalat, a hitelesítés típusát, a kötelező paramétereket, a példa kérést és választ, valamint a dokumentált hibakódokat. A Zentornál nem létezik általános fejlesztői API-kulcsrendszer; a hozzáférés útvonaltól függően hitelesítés nélkül vagy origin-ellenőrzéssel ellátott widget-beágyazási tokennel történik. A belső dashboard-útvonalak és a Master Admin végpontjai szándékosan nem részei ennek a nyilvános referenciának, mivel kizárólag a szokásos bejelentkezési munkameneten keresztül érhetők el.
Minden végpontbejegyzés tartalmaz egy élő tesztre vonatkozó megjegyzést, amely feltárja, hogy az adat a registry-sémából, automatizált tesztből vagy tényleges élő megfigyelésből származik -- egy működő kódútvonalhoz való puszta hasonlóság nem számít teljes bizonyítéknak. Egy technikailag sikeres hívás ráadásul mindig csak az adott kérés feldolgozását igazolja, nem automatikusan a későbbi folyamatokat, például az e-mail kézbesítését, a fizetés lezárását vagy egy befejezett SSO-bejelentkezést.
A védelem az adott csoporttól függ. A nyilvános jogi, marketing- és űrlapvégpontokhoz nincs szükség dashboard-munkamenetre. A chat widget ezzel szemben az `X-Widget-Token` fejlécet és egy origin-engedélyezőlistát használ. A dashboard-bejelentkezések tizenkét órás érvényességű munkamenet-JWT-t és hét napig érvényes frissítési tokent adnak. Az SSO-végpontok saját egyszer használatos kódokkal és callback-folyamatokkal működnek.
Minden végpontoldalt önálló szerződésként olvasson. A döntő a HTTP-metódus, az útvonal, a kötelező paraméterek, az adattípusok, a kéréstörzs, a válasz szerkezete, a hibakódok és az idempotencia. Egy példa egy lehetséges formátumot mutat, de nem helyettesíti a tényleges válasz ellenőrzését. A konfigurációs állapot, a validációk, a jogosultságok és a külső szolgáltatók befolyásolhatják az eredményt.
A megerősített, platformszintű sebességkorlát 15 percen belül 2000 kérés. A végpontonkénti külön korlátok nincsenek mindenhol dokumentálva. Ezért a kliensek ne használjanak szükségtelenül sűrű lekérdezési (polling) ciklusokat. Nem idempotens műveleteknél az automatikus újrapróbálkozások duplikált rekordokat vagy üzeneteket hozhatnak létre.
Érzékeny értékek nem kerülhetnek naplókba. Ide tartoznak a jelszavak, a visszaállítási tokenek, az ellenőrző kódok, a widget-tokenek, a munkamenet-azonosítók és a valós személyes adatokat tartalmazó példaadatok. A dokumentációban és a tesztekben anonimizált értékeket használjon. Az élő tesztre vonatkozó megjegyzéseknek pontosan kell tükrözniük a tényleges bizonyítékot.