Изменения документа Для_разработчиков
Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
>
отредактировано Михаил Галич
на 14.12.2023, 13:07
на 14.12.2023, 13:07
отредактировано Михаил Галич
на 12.12.2023, 12:30
на 12.12.2023, 12:30
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (1 изменено, 0 добавлено, 0 удалено)
-
Объекты (0 изменено, 0 добавлено, 2 удалено)
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -2,7 +2,7 @@ 2 2 3 3 = Инструкция для подключения = 4 4 5 -Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуман ному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:5 +Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так: 6 6 7 7 ~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения 8 8 ... ... @@ -41,9 +41,7 @@ 41 41 42 42 ===== Минимальный способ инициализации: ===== 43 43 44 -{{code language="javascript"}} 45 -WPInit({ id: 1 }) 46 -{{/code}} 44 +* WPInit({ id: 1 }) 47 47 48 48 ===== Пример передаваемых данных: ===== 49 49 ... ... @@ -60,7 +60,7 @@ 60 60 61 61 == WPOpen({params}) == 62 62 63 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'##61 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant' 64 64 65 65 ===== Пример передаваемых данных: ===== 66 66 ... ... @@ -73,17 +73,11 @@ 73 73 74 74 == WPOpenModal({params}) == 75 75 76 -Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'##74 +Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal' 77 77 78 78 ===== Пример передаваемых данных: ===== 79 79 80 -{{code language="javascript"}} 81 -// показ виджета на нажатие кнопки с id "OpenButton" 82 -var OpenButton = document.getElementById('OpenButton'); 83 -OpenButton.onclick = function () { 84 - WPOpenModal({ tariffsid: [27, 28] }); 85 -}; 86 -{{/code}} 78 +{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}} 87 87 88 88 == WPChange({status, data}) == 89 89 ... ... @@ -91,10 +91,10 @@ 91 91 92 92 ===== Примеры передаваемых данных: ===== 93 93 94 -* ##{ status:'starting' }##— виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать95 -* ##{ status:'started' }##— виджет на начальном экране, где показывается список услуг для покупки96 -* ##{ status:'reserved', data: { order_id: 2 } }##— виджет находится на стадии забронированного заказ, в data передаётся id97 -* ##{ status:'completed', data: { order_id: 2 } }##— виджет находится на стадии оплаченного заказ, в data передаётся id заказа86 +* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 87 +* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки 88 +* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id 89 +* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа 98 98 99 99 ===== Пример работы с данными: ===== 100 100 ... ... @@ -119,53 +119,35 @@ 119 119 120 120 == Обязательные параметры WPInit == 121 121 122 -==== id ==== 114 +==== id: 1 ==== 123 123 124 -Тип данных:## //number//## 125 - 126 126 id виджета, который можно узнать в Административной панели 127 127 128 128 == Возможные параметры WPInit == 129 129 130 -==== height ==== 120 +==== height: 480 ==== 131 131 132 -Тип данных:## //number //##//|## boolean##// 133 - 134 -По умолчанию:##// false//## 135 - 136 136 Высота виджета в пикселях, по умолчанию: 137 137 138 138 * 480px, если виджет запущен как type: 'modal' 139 139 * 100%, если виджет запущен как type: 'instant' 140 140 141 -==== width ==== 127 +==== width: 640 ==== 142 142 143 -Тип данных:## //number //##//|## boolean##// 144 - 145 -По умолчанию:##// false//## 146 - 147 147 Ширина виджета в пикселях, по умолчанию: 148 148 149 149 * 640px, если виджет запущен как type: 'modal' 150 150 * 100%, если виджет запущен как type: 'instant' 151 151 152 -==== type ==== 134 +==== type: 'modal' ==== 153 153 154 - Тип данных:##//string//##136 +Способ открытия виджета, по умолчанию 'instant': 155 155 156 -По умолчанию:##// 'instant'//## 157 - 158 -Способ открытия виджета 159 - 160 160 * 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации 161 161 * 'modal' Открытие виджета в модальном окне 162 162 163 -==== place ==== 141 +==== place: '#place' ==== 164 164 165 -Тип данных:## //string //##//|## boolean##// 166 - 167 -По умолчанию:##// false//## 168 - 169 169 Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant' 170 170 171 171 (% class="box warningmessage" %) ... ... @@ -179,108 +179,60 @@ 179 179 180 180 === Календарь и даты === 181 181 182 -==== disableddates ====156 +==== nocalendar: false ==== 183 183 184 - Типданных:##//Array<string>//##158 +Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false 185 185 186 - Поумолчанию:##// []//##160 +==== mindate: '01.01.2019' ==== 187 187 188 -Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 189 -Пример использования: 162 +Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 190 190 191 -{{code language="javascript"}} 192 -disableddates: ['23.02.2018', '08.03.2018'] 193 -{{/code}} 164 +==== maxdate: '01.01.2020' ==== 194 194 195 - уберёт даты 23.02.2018и08.03.2018извозможныхдлявыборадатв календаре.166 +Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре. 196 196 197 -==== forcedate ==== 168 +==== forcedate: '12.06.2019' ==== 198 198 199 -Тип данных:##// string//## 200 - 201 -По умолчанию:##// undefined//## 202 - 203 203 Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018. 204 204 205 -==== maxdate ====172 +==== disableddates: ['23.02.2019', … ] ==== 206 206 207 -Тип данных:##// string//## 174 +Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 175 +Пример использования: 208 208 209 -По умолчанию:##// undefined//## 177 +{{code language="javascript"}} 178 +disableddates: ['23.02.2018', '08.03.2018'] 179 +{{/code}} 210 210 211 - Параметрмаксимальной отображаемойдатыв календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018'покажет20.05.2018каксамую последнююдату,доступную квыборув календаре.181 +уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре. 212 212 213 -==== mindate ==== 214 - 215 -Тип данных:##// string//## 216 - 217 -По умолчанию:##// undefined//## 218 - 219 -Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 220 - 221 -==== nocalendar ==== 222 - 223 -Тип данных:## //boolean//## 224 - 225 -По умолчанию:##// false//## 226 - 227 -Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. 228 - 229 229 ---- 230 230 231 231 === Услуги, пакеты услуг, группы услуг === 232 232 233 -==== tariffsid ==== 187 +==== tariffsid: [29, 30, … ] ==== 234 234 235 -Тип данных:##// Array<number> //##//|## boolean##// 236 - 237 -По умолчанию:##// []//## 238 - 239 239 Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 240 - 241 241 Пример использования: 191 +tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 192 +tariffsid: false уберёт все тарифы с первой страницы 242 242 243 -{{code language="javascript"}} 244 -tariffsid: [29, 30] // покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 245 -tariffsid: false // уберёт все тарифы с первой страницы 246 -{{/code}} 194 +==== rtariffsid: [56, 57, … ] ==== 247 247 248 -==== rtariffsid ==== 249 - 250 -Тип данных:##// Array<number> //##//|## boolean##// 251 - 252 -По умолчанию:##// []//## 253 - 254 254 Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 255 - 256 256 Пример использования: 198 +rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 199 +tariffsid: false уберёт все тарифы с первой страницы 257 257 258 -{{code language="javascript"}} 259 -rtariffsid: [56, 57] // покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 260 -rtariffsid: false // уберёт все тарифы во вкладке «Пополнение услуг» 261 -{{/code}} 201 +==== bundlesid: [4, 5, … ] ==== 262 262 263 -==== bundlesid ==== 264 - 265 -Тип данных:##// Array<number> //##//|## boolean##// 266 - 267 -По умолчанию:##// []//## 268 - 269 269 Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него. 270 - 271 271 Пример использования: 205 +bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 206 +bundlesid: false уберёт все пакеты услуг с первой страницы 272 272 273 -{{code language="javascript"}} 274 -bundlesid: [4, 5] // покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 275 -bundlesid: false // уберёт все пакеты услуг с первой страницы 276 -{{/code}} 208 +==== groupid: 12 ==== 277 277 278 -==== groupid ==== 279 - 280 -Тип данных:##// number//## 281 - 282 -По умолчанию:##// undefined//## 283 - 284 284 Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете. 285 285 286 286 ---- ... ... @@ -287,12 +287,8 @@ 287 287 288 288 === Предзаказ === 289 289 290 -==== preorder ==== 216 +==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ==== 291 291 292 -Тип данных:##// Array<object>//## 293 - 294 -По умолчанию:##// undefined//## 295 - 296 296 Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки. 297 297 298 298 * id — id услуги к покупке ... ... @@ -318,182 +318,98 @@ 318 318 }) 319 319 {{/code}} 320 320 321 ----- 322 - 323 323 === Отображение === 324 324 325 -==== cartmaxitems====245 +==== forcetab: 'rewrite' ==== 326 326 327 - Типданных:##// number//##247 +Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab 328 328 329 - Поумолчанию:##// 6//##249 +==== onlytab: 'rewrite' ==== 330 330 331 -(% class="wikigeneratedid" %) 332 -Ограничивает максимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 251 +Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 333 333 334 -==== cartminitems ==== 253 +* onlytab: 'service' покажет только вкладку «покупка услуг». 254 +* onlytab: 'rewrite' покажет только вкладку «пополнение услуг». 335 335 336 - Типданных:##// number//##256 +==== forcemedia: 'E0012345678900' ==== 337 337 338 -По умолчанию:##// 1//## 339 - 340 -Ограничивает минимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 341 - 342 -==== disablemultipleseances ==== 343 - 344 -Тип данных:##// boolean//## 345 - 346 -По умолчанию:##// false//## 347 - 348 -Параметр предотвращает добавление в корзину тарифов с различными сеансами. 349 -Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 350 - 351 -==== forcemedia ==== 352 - 353 -Тип данных:##// string//## 354 - 355 -По умолчанию:##// ''//## 356 - 357 357 Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить. 358 358 359 - Пример:260 +==== nopromo: false ==== 360 360 361 -{{code language="javascript"}} 362 -forcemedia: 'E0012345678900' 363 -{{/code}} 262 +Убирает вывод промокода на странице подтверждения заказа. По умолчанию false 364 364 264 +==== terminal: true ==== 365 365 266 +Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере. 366 366 367 -==== forceseanceid====268 +==== cartmaxitems: 5 ==== 368 368 369 -Тип данных:##// number//## 270 +(% class="wikigeneratedid" %) 271 +Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6 370 370 371 - Поумолчаниюбезуказания идентификатора не учитывается.273 +==== cartminitems: 2 ==== 372 372 373 - Заставит виджетвыбратьмероприятиеарены поидентификатору платформыинепозволятьвернутьсякэтапувыборадругихмероприятий.275 +Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1 374 374 375 -==== forcesectorid====277 +==== locale: 'ru' ==== 376 376 377 -Тип данных:##// number//## 378 - 379 -По умолчанию без указания идентификатора не учитывается. 380 - 381 -Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. 382 - 383 -==== forcetab ==== 384 - 385 -Тип данных:##// string//## 386 - 387 -По умолчанию:##// ''//## 388 - 389 -Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab## 390 - 391 -==== locale ==== 392 - 393 -Тип данных:##// string//## 394 - 395 -По умолчанию:##// ''//## 396 - 397 397 Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык. 398 398 399 -==== m inimap====281 +==== ordercomment: 'Комментарий к заказу' ==== 400 400 401 - Типданных:##// boolean//##283 +Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 402 402 403 - Поумолчанию:##//true//##285 +==== disablemultipleseances: true ==== 404 404 405 -Отображать миникарту. 287 +Параметр предотвращает добавление в корзину тарифов с различными сеансами. 288 +Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 289 +По умолчанию false 406 406 407 -==== minimapaspect ====291 +==== tariffsseancesfilter: true ==== 408 408 409 - Тип данных:##//ber//##293 +[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 410 410 411 -По умолчанию :##// 0.2//##295 +Включить отображение фильтра тарифов по сеансам. По умолчанию false 412 412 413 - Размерминикартыотносительнойполного размера карты, а не контейнера, в которой она находится.297 +==== resetcart: true ==== 414 414 415 - ====multidayslessonsskillstarif(%style="display:none"%)(%%)fs====299 +Автоматически очищать содержимое корзины. По умолчанию false 416 416 417 - Типданных:##// Array<number>//##//|## object##//301 +==== minimap: false ==== 418 418 419 -По умолчанию :##// []//##303 +Отображать миникарту. По умолчанию true 420 420 421 - Производитфильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs.305 +==== minimapaspect: 0.5 ==== 422 422 423 - ====nopromo====307 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2 424 424 425 - Типданных:##// boolean//##309 +==== forceseanceid: 42 ==== 426 426 427 - По умолчанию:##// false//##311 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается. 428 428 429 - Убираетвыводпромокодана странице подтверждения заказа.313 +==== forcesectorid: 42 ==== 430 430 431 - ====onlytab====315 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается. 432 432 433 - Типданных:##// string //##//|## Array<string>##//317 +==== requiredloyalty: true ==== 434 434 435 -По умолчанию :##// []//##319 +Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false 436 436 437 - Скрытиедругихвкладоквиджета(«покупкауслуг»или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab321 +==== personallessonsskillstariffs: [56, 57, … ] ==== 438 438 439 -{{code language="javascript"}} 440 -onlytab: 'service' // покажет только вкладку «покупка услуг». 441 -onlytab: 'rewrite' // покажет только вкладку «пополнение услуг». 442 -onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»; 443 -{{/code}} 323 +Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию [] 444 444 445 -==== ordercomment ====325 +==== multidayslessonsskillstariffs: [56, 57, … ] ==== 446 446 447 - Типданных:##//string//##327 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию [] 448 448 449 - Поумолчанию:##//''//##329 +==== saletermstype: 'checkbox' ==== 450 450 451 -Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 452 - 453 -==== personallessonsskillstariffs ==== 454 - 455 -Тип данных:##// Array<number> //##//|## object##// 456 - 457 -По умолчанию:##// []//## 458 - 459 -Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. 460 - 461 -==== resetcart ==== 462 - 463 -Тип данных:##// boolean//## 464 - 465 -По умолчанию:##// false//## 466 - 467 -Автоматически очищать содержимое корзины. 468 - 469 -==== requiredloyalty ==== 470 - 471 -Тип данных:##// boolean//## 472 - 473 -По умолчанию:##// false//## 474 - 475 -Включает обязательную регистриацию клиента в программе настроенной на объектке. 476 - 477 -==== saletermstype ==== 478 - 479 -Тип данных:##// string//## 480 - 481 -По умолчанию:##// '//default//'//## 482 - 483 483 Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна 484 484 485 -{{code language="javascript"}} 486 -saletermstype: 'checkbox' // потребует установку галочки для согласия. 487 -saletermstype: 'dialog' // покажет всплывающее окно с правилами, которые нужно принять. 488 -saletermstype: 'default' // принятие правил не требуется. 489 -{{/code}} 333 +* saletermstype: 'checkbox' потребует установку галочки для согласия. 334 +* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять. 335 +* saletermstype: 'default' принятие правил не требуется. 490 490 491 -==== tariffsseancesfilter ==== 492 - 493 -Тип данных:##// boolean//## 494 - 495 -По умолчанию:##// false//## 496 - 497 -[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 498 - 499 -Включить отображение фильтра тарифов по сеансам. 337 +По умолчанию 'default'
- XWiki.XWikiRights[0]
-
- allow
-
... ... @@ -1,1 +1,0 @@ 1 -1 - levels
-
... ... @@ -1,1 +1,0 @@ 1 -view - users
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.XWikiGuest
- XWiki.XWikiRights[1]
-
- allow
-
... ... @@ -1,1 +1,0 @@ 1 -0 - levels
-
... ... @@ -1,1 +1,0 @@ 1 -delete,script,edit,comment - users
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.XWikiGuest