Chat-widget
Kaikki päätepisteet, joita asiakasverkkosivustoilla käytettävä sisäänrakennettu chatinäkymä hyödyntää.
Tämä ryhmä kokoaa kaikki julkiset päätepisteet, joita sisäänrakennettu chatti-widget käyttää asiakasverkkosivustoilla: käytettävyystarkistus (`GET /api/public/widget/health`), julkisen widget-konfiguraation haku (`GET /api/public/widget/config/:widget_code`) sekä viestien lähetys ja -historia (`POST /api/public/widget/message`, `GET /api/public/widget/history`). Domainin käyttöoikeudet ylläpitää Zentor widgetin luonnin yhteydessä; tälle ei ole erillistä asetusten käyttöliittymää vuokralaisen kojelaudassa. Jos alkuperä ei ole sallittu, virhekoodi `WIDGET_ORIGIN_DENIED` voi esiintyä. Widgetin luonti on varattu pääkäyttäjälle, kun taas vuokralainen saa valmiin upotuskohteen.
Yleistä kehittäjille tarkoitettua API-avainjärjestelmää ei ole. `health` ja `config` ovat käytettävissä ilman tunnistautumista, koska ne on tarkoitettu widgetin alustamiseen selaimessa. `message` ja `history` vaativat kuitenkin `X-Widget-Token`-otsikon ja ne tarkistetaan lisäksi palvelinpuolen alkuperäluettelon avulla. Upotus-token näkyy selväkielisenä widgetin luonnin yhteydessä, eikä sitä saa esiintyä julkisissa repositorioissa, tukikuvissa tai selainlokeissa.
Jokainen tämän ryhmän yksityiskohtasivu kuvaa yksittäisten päätepisteiden menetelmän, polun, tunnistautumisen, idempotenssin ja dokumentoidut virhekoodit. Onnistunut päätepisteen kutsu ei automaattisesti takaa, että toinen saman ryhmän päätepiste toimisi myös onnistuneesti – erityisesti vihreä `health`-tarkistus ei vahvista kelvollista widgetiä, sallittua alkuperää tai tekoälypalveluntarjoajan saatavuutta.
Vahvistettu alustakohtainen API-raja on 2 000 pyyntöä 15 minuutin sisällä. Yksittäiselle widget-päätepisteelle mahdollisesti oleva poikkeava raja mainitaan vain, jos se on erikseen määritetty kyseiselle päätepisteelle. `message` ei ole idempotentti; asiakkaan ei pidä automaattisesti toistaa epäonnistunutta lähetystä, ennen kuin se on tarkistanut, onko ensimmäinen viesti jo käsitelty.
Tämän ryhmän tekninen validointi perustuu rekisteriin osoitteessa `app/frontend/src/content/api-reference/groups/widget.ts` ja siihen liittyviin taustapalvelinreitteihin. Jokainen yksityiskohtasivu ilmaisee, onko onnistumispolku käytössä, onko negatiivinen polku käytössä vai onko kyseessä vain koodianalyysi – tämä erottelu koskee koko ryhmää, eikä sitä saa korvata yleisillä onnistumislauseilla.