Referenz API

Allgemeng API Endpunkten fir Entwéckler: Formulairen, Widget, Produktkonfigurator a méi.

Dës Referenz beschreift ausschliisslech richteg, ëffentlech notzbar JSON-Endpunkten -- Method, Pfad, Authentifizéierungstyp, obligatoresch Parameteren, Beispill-Request an -Response souwéi dokumentéiert Feelercoden pro Endpunkt. E generellen API-Schlësselsystem fir Entwéckler gëtt et bei Zentor net; den Zougrëff geschitt je no Route entweder ouni Authentifizéierung oder iwwer e Widget-Embed-Token mat Origin-Kontroll. Intern Dashboard-Routen a Master-Admin-Endpunkte sinn bewosst net Deel vun dëser ëffentlecher Referenz, well se ausschliisslech iwwer déi regulär Umeldungssessioun erreechbar sinn.

All Endpunkt-Androung huet e Live-Test-Vermierk, deen offeleet, ob d'Informatioun aus dem Registry-Schema, engem automatiséierten Test oder enger tatsächlecher Live-Observatioun kënnt -- eng reng Ähnlechkeet mat engem fonctionnéierende Code-Pfad gëllt dobäi net als vollstännege Beweis. En technesch erfollegräichen Opruff bestätegt ausserdeem ëmmer nëmmen d'Veraarbechtung vum jeeweilege Request selwer, net automatesch nogeschalt Virgäng wéi d'Zoustellung vun enger E-Mail, den Ofschloss vun engem Bezuelvirgang oder eng ofgeschloss SSO-Umeldung.

D'Ofsécherung hänkt vun der jeeweileger Grupp of. Ëffentlech Rechts-, Marketing- a Formulaire-Endpunkte brauchen keng Dashboard-Sessioun. Den Chat-Widget benotzt dogéint den Header `X-Widget-Token` an eng Origin-Allowlist. Dashboard-Umeldunge liwweren e Session-JWT mat zwielef Stonnen Laafzäit an e Refresh-Token mat siwe Deeg Gëltegkeet. SSO-Endpunkte schaffe mat eegenen Eemolcoden a Callback-Oflef.

Liest all Endpunktsäit als eegestännege Kontrakt. Entscheedend sinn HTTP-Method, Pfad, obligatoresch Parameteren, Datentypen, Request-Body, Response-Struktur, Feelercoden an Idempotenz. E Beispill weist e méiglecht Format, ersetzt awer keng Iwwerpréifung vun der tatsächlecher Äntwert. Konfiguratiounsstatus, Validéierungen, Berechtegungen an extern Ubidder kënnen d'Resultat veränneren.

De bestätegte plattformwäite Rate-Limit läit bei 2.000 Requests bannent 15 Minutten. Separat Limitte pro Endpunkt sinn net duerchgängeg dokumentéiert. Clients sollen dofir keng onnéideg enk Polling-Schleefe benotzen. Bei net idempotenten Operatioune kënnen automatesch Widderhuelungen duebel Datesätz oder Messagen erzeegen.

Sensibel Wäerter gehéieren net an d'Logs. Dozou zielen Passwierder, Reset-Tokens, Verifikatiounscoden, Widget-Tokens, Session-IDen a real perséinlech Beispilldaten. Benotzt an Dokumentatioun an Tester anonymiséiert Wäerter. Live-Test-Hiweiser mussen den tatsächleche Beweis korrekt erëmginn.

Authentifizéierung (5)Login, Token erneieren, Passwuert resetéieren, SSO Austausch.Ëffentlech Formulairen (11)Kontakt, Berodungsfuerderung, Zougangsbedarf, Kontaktiverung.Produktkonfigurator (5)Package Lëscht, Präis Virschau, E-Mail Verifikatioun, Konfiguratioun ofginn.Ëffentlech Inhalt (6)Rechtstexter, Marketingseiten, Thema a Textfaarf Konfiguratioun.Chat Widget (9)All Endpunkten déi den embedded Chat Widget op Clients Websäiten benotzt.Demo Chatbot an SSO (13)Den ëffentlechen Demo Chatbot an Single Sign-On Endpunkten.
← Zurück zum Iwwerbléck