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