public
GET /v1/public/chat/{publicKey}/config
What the chat widget on this site should look like.
Автентифікація
Ця кінцева точка є публічною. Вона не потребує жодних облікових даних чи організації — це те, що читають наш власний маркетинговий сайт та пошукові системи на основі штучного інтелекту.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/configУвійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Anonymous — no credential, no tenant. The widget calls this to learn its greeting, colour, position and whether a person is likely to answer right now. The publicKey names a widget and authorises nothing: it ships in the page source of every site that embeds the widget, exactly like a publishable key. What actually gates the call is the Origin header, which must be one the customer listed on the widget. An unknown key, a disabled widget and an unlisted origin all answer 404 alike — which of the three it is is the customer's business, and distinguishing them would make this an oracle about other people's accounts. ⭐ The WordPress plugin never calls this: it already holds these settings server-side and inlines them into the page, so a WordPress visitor's browser makes no request at all until they open the chat.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
publicKey (path) | string | Так | The widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is… |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
widget_id | string | Так | — |
team_name | string | Ні | — |
greeting | string | Ні | — |
accent_colour | string | Ні | — |
position | string<left, right> | Ні | — |
branding | boolean | Так | Whether "Powered by Zinn® Chat" is shown. Decided by the TIER, not by the widget's own flag — a customer who downgrades stops hiding our mark without anybody editing their… |
ai_enabled | boolean | Ні | — |
online | boolean | Так | Whether a person is likely to answer, from the customer's declared business hours. Not operator presence: that would need the dashboard to hold a socket open, which this design… |
Помилки, які може повертати ця кінцева точка
404 · 429