public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
Tabbatar da Asali
Wannan yankin ƙarshen jama'a ne. Ba ya ɗaukar wata takardar shaida ko ƙungiya — shi ne abin da shafin kasuwancinmu da injunan amsa na AI ke karantawa.
Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.
Gwada
May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.
curl -X GET https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/configAn shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API
Bayani
Unauthenticated by necessity: a visitor on a customer's website has no account, and that is the product. Everything returned is already visible to whoever is reading that page — a name, a greeting and a colour. There is no secret here, no organisation id and no site id. ⛔ Answers 404 both when the key is unknown and when the calling Origin is not one the customer authorised. One answer for two causes, deliberately: a distinguishable refusal would tell a stranger that a key is real and merely mis-embedded, which is an enumeration oracle over every customer who owns this product.
Sigogi
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
publicKey (path) | string | Eh | The agent's public key, as carried in the embed snippet. |
locale (query) | string | A'a | The visitor's language tag (the page's lang, else the browser's). Chooses the language of strings; an unknown tag answers in English. |
Martani
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
name | string | Eh | — |
greeting | string | Eh | — |
brand_colour | string | A'a | — |
launcher_position | string<left, right> | A'a | — |
handoff_enabled | boolean | A'a | — |
strings | object | A'a | The widget's own words — button labels, placeholder, greeting fallback, error line — in the language asked for by ?locale= (the nearest of the 58 site locales, else English). ⛔… |
Kuskuren da wannan matsaya za ta iya maido wa
404 · 429