Чат-віджет

Усі ендпоінти, які використовує вбудований чат-віджет на сайтах клієнтів.

Ця група об'єднує всі публічні кінцеві точки, які використовує вбудоване відріт чату на сайтах клієнтів: перевірку доступності (`GET /api/public/widget/health`), отримання конфігурації відріту (`GET /api/public/widget/config/:widget_code`), а також відправку та історію повідомлень (`POST /api/public/widget/message`, `GET /api/public/widget/history`). Дозвіл на домен підтримується Zentor під час створення відріту; налаштування для цього відсутні в панелі керування тенанта. У разі недопустимої провідності може виникнути код помилки `WIDGET_ORIGIN_DENIED`. Створення відріту є виключною компетенцією адміністратора Master, тоді як тенант отримує готовий код вбудовування.

Загальна система ключів для розробників API не існує. `health` та `config` доступні без аутентифікації, оскільки вони призначені для ініціалізації відріту в браузері. `message` та `history`, навпаки, вимагають заголовка `X-Widget-Token` та додатково перевіряються проти серверного списку дозволених провідностей (Origin-Allowlist). Embed-Token під час створення відріту відображається один раз у відкритому вигляді і не повинен з'являтися в публічних репозиторіях, скріншотах підтримки або логах браузера.

Кожна детальна сторінка цієї групи окремо описує метод, шлях, аутентифікацію, ідентичність та задокументовані коди помилок відповідного кінцевого пункту. Успішний виклик одного кінцевого пункту не гарантує автоматично успішного виклику іншого кінцевого пункту тієї ж групи — зокрема, зелений статус перевірки `health` не підтверджує наявність дійсного відріту, дозволу провідності чи доступності постачальника ШІ.

Підтверджене загальноплатформове обмеження API становить 2.000 запитів протягом 15 хвилин. Відмінне від цього обмеження для окремого кінцевого пункту відріту вказується лише у випадку, якщо це явно підтверджено для цього пункту. `message` не є ідентичним; клієнт не повинен автоматично повторювати невизначено перерваний процес відправки без попередньої перевірки, чи була вже оброблена перша повідомлення.

Технічна перевірка цієї групи базується на реєстрі за адресою `app/frontend/src/content/api-reference/groups/widget.ts` та відповідних маршрутах бекенду. Кожна детальна сторінка вказує, чи перевірявся шлях успіху, шлях негативу чи лише аналогія коду — ця розрізнення стосується всієї групи і не може замінюватися загальними твердженнями про успіх.

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← Довідник API