Изменения документа Для_разработчиков

Редактировал(а) Михаил Галич 26.11.2024, 12:16

От версии < 14.1 >

отредактировано Михаил Галич
на 12.12.2023, 11:11

К версии < 5.2 >

отредактировано Михаил Галич
на 11.12.2023, 13:56

Изменить комментарий: К данной версии нет комментариев

Необработанный
Обработанный

Комментарий

Свойства страницы (1 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Содержимое

@@ -1,15 +1,12 @@
--{{toc depth="3"/}}
++== Для разработчиков ==
--== Инструкция для подключения ==
--
  Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
--~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения
++~1. Подключите скрипт external.script.js к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения
 . Вставьте в необходимом месте на своём сайте код:
--{{code language="html"}}
--<script type="text/javascript">
++{{{<script type="text/javascript">
  // инициализируем виджет с параметрами
  WPInit({
      id: 1,
@@ -30,9 +30,9 @@
          // если заказ оплачен, занесём данные из response.data.order_id себе на сайт
      }
  }
--</script>
--{{/code}}
++</script>}}}
++
  == Функции ==
  === WPInit({params}) ===
@@ -47,14 +47,12 @@
  Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
--{{code language="javascript"}}
--WPInit({
++{{{WPInit({
      id: 1,
      width: 400,
      height: 600,
      type: 'modal'
--})
--{{/code}}
++})}}}
  === WPOpen({params}) ===
@@ -62,12 +62,10 @@
  ===== Пример передаваемых данных: =====
--{{code language="javascript"}}
--// показ виджета с группой id 5
++{{{// показ виджета с группой id 5
  WPOpen({
      groupid: [5]
--})
--{{/code}}
++})}}}
  === WPOpenModal({params}) ===
@@ -132,8 +132,6 @@
  **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
  )))
------
--
  ==== Возможные параметры WPOpen и WPOpenModal ====
  ===== Календарь и даты =====
@@ -161,8 +161,6 @@
  Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
  Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
------
--
  ===== Услуги, пакеты услуг, группы услуг =====
  ==== tariffsid: [29 ====
@@ -202,7 +202,7 @@
  Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
------
++~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
  ===== Предзаказ =====
@@ -220,155 +220,10 @@
  * date — дата, на которую покупается услуга
  * count — количество покупаемых услуг
++
  ===== Пример передаваемых данных: =====
--{{code language="javascript"}}
--// либо WPOpenModal({})
--WPOpen({
--    preorder: [
--    {
--        id: 57,
--        date: '06.06.2019',
--        count: 1
--    }, {
--        id: 58,
--        date: '07.06.2019',
--        count: 2
--        }
--    ]
--})
--{{/code}}
--===== Отображение =====
--==== forcetab: 'rewrite' ====
--Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab
--
--==== onlytab: 'rewrite' ====
--
--Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
--
--* onlytab: 'service' покажет только вкладку «покупка услуг».
--* onlytab: 'rewrite' покажет только вкладку «пополнение услуг».
--
--==== forcemedia: 'E0012345678900' ====
--
--Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
--
--==== nopromo: false ====
--
--Убирает вывод промокода на странице подтверждения заказа. По умолчанию false
--
--==== terminal: true ====
--
--Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
--
--==== cartmaxitems: 5 ====
--
--====  ====
--
--Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6
--
--==== cartminitems: 2 ====
--
--====  ====
--
--Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1
--
--==== locale: 'ru' ====
--
--====  ====
--
--Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
--
--==== ordercomment: 'Комментарий к заказу' ====
--
--====  ====
--
--Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
--
--==== disablemultipleseances: true ====
--
--====  ====
--
--Параметр предотвращает добавление в корзину тарифов с различными сеансами.
--Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
--По умолчанию false
--
--
--==== tariffsseancesfilter: true ====
--
--====  ====
--
--[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
--
--Включить отображение фильтра тарифов по сеансам. По умолчанию false
--
--==== resetcart: true ====
--
--====  ====
--
--Автоматически очищать содержимое корзины. По умолчанию false
--
--==== minimap: false ====
--
--====  ====
--
--Отображать миникарту. По умолчанию true
--
--==== minimapaspect: 0.5 ====
--
--====  ====
--
--Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
--
--==== forceseanceid: 42 ====
--
--====  ====
--
--Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
--
--==== forcesectorid: 42 ====
--
--====  ====
--
--Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
--
--==== requiredloyalty: true ====
--
--====  ====
--
--Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
--
--==== personallessonsskillstariffs: [56 ====
--
--==== , 57 ====
--
--==== , … ] ====
--
--====  ====
--
--Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
--
--==== multidayslessonsskillstariffs: [56 ====
--
--==== , 57 ====
--
--==== , … ] ====
--
--====  ====
--
--Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
--
--==== saletermstype: 'checkbox' ====
--
--====  ====
--
--Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
--
--* saletermstype: 'checkbox' потребует установку галочки для согласия.
--* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять.
--* saletermstype: 'default' принятие правил не требуется.
--
--По умолчанию 'default'
++