public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
Autentifikacija
Ova je krajnja točka javna. Ne zahtijeva nikakve vjerodajnice ni organizaciju – to je ono što čitaju naše vlastite marketinške stranice i AI strojevi za odgovore.
Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X GET https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/configPrijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
publicKey (path) | string | Da | The agent's public key, as carried in the embed snippet. |
locale (query) | string | Ne | The visitor's language tag (the page's lang, else the browser's). Chooses the language of strings; an unknown tag answers in English. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
name | string | Da | — |
greeting | string | Da | — |
brand_colour | string | Ne | — |
launcher_position | string<left, right> | Ne | — |
handoff_enabled | boolean | Ne | — |
strings | object | Ne | 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). ⛔… |
Pogreške koje ova krajnja točka može vratiti
404 · 429