Вбудовування редактора

Тут ви налаштуєте те, що потрібно вашим розробникам, щоб відкрити редактор HotLayout усередині вашої власної адмінки: дозволені домени, ключ і облік людей.

Що таке вбудовування#

З вбудовуванням редактор відкривається на сторінці вашої адмінки, а не в адмінці HotLayout. Ваші люди входять у вашу систему й не потребують облікового запису HotLayout чи другого пароля.

Працює це так:

Ваші розробники вантажать редактор з нашого домену й ставлять його на сторінку.
Коли людина відкриває цю сторінку, ваш сервер просить у HotLayout одноразовий квиток для неї. Він робить це ключем вбудовування. Квиток живе хвилину й спрацьовує один раз.
Сторінка передає квиток редактору, і редактор відкривається.

Бік розробників описано в посібнику з інтеграції, у розділі Embedding the builder. Ця сторінка — про те, що ви, власник чи адміністратор, налаштовуєте в адмінці.

Відкрийте сторінку#

В адмінці відкрийте Вбудовування в меню організації. Користуватися нею можуть лише власник і адміністратори. Інші учасники бачать пояснення, що вбудовуванням керують власник і адміністратори.

Якщо ваш тариф не включає вбудовування, сторінка каже Не входить у ваш тариф: вбудовування входить у тариф Embedded, і налаштовувати нічого, доки його не додано. Скористайтеся посиланням для зв'язку на цій сторінці, щоб додати.

Якщо ліцензія скінчилася, сторінка каже про це й зберігає ваші налаштування. Доки ліцензія знову не чинна, кожен вхід через вбудовування відхиляється.

Дозволені домени#

У Дозволені домени ви перелічуєте сайти, де редактор може відкриватися. Він відкривається лише на сторінках, чия адреса є в цьому переліку.

Впишіть адресу в поле Домен. Пишіть точне походження: схему, хост і порт, якщо він є, і нічого після. Наприклад, https://admin.example.com або http://localhost:3000 на час розробки.
Натисніть Додати.

Правила:

Шаблонів і піддоменів немає. https://admin.example.com і https://app.example.com — це два записи. Інший порт — теж інший запис.
http дозволено лише для localhost.
Адресу можна вставити так, як вона виглядає в рядку браузера: великі літери, коса риска в кінці, типовий порт (:443) і кирилична назва зводяться до форми, яку шле браузер.
Шлях (https://admin.example.com/editor) не є походженням; сторінка так і скаже.
В організації може бути до 20 доменів.

Щоб прибрати сайт з переліку, натисніть Прибрати поруч із ним. Редактор перестане там відкриватися.

Якщо поки ви були на сторінці, перелік змінив хтось інший, вашу зміну не збережено, а сторінка покаже те, що лежить у сховищі зараз. Перевірте й повторіть зміну.

Перелік захищає в одному конкретному сенсі: квиток приймається лише зі сторінки домену з переліку й лише один раз. Квитка він не робить таємним. Хто отримає квиток, вирішує ваш сервер.

Ключ вбудовування#

Ключ — це пароль вашого сервера до HotLayout. Ним ваш сервер просить квитки.

У Ключ вбудовування натисніть Створити ключ.
Ключ показано у вікні. Натисніть Скопіювати ключ і покладіть його в секрети вашого сервера.
Натисніть Ключ збережено.

Ключ показується лише один раз. Він лишається на екрані, доки ви не підтвердите, що зберегли його, і зникає, коли вкладку закрито. Прочитати його знову не зможе ніхто, навіть ви. Якщо ключ загубився, замініть його.

Ставтеся до ключа як до майстер-ключа: хто його має, може відкрити редактор від імені будь-кого з ваших людей. Тримайте його лише на сервері, ніколи в коді сторінки чи застосунку.

Замінити ключ створює новий ключ і просить підтвердити. Старий ключ перестає діяти одразу, тож вашому серверу відмовлятимуть, доки він не візьме новий; виданими старим ключем квитками теж не ввійти. Люди, які вже в редакторі, лишаються в ньому до кінця свого сеансу (до 8 годин); щоб обірвати їх одразу, приберіть їх у розділі Учасники.
Вимкнути теж просить підтвердити. Ключ перестає діяти одразу, і ніхто не ввійде через вбудовування, доки ви не створите новий. Видані квитки теж перестають діяти, а люди, які вже в редакторі, лишаються в ньому до кінця свого сеансу (до 8 годин).

Люди й сеанси#

Люди й сеанси показує, хто користується редактором через вбудовування.

Рядок на зразок «Людей у редакторі: 3 з 25» каже, скільки людей рахується в тарифі й яка межа. Коли число є лише нижньою оцінкою, рядок каже «щонайменше». Натисніть Оновити, щоб прочитати знову.
Людина рахується, коли вона відкривала редактор із доступом «Редагування» чи «Публікація» за останні 30 днів. Люди з доступом «Перегляд» не рахуються.
Останні сеанси — перелік останніх сеансів: хто, з яким доступом (Перегляд, Редагування чи Публікація) і з якого домену. Квиток, який видано, але ще не використано, має позначку «квиток не використано». Якщо останню спробу відкрити редактор відхилено, рядок каже про це й називає причину, наприклад чужий домен чи місця в тарифі, що закінчилися.

Хто який доступ дістає, вирішує ваша система: ваш сервер називає рівень, коли просить квиток. HotLayout ніколи не дає більше, ніж Публікація.

Коли межу досягнуто, нову людину відхиляють, доки не звільниться місце. Ті, хто вже рахується, доступ зберігають. Прибрання людини зі списку учасників місця одразу не звільняє: воно звільняється само за 30 днів після її останнього сеансу редагування. Щоб підняти межу, напишіть команді HotLayout (див. Пробний період і ліцензія).

Люди з вбудовування в списку команди#

На сторінці Команда люди, що прийшли через вбудовування, мають позначку «через вбудовування». Вони показані з іменем, яке дала ваша система, або з її ідентифікатором, бо пошти в них немає. Їхню роль на кожному вході задає ваша система: переглядач, редактор чи публікатор.

Змінена в адмінці HotLayout роль не втримається, а прибрання такої людини діє лише до її наступного входу. Щоб змінити доступ, змініть його у вашій системі. Див. Команда й ролі.

Якщо щось не працює#

Людина, яка відкриває редактор, бачить «Не вдалося почати сеанс редактора» й причину. Найчастіші:

Сайту немає в переліку дозволених доменів: додайте його в Дозволені домени так, як браузер показує адресу.
Ліцензія не чинна або не включає вбудовування.
Межу людей досягнуто.
Квиток зі сторінки невідомий, використаний або прострочений. Це для ваших розробників; квитки працюють один раз і хвилину.

Повний перелік причин розробники знайдуть у посібнику з інтеграції.