public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
Упълномощаване
Този крайpoint е публичен. Той не изисква данни за удостоверяване и организация — това е съдържанието, което нашият собствен маркетинг сайт и AI машини за отговори четат.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/configВлязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
publicKey (path) | string | Да | The agent's public key, as carried in the embed snippet. |
locale (query) | string | Не | The visitor's language tag (the page's lang, else the browser's). Chooses the language of strings; an unknown tag answers in English. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
name | string | Да | — |
greeting | string | Да | — |
brand_colour | string | Не | — |
launcher_position | string<left, right> | Не | — |
handoff_enabled | boolean | Не | — |
strings | object | Не | 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). ⛔… |
Грешки, които този крайpoint може да върне
404 · 429