I-chat widget

Wonke ama-endpoint asetshenziswa yi-widget ye-chat efakiweyo kumawebhusayithi amakhasimende.

Leli qembu lihlanganisa wonke ama-endpoint omphakathi asetshenziswa yi-widget ye-chat efakiweyo kumawebhusayithi amakhasimende: ukuhlolwa kokufinyeleleka (`GET /api/public/widget/health`), ukuthola ukuhlelwa kwe-widget komphakathi (`GET /api/public/widget/config/:widget_code`) kanye lokuthumela lomlando wemilayezo (`POST /api/public/widget/message`, `GET /api/public/widget/history`). Imvumo ye-domain igcinwa nguZentor ekwenziweni kwe-widget; akulasikhangiso sezilungiselelo salokhu ku-Dashboard yomqashi. Nxa i-origin ingavunyelwanga, ikhodi yephutha `WIDGET_ORIGIN_DENIED` ingavela. Ukwenziwa kwe-widget ngokwayo kugcinelwe uMaster-Admin, kanti umqashi uthola ikhodi yokufaka esilungileyo.

Uhlelo olujwayelekileyo lwama-API key abathuthukisi alukho. I-`health` le-`config` kuyafinyeleleka ngaphandle kokuqinisekiswa, ngoba kuhloselwe ukuqalisa i-widget ebhrawuzeni. Kodwa i-`message` le-`history` kudinga i-header ye-`X-Widget-Token` njalo kuhlolwa futhi ngohlu lwama-origin avunyelweyo eseva. I-embed token itshengiswa kanye kuphela embhalweni ocacileyo ekwenziweni kwe-widget njalo kayimelanga ivele kuma-repository omphakathi, izithombe-skrini zosizo kumbe kuma-log ebhrawuza.

Ikhasi ngalinye lemininingwane kuleli qembu lichaza i-method, i-path, ukuqinisekiswa kobuntu, i-idempotency lamakhodi amaphutha abhaliweyo e-endpoint ngayinye ngokwehlukeneyo. Ukubiza okuphumeleleyo kwe-endpoint eyodwa kakufakazeli ngokuzenzakalelayo ukuthi enye i-endpoint yeqembu elifanayo layo ingaphumelela — ikakhulu ukuhlola kwe-`health` okuluhlaza kakuqinisekisi i-widget esebenzayo, i-origin evunyelweyo kumbe ukufinyeleleka komhlinzeki we-AI.

Umkhawulo we-API oqinisekisiweyo wenkundla yonke ngu-2.000 wezicelo phakathi kwemizuzu engu-15. Umkhawulo owehlukileyo we-endpoint ye-widget eyodwa ukhulunywa kuphela nxa ufakazelwe ngokucacileyo kuleyo endpoint. I-`message` kayisiyo idempotent; i-client kayimelanga iphinde ngokuzenzakalelayo ukuthumela okuqamuke kungacacanga ngaphandle kokuhlola kuqala ukuthi umlayezo wokuqala usuphethwe yini.

Ukuhlolwa kobuchwepheshe kwaleli qembu kusekelwe ku-Registry ku-`app/frontend/src/content/api-reference/groups/widget.ts` lemizileni ye-backend ehambelana layo. Ikhasi ngalinye lemininingwane liphawula ukuthi kuhlolwe indlela yempumelelo bukhoma, indlela embi kumbe ukufanisa lekhodi kuphela — lokhu kwehlukanisa kusebenza kulo lonke iqembu njalo akumelanga kuthathelwe indawo ngezitatimende zempumelelo ezijwayelekileyo.

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
← Inkomba ye-API