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

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

От версии < 25.1 >

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

К версии < 13.1 >

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

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

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

Комментарий

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

Подробности

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

Содержимое

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