Gradnik za klepet

Vse končne točke, ki jih vgrajeni gradnik za klepet uporablja na spletnih straneh strank.

Ta skupina združuje vse javne končne točke, ki jih vdelani klepetalni gradnik uporablja na spletnih straneh strank: preverjanje dosegljivosti (`GET /api/public/widget/health`), pridobivanje javne konfiguracije gradnika (`GET /api/public/widget/config/:widget_code`) ter pošiljanje sporočil in zgodovino (`POST /api/public/widget/message`, `GET /api/public/widget/history`). Odobritev domene ob ustvarjanju gradnika vzdržuje Zentor; za to v nadzorni plošči najemnika ni nastavitvenega vmesnika. Pri neodobrenem izvoru se lahko pojavi koda napake `WIDGET_ORIGIN_DENIED`. Ustvarjanje gradnika je pridržano za Master Admin, najemnik pa prejme že pripravljeno kodo za vdelavo.

Splošnega sistema ključev API za razvijalce ni. `health` in `config` sta dostopna brez overjanja, ker sta namenjena inicializaciji gradnika v brskalniku. `message` in `history` pa zahtevata glavo `X-Widget-Token` in se dodatno preverjata glede na strežniški seznam dovoljenih izvorov (Origin-Allowlist). Token za vdelavo se ob ustvarjanju gradnika enkrat prikaže v golem besedilu in se ne sme pojaviti v javnih repozitorijih, posnetkih zaslona za podporo ali dnevnikih brskalnika.

Vsaka podrobna stran te skupine posamično opisuje metodo, pot, overjanje, idempotentnost in dokumentirane kode napak posamezne končne točke. Uspešen klic ene končne točke samodejno ne dokazuje, da bi bil klic druge končne točke iste skupine prav tako uspešen — zlasti zeleni preizkus `health` ne potrjuje niti veljavnega gradnika niti odobrenega izvora niti dosegljivosti ponudnika umetne inteligence.

Potrjena platformna omejitev API znaša 2.000 zahtev v 15 minutah. Drugačna omejitev za posamezno končno točko gradnika se navede le, če je za to končno točko izrecno dokazana. `message` ni idempotenten; odjemalec ne sme samodejno ponoviti nejasno prekinjenega pošiljanja, ne da bi prej preveril, ali je bilo prvo sporočilo že obdelano.

Tehnični pregled te skupine temelji na registru v `app/frontend/src/content/api-reference/groups/widget.ts` in pripadajočih poteh zaledja. Vsaka podrobna stran označuje, ali je bila preizkušena uspešna pot v živo, negativna pot ali le analogija s kodo — ta razlika velja za celotno skupino in je ne smejo nadomestiti splošne izjave o uspehu.

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
← Referenca API