Документація для розробників: встановлення, налаштування в коді, інтеграції

Shukai — помічник у кутку сайту чи додатка: відповідає з контенту власника, відкриває сторінки, заповнює форми й натискає кнопки, говорить уголос і передає людей людині. Власник налаштовує його в панелі без коду. Розробник додає один рядок, який його встановлює, і, де потрібно, трохи розмітки та кілька слухачів подій.

Три рівні, у тому порядку, в якому вони вам знадобляться

Рівень 1 — встановити. Один тег <script>, скопійований із вкладки «Встановлення» в панелі. Для сайту це все: віджет читає мову сторінки, відповідає з сайту, який проіндексував власник, і сам виконує навігацію. Встановлення віджета.

Рівень 2 — зробити своїм. Токени теми на хост-елементі, власна кнопка запуску, кілька рядків JavaScript, щоб відкрити віджет чи щось у нього спитати, слухачі подій, які він надсилає, коли діє. Віджет.

Рівень 3 — дозволити діяти й викликати вас. Розмітьте форми, які він може заповнювати, і кнопку, що зберігає; оголосіть екрани свого додатка; опишіть один HTTP-виклик до вашого API, щоб він відповідав із живих даних; назвіть подію, яку малює ваша сторінка. Дії на сторінці, Інтеграції.

Два API

• Рантайм — те, з чим говорить віджет: WebSocket для розмови і кілька HTTP-ендпоінтів для мовлення, розпізнавання й маячків. Автентифікується публічним ключем віджета сайту і обмежується за origin. Потрібен лише для власного фронтенду. Runtime API.
• API керування — те, з чим говорить панель: сайти, джерела, помічники, віджети, інструменти, розмови, аналітика. Автентифікується секретним ключем керування. Потрібен, щоб автоматизувати панель. Management API.

Спитайте помічника

Кожна сторінка цієї документації є в базі знань самого помічника. Віджет у кутку відповідає на питання про неї — «як позначити кнопку, що зберігає?» — і відкриває сторінку, де це написано.

Що де