Различия

Показаны различия между двумя версиями страницы.

--- tech:api:embed_writing_form [2023/03/23 03:52]
dmitry_kalashnikov
+++ tech:api:embed_writing_form [2023/09/11 04:34] (текущий)
dmitry_kalashnikov
@@ Строка 1: / Строка 1: @@
 ====== Встраивание формы написания диктанта ======
-===== Пример встроенной формы =====
-Пример встроенного тестового диктанта можно увидеть на странице https://diktado.com/embedded
 ===== Код встраивания =====
 Ниже представлен полный код HTML-страницы для встраивания формы написания диктанта.
-Выбран тестовый диктант ("Выдумщик") и тестовый пользователь, поэтому можно писать диктант без предварительной регистрации, а также вставлять готовый текст в форму ввода (временно не работает).
+Выбран тестовый диктант ("Выдумщик") и тестовый пользователь, поэтому можно писать диктант без предварительной регистрации.
-Предварительная регистрация включает в себя ввод имени и адреса электронной почты. Подтверждение почты не требуется, чтобы исключить проблемы с регистрацией и в целом её упростить.
+Предварительная регистрация включает в себя ввод имени и адреса электронной почты. Подтверждение почты не требуется, чтобы исключить проблемы с процедурой и в целом её упростить.
-Чтобы появилось окно предварительной регистрации, необходимо из скрипта убрать строчку с заданием ''userId''. В этом режиме вставка в поле ввода запрещается.
+Чтобы окно предварительной регистрации исчезло, необходимо в скрипте раскомментировать строчку с определением параметра ''customerUserId'' и передавать туда идентификатор пользователя из внешней системы Заказчика. Это может быть любое строковое значение, в том числе email.
 <code javascript >
@@ Строка 29: / Строка 26: @@
       diktado.dict.app.init({ // вызов функции для отрисовки формы написания диктанта (или отчёта, если диктант уже писали)
         key: "63fdc5cc7f0ae915a5fc30df", // ключ заказчика диктанта
-        userId: "63ff08b25d838a2905793493", //ключ тестового пользователя (test@diktado.com), если убрать это поле, то появится предварительное окно регистрации
+        //customerUserId: "123456", // идентификатор пользователя из внешней системы, если убрать это поле, то появится предварительное окно регистрации
         container: '#dict-container', // селектор html-элемента, куда нужно отрисовать форму написания или отчёт, в формате jQuery
         dictId: "62c2b81356a90881f1155a6d",  // идентификатор диктанта (тестовый, "Выдумщик")
@@ Строка 49: / Строка 46: @@
+===== Пример встроенной формы =====
+Пример встроенного тестового диктанта на чистую страницу https://diktado.com/embedded
 ===== Тестовый диктант =====
@@ Строка 69: / Строка 69: @@
 ===== Кабинет организатора корпоративного диктанта =====
-Для доступа в кабинет организатора необходимо авторизоваться на веб-сайте https://diktado.com/ под аккаунтом ''test@diktado.com'' (пароль сообщается отдельно).
+Для полноценного тестирования встроенного тестового диктанта нужно авторизоваться в кабинете организатора:
+  * авторизуйтесь на веб-сайте https://diktado.com/login/ под аккаунтом ''test@diktado.com'' (пароль ''testdiktado'');
+  * в правом верхнем меню профиля выберите пункт "Корпоративные диктанты", далее диктант "Выдумщик".
-В правом верхнем меню профиля выбирается пункт "Корпоративные диктанты", далее диктант "Выдумщик".
+Внутри кабинета можно увидеть список написавших, отчёты о проверке и статистику по оценкам. Именно так выглядит кабинет организатора для любого встроенного диктанта.
-Внутри кабинета можно увидеть список написавших и отследить статистику по оценкам.
-Именно так выглядит кабинет организатора для любого встроенного диктанта.
 ===== Параметры встраивания =====
-Для запуска боевого (не тестового) диктанта следует прописать в коде встраивания (JavaScript'е, что приведён выше) два параметра:
+Для запуска боевого (не тестового) диктанта следует изменить в коде встраивания, который приведён выше, два параметра:
-  * ''key'' (ключ заказчика)
+  * ''key'' (Ключ заказчика)
-  * ''dictId'' (идентификатор диктанта).
+  * ''dictId'' (Идентификатор диктанта).
-Их можно найти в кабинете организатора диктанта.
-  - Авторизуйтесь на сайте https://diktado.com/ под учётной записью организатора.
-  - Выберите в меню "Мой профиль" подменю "Корпоративные диктанты", далее откройте свой диктант.
-  - Откройте параметры диктанта — справа от ссылки на страницу диктанта (см. скриншот).
-  - Скопируйте ключ заказчика и идентификатор диктанта.
-  - Вставьте ключ и идентификатор в код встраивания на своём сайте.
-{{:tech:api:2023-03-23_10-46-59.png?600|}}
+Эти параметры для конкретного диктанта можно найти в кабинете [[corporate/cabinet#nastrojki_diktanta|организатора диктанта]].
+Также следует сообщить Администратору домен, в который будет встроен диктант (полный URL, например: ''https://mycompany.ru/dictant/''), чтобы он прописал нужные разрешения.