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

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

От версии < 6.2 >

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

К версии < 17.1 >

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

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

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

Комментарий

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

Подробности

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

Содержимое

@@ -1,12 +1,15 @@
--== Для разработчиков ==
++{{toc depth="4"/}}
++= Инструкция для подключения =
++
  Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
--~1. Подключите скрипт external.script.js к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения
++~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения
 . Вставьте в необходимом месте на своём сайте код:
--{{{<script type="text/javascript">
++{{code language="html"}}
++<script type="text/javascript">
  // инициализируем виджет с параметрами
  WPInit({
      id: 1,
@@ -27,13 +27,13 @@
          // если заказ оплачен, занесём данные из response.data.order_id себе на сайт
      }
  }
--</script>}}}
++</script>
++{{/code}}
++= Функции =
--== Функции ==
++== WPInit({params}) ==
--=== WPInit({params}) ===
--
  Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
  ===== Минимальный способ инициализации: =====
@@ -44,25 +44,29 @@
  Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
--{{{WPInit({
++{{code language="javascript"}}
++WPInit({
      id: 1,
      width: 400,
      height: 600,
      type: 'modal'
--})}}}
++})
++{{/code}}
--=== WPOpen({params}) ===
++== WPOpen({params}) ==
  Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'
  ===== Пример передаваемых данных: =====
--{{{// показ виджета с группой id 5
++{{code language="javascript"}}
++// показ виджета с группой id 5
  WPOpen({
      groupid: [5]
--})}}}
++})
++{{/code}}
--=== WPOpenModal({params}) ===
++== WPOpenModal({params}) ==
  Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
@@ -70,7 +70,7 @@
  {{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
--=== WPChange({status, data}) ===
++== WPChange({status, data}) ==
  Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
@@ -83,17 +83,32 @@
  ===== Пример работы с данными: =====
--{{{WPChange = function(response) { if (response.status == 'starting') { // действие на внешней странице } if (response.status == 'started') { // действие на внешней странице } if (response.status == 'reserved') { // id зарезервированного заказа: response.data.order_id } if (response.status == 'completed') { // id оплаченного заказа: response.data.order_id } }}}}
++{{code language="javascript"}}
++WPChange = function(response) {
++    if (response.status == 'starting') {
++        // действие на внешней странице
++    }
++    if (response.status == 'started') {
++        // действие на внешней странице
++    }
++    if (response.status == 'reserved') {
++        // id зарезервированного заказа: response.data.order_id
++    }
++    if (response.status == 'completed') {
++        // id оплаченного заказа: response.data.order_id
++    }
++}
++{{/code}}
--== Параметры ==
++= Параметры =
--==== Обязательные параметры WPInit ====
++== Обязательные параметры WPInit ==
  ==== id: 1 ====
  id виджета, который можно узнать в Административной панели
--==== Возможные параметры WPInit ====
++== Возможные параметры WPInit ==
  ==== height: 480 ====
@@ -125,11 +125,11 @@
  **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
  )))
--==== ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-- ====
++----
--==== Возможные параметры WPOpen и WPOpenModal ====
++== Возможные параметры WPOpen и WPOpenModal ==
--===== Календарь и даты =====
++=== Календарь и даты ===
  ==== nocalendar: false ====
@@ -147,45 +147,31 @@
  Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
--==== disableddates: ['23.02.2019' ====
++==== disableddates: ['23.02.2019', … ] ====
--==== , … ] ====
--
  Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
  Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
--~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
++----
--===== Услуги, пакеты услуг, группы услуг =====
++=== Услуги, пакеты услуг, группы услуг ===
--==== tariffsid: [29 ====
++==== tariffsid: [29, 30, … ] ====
--==== , 30 ====
--
--==== , … ] ====
--
  Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
  Пример использования:
  tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
  tariffsid: false уберёт все тарифы с первой страницы
--==== rtariffsid: [56 ====
++==== rtariffsid: [56, 57, … ] ====
--==== , 57 ====
--
--==== , … ] ====
--
  Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
  Пример использования:
  rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
  tariffsid: false уберёт все тарифы с первой страницы
--==== bundlesid: [4 ====
++==== bundlesid: [4, 5, … ] ====
--==== , 5 ====
--
--==== , … ] ====
--
  Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
  Пример использования:
  bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
@@ -195,18 +195,12 @@
  Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
--~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
++----
--===== Предзаказ =====
++=== Предзаказ ===
--==== preorder: [{id: 57 ====
++==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ====
--==== , date: '06.06.2019' ====
--
--==== , count: 1 ====
--
--==== }, … ] ====
--
  Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
  * id — id услуги к покупке
@@ -215,7 +215,8 @@
  ===== Пример передаваемых данных: =====
--{{{// либо WPOpenModal({})
++{{code language="javascript"}}
++// либо WPOpenModal({})
  WPOpen({
      preorder: [
      {
@@ -228,9 +228,10 @@
          count: 2
          }
      ]
--})}}}
++})
++{{/code}}
--===== Отображение =====
++=== Отображение ===
  ==== forcetab: 'rewrite' ====
@@ -243,7 +243,6 @@
  * onlytab: 'service' покажет только вкладку «покупка услуг».
  * onlytab: 'rewrite' покажет только вкладку «пополнение услуг».
--
  ==== forcemedia: 'E0012345678900' ====
  Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
@@ -258,40 +258,39 @@
  ==== 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"]]
@@ -299,63 +299,55 @@
  ==== resetcart: true ====
--====   ====
++====  ====
  Автоматически очищать содержимое корзины. По умолчанию false
  ==== minimap: false ====
--====   ====
++====  ====
  Отображать миникарту. По умолчанию true
  ==== minimapaspect: 0.5 ====
--====   ====
++====  ====
  Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
  ==== forceseanceid: 42 ====
--====   ====
++====  ====
  Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
  ==== forcesectorid: 42 ====
--====   ====
++====  ====
  Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
  ==== requiredloyalty: true ====
--====   ====
++====  ====
  Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
--==== personallessonsskillstariffs: [56 ====
++==== personallessonsskillstariffs: [56, 57, … ] ====
--==== , 57 ====
++====  ====
--==== , … ] ====
--
--====   ====
--
  Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
--==== multidayslessonsskillstariffs: [56 ====
++==== multidayslessonsskillstariffs: [56, 57, … ] ====
--==== , 57 ====
++====  ====
--==== , … ] ====
--
--====   ====
--
  Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
  ==== saletermstype: 'checkbox' ====
--====   ====
++====  ====
  Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
@@ -364,7 +364,3 @@
  * saletermstype: 'default' принятие правил не требуется.
  По умолчанию 'default'
--
--
--
--