public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
Uwierzytelnianie
Ten punkt końcowy jest publiczny. Nie wymaga żadnych poświadczeń ani organizacji — to z niego korzysta nasza własna strona marketingowa oraz silniki odpowiedzi AI.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/configZalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
publicKey (path) | string | Tak | The agent's public key, as carried in the embed snippet. |
locale (query) | string | Nie | The visitor's language tag (the page's lang, else the browser's). Chooses the language of strings; an unknown tag answers in English. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
name | string | Tak | — |
greeting | string | Tak | — |
brand_colour | string | Nie | — |
launcher_position | string<left, right> | Nie | — |
handoff_enabled | boolean | Nie | — |
strings | object | Nie | 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). ⛔… |
Błędy, które ten punkt końcowy może zwrócić
404 · 429