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

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

От версии < 13.1 >

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

К версии < 26.1 >

отредактировано Михаил Галич
на 13.12.2023, 12:44

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

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

Комментарий

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

Подробности

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

Содержимое

@@ -1,10 +1,9 @@
--
++{{toc depth="4"/}}
++= Инструкция для подключения =
--== Для разработчиков ==
++Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
--Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
--
  ~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения
 . Вставьте в необходимом месте на своём сайте код:
@@ -34,15 +34,17 @@
  </script>
  {{/code}}
--== Функции ==
++= Функции =
--=== WPInit({params}) ===
++== WPInit({params}) ==
  Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
  ===== Минимальный способ инициализации: =====
--* WPInit({ id: 1 })
++{{code language="javascript"}}
++WPInit({ id: 1 })
++{{/code}}
  ===== Пример передаваемых данных: =====
@@ -57,9 +57,9 @@
  })
  {{/code}}
--=== WPOpen({params}) ===
++== WPOpen({params}) ==
--Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'
++Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'##
  ===== Пример передаваемых данных: =====
@@ -70,62 +70,101 @@
  })
  {{/code}}
--=== WPOpenModal({params}) ===
++== WPOpenModal({params}) ==
--Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
++Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'##
  ===== Пример передаваемых данных: =====
--{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
++{{code language="javascript"}}
++// показ виджета на нажатие кнопки с id "OpenButton"
++var OpenButton = document.getElementById('OpenButton');
++OpenButton.onclick = function () {
++    WPOpenModal({ tariffsid: [27, 28] });
++};
++{{/code}}
--=== WPChange({status, data}) ===
++== WPChange({status, data}) ==
  Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
  ===== Примеры передаваемых данных: =====
--* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
--* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки
--* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id
--* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа
++* ##{ status:'starting' }## — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
++* ##{ status:'started' }## — виджет на начальном экране, где показывается список услуг для покупки
++* ##{ status:'reserved', data: { order_id: 2 } }## — виджет находится на стадии забронированного заказ, в data передаётся id
++* ##{ status:'completed', data: { order_id: 2 } }## — виджет находится на стадии оплаченного заказ, в data передаётся id заказа
  ===== Пример работы с данными: =====
--{{{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 ====
++Тип данных:## //number//##
++
  id виджета, который можно узнать в Административной панели
--==== Возможные параметры WPInit ====
++== Возможные параметры WPInit ==
--==== height: 480 ====
++==== height ====
++Тип данных:## //number //##//|## boolean##//
++
++По умолчанию:##// false//##
++
  Высота виджета в пикселях, по умолчанию:
  * 480px, если виджет запущен как type: 'modal'
  * 100%, если виджет запущен как type: 'instant'
--==== width: 640 ====
++==== width ====
++Тип данных:## //number //##//|## boolean##//
++
++По умолчанию:##// false//##
++
  Ширина виджета в пикселях, по умолчанию:
  * 640px, если виджет запущен как type: 'modal'
  * 100%, если виджет запущен как type: 'instant'
--==== type: 'modal' ====
++==== type ====
--Способ открытия виджета, по умолчанию 'instant':
++Тип данных:## //string//##
++По умолчанию:##// 'instant'//##
++
++Способ открытия виджета
++
  * 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
  * 'modal' Открытие виджета в модальном окне
--==== place: '#place' ====
++==== place ====
++Тип данных:## //string //##//|## boolean##//
++
++По умолчанию:##// false//##
++
  Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'
  (% class="box warningmessage" %)
@@ -135,86 +135,124 @@
  ----
--==== Возможные параметры WPOpen и WPOpenModal ====
++== Возможные параметры WPOpen и WPOpenModal ==
--===== Календарь и даты =====
++=== Календарь и даты ===
--==== nocalendar: false ====
++==== disableddates ====
--Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false
++Тип данных:##// Array<string>//##
--==== mindate: '01.01.2019' ====
++По умолчанию:##// []//##
--Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
++Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
++Пример использования:
--==== maxdate: '01.01.2020' ====
++{{code language="javascript"}}
++disableddates: ['23.02.2018', '08.03.2018']
++{{/code}}
--Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
++уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
--==== forcedate: '12.06.2019' ====
++==== forcedate ====
++Тип данных:##// string//##
++
++По умолчанию:##// undefined//##
++
  Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
--==== disableddates: ['23.02.2019' ====
++==== maxdate ====
--==== , … ] ====
++Тип данных:##// string//##
--Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
--Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
++По умолчанию:##// undefined//##
++Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
++
++==== mindate ====
++
++Тип данных:##// string//##
++
++По умолчанию:##// undefined//##
++
++Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
++
++==== nocalendar ====
++
++Тип данных:## //boolean//##
++
++По умолчанию:##// false//##
++
++Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна.
++
  ----
--===== Услуги, пакеты услуг, группы услуг =====
++=== Услуги, пакеты услуг, группы услуг ===
--==== tariffsid: [29 ====
++==== tariffsid ====
--==== , 30 ====
++Тип данных:##// Array<number> //##//|## boolean##//
--==== , … ] ====
++По умолчанию:##// []//##
  Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
++
  Пример использования:
--tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
--tariffsid: false уберёт все тарифы с первой страницы
--==== rtariffsid: [56 ====
++{{code language="javascript"}}
++tariffsid: [29, 30] // покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
++tariffsid: false // уберёт все тарифы с первой страницы
++{{/code}}
--==== , 57 ====
++==== rtariffsid ====
--==== , … ] ====
++Тип данных:##// Array<number> //##//|## boolean##//
++По умолчанию:##// []//##
++
  Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
++
  Пример использования:
--rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
--tariffsid: false уберёт все тарифы с первой страницы
--==== bundlesid: [4 ====
++{{code language="javascript"}}
++rtariffsid: [56, 57] // покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
++rtariffsid: false // уберёт все тарифы во вкладке «Пополнение услуг»
++{{/code}}
--==== , 5 ====
++==== bundlesid ====
--==== , … ] ====
++Тип данных:##// Array<number> //##//|## boolean##//
++По умолчанию:##// []//##
++
  Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
++
  Пример использования:
--bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
--bundlesid: false уберёт все пакеты услуг с первой страницы
--==== groupid: 12 ====
++{{code language="javascript"}}
++bundlesid: [4, 5] // покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
++bundlesid: false // уберёт все пакеты услуг с первой страницы
++{{/code}}
++==== groupid ====
++
++Тип данных:##// number//##
++
++По умолчанию:##// undefined//##
++
  Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
  ----
--===== Предзаказ =====
++=== Предзаказ ===
--==== preorder: [{id: 57 ====
++==== preorder ====
--==== , date: '06.06.2019' ====
++Тип данных:##// Array<object>//##
--==== , count: 1 ====
++По умолчанию:##// undefined//##
--==== }, … ] ====
--
  Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
  * id — id услуги к покупке
@@ -240,136 +240,186 @@
  })
  {{/code}}
--===== Отображение =====
++=== Отображение ===
--==== forcetab: 'rewrite' ====
++==== forcetab ====
--Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab
++Тип данных:##// string//##
--==== onlytab: 'rewrite' ====
++По умолчанию:##// ''//##
++Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab##
++
++==== onlytab ====
++
++Тип данных:##// string //##//|## Array<string>##//
++
++По умолчанию:##// []//##
++
  Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
--* onlytab: 'service' покажет только вкладку «покупка услуг».
--* onlytab: 'rewrite' покажет только вкладку «пополнение услуг».
++{{code language="javascript"}}
++onlytab: 'service' // покажет только вкладку «покупка услуг».
++onlytab: 'rewrite' // покажет только вкладку «пополнение услуг».
++onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»;
++{{/code}}
--==== forcemedia: 'E0012345678900' ====
++==== forcemedia ====
++Тип данных:##// string//##
++
++По умолчанию:##// ''//##
++
  Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
--==== nopromo: false ====
++Пример:
--Убирает вывод промокода на странице подтверждения заказа. По умолчанию false
++{{code language="javascript"}}
++forcemedia: 'E0012345678900'
++{{/code}}
--==== terminal: true ====
++==== nopromo ====
++Тип данных:##// boolean//##
++
++По умолчанию:##// false//##
++
++Убирает вывод промокода на странице подтверждения заказа.
++
++==== terminal ====
++
++Тип данных:##// boolean//##
++
++По умолчанию:##// false//##
++
  Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
--==== cartmaxitems: 5 ====
++==== cartmaxitems ====
--====  ====
++Тип данных:##// number//##
--Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6
++По умолчанию:##// 6//##
--==== cartminitems: 2 ====
++(% class="wikigeneratedid" %)
++Ограничивает максимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.##
--====  ====
++==== cartminitems ====
--Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1
++Тип данных:##// number//##
--==== locale: 'ru' ====
++По умолчанию:##// 1//##
--====  ====
++Ограничивает минимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.##
++==== locale ====
++
++Тип данных:##// string//##
++
++По умолчанию:##// ''//##
++
  Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
--==== ordercomment: 'Комментарий к заказу' ====
++==== ordercomment ====
--====  ====
++Тип данных:##// string//##
++По умолчанию:##// ''//##
++
  Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
--==== disablemultipleseances: true ====
++==== disablemultipleseances ====
--====  ====
++Тип данных:##// boolean//##
++По умолчанию:##// false//##
++
  Параметр предотвращает добавление в корзину тарифов с различными сеансами.
  Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
--По умолчанию false
++==== tariffsseancesfilter ====
--==== tariffsseancesfilter: true ====
++Тип данных:##// boolean//##
--====  ====
++По умолчанию:##// false//##
  [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
--Включить отображение фильтра тарифов по сеансам. По умолчанию false
++Включить отображение фильтра тарифов по сеансам.
--==== resetcart: true ====
++==== resetcart ====
--====  ====
++Тип данных:##// boolean//##
--Автоматически очищать содержимое корзины. По умолчанию false
++По умолчанию:##// false//##
--==== minimap: false ====
++Автоматически очищать содержимое корзины.
--====  ====
++==== minimap ====
--Отображать миникарту. По умолчанию true
++Тип данных:##// boolean//##
--==== minimapaspect: 0.5 ====
++По умолчанию:##// true//##
--====  ====
++Отображать миникарту.
--Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
++==== minimapaspect ====
--==== forceseanceid: 42 ====
++Тип данных:##// number//##
--====  ====
++По умолчанию:##// 0.2//##
--Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
++Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится.
--==== forcesectorid: 42 ====
++==== forceseanceid ====
--====  ====
++Тип данных:##// number//##
--Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
++По умолчанию без указания идентификатора не учитывается.
--==== requiredloyalty: true ====
++Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий.
--====  ====
++==== forcesectorid ====
--Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
++Тип данных:##// number//##
--==== personallessonsskillstariffs: [56 ====
++По умолчанию без указания идентификатора не учитывается.
--==== , 57 ====
++Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов.
--==== , … ] ====
++==== requiredloyalty: true ##//boolean//## ====
--====  ====
++Тип данных:##// boolean//##
--Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
++По умолчанию:##// false//##
--==== multidayslessonsskillstariffs: [56 ====
++Включает обязательную регистриацию клиента в программе настроенной на объектке.
--==== , 57 ====
++==== personallessonsskillstariffs ====
--==== , … ] ====
++Тип данных:##// Array<number> //##//|## object##//
--====  ====
++По умолчанию:##// []//##
--Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
++Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов.
--==== saletermstype: 'checkbox' ====
++==== multidayslessonsskillstarif(% style="display:none" %) (%%)fs ====
--====  ====
++Тип данных:##// Array<number> //##//|## object##//
--Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
++По умолчанию:##// []//##
--* saletermstype: 'checkbox' потребует установку галочки для согласия.
--* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять.
--* saletermstype: 'default' принятие правил не требуется.
++Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs.
--По умолчанию 'default'
++==== saletermstype: 'checkbox' ##//string//## ====
++
++Тип данных:##// string//##
++
++По умолчанию:##// '//default//'//##
++
++Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
++
++{{code language="javascript"}}
++saletermstype: 'checkbox' // потребует установку галочки для согласия.
++saletermstype: 'dialog' // покажет всплывающее окно с правилами, которые нужно принять.
++saletermstype: 'default' // принятие правил не требуется.
++{{/code}}