Chat Widget

All Endpunkten déi den embedded Chat Widget op Clients Websäiten benotzt.

Dës Grupp bündelt all ëffentlech Endpunkten, déi dat agebonnent Chat-Widget op Kundewebsäite benotzt: de Erreechbarkeets-Check (`GET /api/public/widget/health`), den Ofruff vun der ëffentlecher Widget-Konfiguratioun (`GET /api/public/widget/config/:widget_code`) souwéi Message-Versand a -verlaf (`POST /api/public/widget/message`, `GET /api/public/widget/history`). D'Domainfräigab gëtt beim Uleeë vum Widget duerch Zentor gepflegt; dofir gëtt et keng Astellungsuewerfläch am Tenant-Dashboard. Bei enger net fräigeschaltener Hierkonft kann den Feelercode `WIDGET_ORIGIN_DENIED` optrieden. D'Widget-Uleeë selwer ass dem Master-Admin virbehalen, während den Tenant de fäerdege Abannungscode kritt.

En allgemengt Entwéckler-API-Key-System gëtt et net. `health` a `config` sinn ouni Authentifizéierung erreechbar, well se fir d'Initialiséierung vum Widget am Browser geduecht sinn. `message` a `history` brauchen dogéint den `X-Widget-Token`-Header a ginn zousätzlech géint eng serverséiteg Origin-Allowlist gepréift. Den Embed-Token gëtt beim Uleeë vum Widget eemol am Klartext ugewisen a dierf net an ëffentleche Repositories, Support-Screenshots oder Browser-Logs optrieden.

All Detailsäit vun dëser Grupp beschreift Method, Wee, Authentifizéierung, Idempotenz an déi dokumentéiert Feelercode vum jeeweilegen Endpunkt eenzel. En erfollegräichen Opruff vun engem Endpunkt beleet net automatesch, datt en anere Endpunkt vun der selwechter Grupp och erfollegräich verlafe géif — besonnesch bestätegt e gréngen `health`-Check weder e valabelt Widget nach eng fräigeschalten Origin oder d'Erreechbarkeet vun engem KI-Provider.

Dat bestätegt plattformwäit API-Limit läit bei 2.000 Ufroen bannent 15 Minutten. En dovun ofweichend Limit fir een eenzelnen Widget-Endpunkt gëtt nëmmen ernimmt, wa et fir dëse Endpunkt ausdrécklech beluecht ass. `message` ass net idempotent; e Client dierf en onkloer ofgebrachene Sendevirgang net automatesch widderhuelen, ouni virdrun ze préiwen, ob déi éischt Message scho verschafft gouf.

D'technesch Iwwerpréiwung vun dëser Grupp stëtzt sech op d'Registry ënner `app/frontend/src/content/api-reference/groups/widget.ts` an déi zougehéiereg Backend-Routen. All Detailsäit weist un, ob en Erfollegswee live, en Negativwee oder nëmmen eng Code-Analogie gepréift gouf — dës Ënnerscheedung gëllt fir déi ganz Grupp an dierf net duerch allgemeng Erfollegsaussoen ersat ginn.

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
Referenz API