Chat widget

Ma-endpoint ose anoshandiswa newidget yechat yakaiswa pamawebhusaiti evatengi.

Boka iri rinounganidza maendpoint ese eruzhinji anoshandiswa nechat widget yakaiswa pamawebhusaiti evatengi: kuongorora kusvikika (`GET /api/public/widget/health`), kutora marongero eruzhinji eWidget (`GET /api/public/widget/config/:widget_code`) pamwe nekutumira mameseji nenhoroondo (`POST /api/public/widget/message`, `GET /api/public/widget/history`). Kubvumidzwa kwemadomain kunotarisirwa neZentor pakugadzirwa kweWidget; hapana interface yemarongero pazviri muDashboard yeTenant. Kana nzvimbo yekwakabva isina kubvumidzwa, kodhi yekukanganisa `WIDGET_ORIGIN_DENIED` inogona kuitika. Kugadzirwa kweWidget pachako kwakachengeterwa Master Admin, nepo Tenant ichigamuchira kodhi yekuisa yapedzwa.

Hapana sisitimu yemakiyi eAPI evagadziri yakajairika. `health` ne`config` zvinosvikika pasina kusimbiswa, nokuti zvakagadzirirwa kutangisa Widget mubrowser. `message` ne`history`, kune rimwe divi, zvinoda header ye`X-Widget-Token` uye zvinowedzera kuongororwa neOrigin allowlist iri kuserver. Embed token inoratidzwa kamwe chete nemashoko akajeka pakugadzirwa kweWidget uye haifanirwe kuoneka mumarepository eruzhinji, mumascreenshot erubatsiro kana mumalog ebrowser.

Peji rega rega rakadzama reboka iri rinotsanangura method, path, kusimbiswa, idempotency nemakodhi ekukanganisa akanyorwa eendpoint yega yega zvakasiyana. Kufona kwakabudirira kweendpoint imwe hakuratidze pachako kuti imwe endpoint yeboka rimwe chete ingabudirirawo — kunyanya, cheki ye`health` yegirinhi hairatidzi Widget inoshanda, Origin yakabvumidzwa kana kusvikika kwemupi weAI.

Muganhu weAPI wepuratifomu yese wakasimbiswa zvikumbiro 2.000 mukati memaminitsi 15. Muganhu wakasiyana weendpoint imwe chete yeWidget unodudzwa chete kana uine humbowo hwakajeka hweendpoint iyoyo. `message` haisi idempotent; client haifanirwe kudzokorora pachayo kutumira kwakadambuka zvisina kujeka isati yaongorora kana meseji yekutanga yatogadziriswa.

Kuongororwa kwehunyanzvi kweboka iri kunovakirwa paregistry iri pasi pe`app/frontend/src/content/api-reference/groups/widget.ts` nenzira dzebackend dzakabatana nayo. Peji rega rega rakadzama rinoratidza kana nzira yekubudirira yakaongororwa live, nzira yakaipa, kana kufanana kwekodhi chete — musiyano uyu unoshanda kuboka rese uye haufanirwe kutsiviwa nezvirevo zvekubudirira zvakapararira.

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
← Rondedzero yeAPI