Изменения документа Для_разработчиков
Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
>
отредактировано Георгий Тарасюк
на 13.12.2023, 14:17
на 13.12.2023, 14:17
отредактировано Михаил Галич
на 11.12.2023, 13:53
на 11.12.2023, 13:53
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (2 изменено, 0 добавлено, 0 удалено)
-
Объекты (0 изменено, 0 добавлено, 1 удалено)
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. force1 +XWiki.galich - Содержимое
-
... ... @@ -1,15 +1,12 @@ 1 - {{tocdepth="4"/}}1 +== Для разработчиков == 2 2 3 - =Инструкция дляподключения=3 +Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так: 4 4 5 - Назначениеданногораздела—описатьспособы взаимодействия с виджетом Веб-платформыпо задуманномувами сценарию.Типичныйпроцессподключения, открытия и отслеживания виджета выглядит так:5 +~1. Подключите скрипт external.script.js к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения 6 6 7 -~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения 8 - 9 9 2. Вставьте в необходимом месте на своём сайте код: 10 10 11 -{{code language="html"}} 12 -<script type="text/javascript"> 9 +<pre>{{{<script type="text/javascript"> 13 13 // инициализируем виджет с параметрами 14 14 WPInit({ 15 15 id: 1, ... ... @@ -30,474 +30,86 @@ 30 30 // если заказ оплачен, занесём данные из response.data.order_id себе на сайт 31 31 } 32 32 } 33 -</script> 34 -{{/code}} 30 +</script>}}}</pre> 35 35 36 -= Функции = 37 37 38 -== WPInit({params})==33 +== Функции == 39 39 35 +=== WPInit({params}) === 36 + 40 40 Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели 41 41 42 42 ===== Минимальный способ инициализации: ===== 43 43 44 -{{code language="javascript"}} 45 -WPInit({ id: 1 }) 46 -{{/code}} 41 +* WPInit({ id: 1 }) 47 47 48 48 ===== Пример передаваемых данных: ===== 49 49 50 50 Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id. 51 51 52 -{{code language="javascript"}} 53 -WPInit({ 47 +{{{WPInit({ 54 54 id: 1, 55 55 width: 400, 56 56 height: 600, 57 57 type: 'modal' 58 -}) 59 -{{/code}} 52 +})}}} 60 60 61 -== WPOpen({params}) == 54 +=== WPOpen({params}) === 62 62 63 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'##56 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant' 64 64 65 65 ===== Пример передаваемых данных: ===== 66 66 67 -{{code language="javascript"}} 68 -// показ виджета с группой id 5 60 +{{{// показ виджета с группой id 5 69 69 WPOpen({ 70 70 groupid: [5] 71 -}) 72 -{{/code}} 63 +})}}} 73 73 74 -== WPOpenModal({params}) == 65 +=== WPOpenModal({params}) === 75 75 76 -Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'##67 +Функция открытия виджета в модальном окне, используется при инициализации виджета с 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}} 71 +{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}} 87 87 88 -== WPChange({status, data}) == 73 +=== WPChange({status, data}) === 89 89 90 90 Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript 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 заказа79 +* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 80 +* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки 81 +* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id 82 +* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа 98 98 99 99 ===== Пример работы с данными: ===== 100 100 101 -{{code language="javascript"}} 102 -WPChange = function(response) { 103 - if (response.status == 'starting') { 104 - // действие на внешней странице 105 - } 106 - if (response.status == 'started') { 107 - // действие на внешней странице 108 - } 109 - if (response.status == 'reserved') { 110 - // id зарезервированного заказа: response.data.order_id 111 - } 112 - if (response.status == 'completed') { 113 - // id оплаченного заказа: response.data.order_id 114 - } 115 -} 116 -{{/code}} 86 +{{{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 } }}}} 117 117 118 -= Параметры = 88 +== Параметры == 119 119 120 -== Обязательные параметры WPInit == 90 +==== Обязательные параметры WPInit ==== 121 121 122 -==== id ==== 92 +==== id: 1 ==== 123 123 124 -Тип данных:## //number//## 125 - 126 126 id виджета, который можно узнать в Административной панели 127 127 128 -== Возможные параметры WPInit == 96 +==== Возможные параметры WPInit ==== 129 129 130 -==== height ==== 98 +==== 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 ==== 105 +==== 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 ==== 153 - 154 -Тип данных:## //string//## 155 - 156 -По умолчанию:##// 'instant'//## 157 - 158 -Способ открытия виджета 159 - 160 -* 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации 161 -* 'modal' Открытие виджета в модальном окне 162 - 163 -==== place ==== 164 - 165 -Тип данных:## //string //##//|## boolean##// 166 - 167 -По умолчанию:##// false//## 168 - 169 -Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant' 170 - 171 -(% class="box warningmessage" %) 172 -((( 173 -**Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery) 174 -))) 175 - 176 ----- 177 - 178 -== Возможные параметры WPOpen и WPOpenModal == 179 - 180 -=== Календарь и даты === 181 - 182 -==== disableddates ==== 183 - 184 -Тип данных:##// Array<string>//## 185 - 186 -По умолчанию:##// []//## 187 - 188 -Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 189 -Пример использования: 190 - 191 -{{code language="javascript"}} 192 -disableddates: ['23.02.2018', '08.03.2018'] 193 -{{/code}} 194 - 195 -уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре. 196 - 197 -==== forcedate ==== 198 - 199 -Тип данных:##// string//## 200 - 201 -По умолчанию:##// undefined//## 202 - 203 -Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018. 204 - 205 -==== maxdate ==== 206 - 207 -Тип данных:##// string//## 208 - 209 -По умолчанию:##// undefined//## 210 - 211 -Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре. 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 ----- 230 - 231 -=== Услуги, пакеты услуг, группы услуг === 232 - 233 -==== tariffsid ==== 234 - 235 -Тип данных:##// Array<number> //##//|## boolean##// 236 - 237 -По умолчанию:##// []//## 238 - 239 -Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 240 - 241 -Пример использования: 242 - 243 -{{code language="javascript"}} 244 -tariffsid: [29, 30] // покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 245 -tariffsid: false // уберёт все тарифы с первой страницы 246 -{{/code}} 247 - 248 -==== rtariffsid ==== 249 - 250 -Тип данных:##// Array<number> //##//|## boolean##// 251 - 252 -По умолчанию:##// []//## 253 - 254 -Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 255 - 256 -Пример использования: 257 - 258 -{{code language="javascript"}} 259 -rtariffsid: [56, 57] // покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 260 -rtariffsid: false // уберёт все тарифы во вкладке «Пополнение услуг» 261 -{{/code}} 262 - 263 -==== bundlesid ==== 264 - 265 -Тип данных:##// Array<number> //##//|## boolean##// 266 - 267 -По умолчанию:##// []//## 268 - 269 -Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него. 270 - 271 -Пример использования: 272 - 273 -{{code language="javascript"}} 274 -bundlesid: [4, 5] // покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 275 -bundlesid: false // уберёт все пакеты услуг с первой страницы 276 -{{/code}} 277 - 278 -==== groupid ==== 279 - 280 -Тип данных:##// number//## 281 - 282 -По умолчанию:##// undefined//## 283 - 284 -Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете. 285 - 286 ----- 287 - 288 -=== Предзаказ === 289 - 290 -==== preorder ==== 291 - 292 -Тип данных:##// Array<object>//## 293 - 294 -По умолчанию:##// undefined//## 295 - 296 -Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки. 297 - 298 -* id — id услуги к покупке 299 -* date — дата, на которую покупается услуга 300 -* count — количество покупаемых услуг 301 - 302 -===== Пример передаваемых данных: ===== 303 - 304 -{{code language="javascript"}} 305 -// либо WPOpenModal({}) 306 -WPOpen({ 307 - preorder: [ 308 - { 309 - id: 57, 310 - date: '06.06.2019', 311 - count: 1 312 - }, { 313 - id: 58, 314 - date: '07.06.2019', 315 - count: 2 316 - } 317 - ] 318 -}) 319 -{{/code}} 320 - 321 -=== Отображение === 322 - 323 -==== forcetab ==== 324 - 325 -Тип данных:##// string//## 326 - 327 -По умолчанию:##// ''//## 328 - 329 -Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab## 330 - 331 -==== onlytab ==== 332 - 333 -Тип данных:##// string //##//|## Array<string>##// 334 - 335 -По умолчанию:##// []//## 336 - 337 -Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 338 - 339 -{{code language="javascript"}} 340 -onlytab: 'service' // покажет только вкладку «покупка услуг». 341 -onlytab: 'rewrite' // покажет только вкладку «пополнение услуг». 342 -onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»; 343 -{{/code}} 344 - 345 -==== forcemedia ==== 346 - 347 -Тип данных:##// string//## 348 - 349 -По умолчанию:##// ''//## 350 - 351 -Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить. 352 - 353 -Пример: 354 - 355 -{{code language="javascript"}} 356 -forcemedia: 'E0012345678900' 357 -{{/code}} 358 - 359 -==== nopromo ==== 360 - 361 -Тип данных:##// boolean//## 362 - 363 -По умолчанию:##// false//## 364 - 365 -Убирает вывод промокода на странице подтверждения заказа. 366 - 367 -==== terminal ==== 368 - 369 -Тип данных:##// boolean//## 370 - 371 -По умолчанию:##// false//## 372 - 373 -Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере. 374 - 375 -==== cartmaxitems ==== 376 - 377 -Тип данных:##// number//## 378 - 379 -По умолчанию:##// 6//## 380 - 381 -(% class="wikigeneratedid" %) 382 -Ограничивает максимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 383 - 384 -==== cartminitems ==== 385 - 386 -Тип данных:##// number//## 387 - 388 -По умолчанию:##// 1//## 389 - 390 -Ограничивает минимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.## 391 - 392 -==== locale ==== 393 - 394 -Тип данных:##// string//## 395 - 396 -По умолчанию:##// ''//## 397 - 398 -Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык. 399 - 400 -==== ordercomment ==== 401 - 402 -Тип данных:##// string//## 403 - 404 -По умолчанию:##// ''//## 405 - 406 -Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 407 - 408 -==== disablemultipleseances ==== 409 - 410 -Тип данных:##// boolean//## 411 - 412 -По умолчанию:##// false//## 413 - 414 -Параметр предотвращает добавление в корзину тарифов с различными сеансами. 415 -Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 416 - 417 -==== tariffsseancesfilter ==== 418 - 419 -Тип данных:##// boolean//## 420 - 421 -По умолчанию:##// false//## 422 - 423 -[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 424 - 425 -Включить отображение фильтра тарифов по сеансам. 426 - 427 -==== resetcart ==== 428 - 429 -Тип данных:##// boolean//## 430 - 431 -По умолчанию:##// false//## 432 - 433 -Автоматически очищать содержимое корзины. 434 - 435 -==== minimap ==== 436 - 437 -Тип данных:##// boolean//## 438 - 439 -По умолчанию:##// true//## 440 - 441 -Отображать миникарту. 442 - 443 -==== minimapaspect ==== 444 - 445 -Тип данных:##// number//## 446 - 447 -По умолчанию:##// 0.2//## 448 - 449 -Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. 450 - 451 -==== forceseanceid ==== 452 - 453 -Тип данных:##// number//## 454 - 455 -По умолчанию без указания идентификатора не учитывается. 456 - 457 -Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. 458 - 459 -==== forcesectorid ==== 460 - 461 -Тип данных:##// number//## 462 - 463 -По умолчанию без указания идентификатора не учитывается. 464 - 465 -Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. 466 - 467 -==== requiredloyalty: true ##//boolean//## ==== 468 - 469 -Тип данных:##// boolean//## 470 - 471 -По умолчанию:##// false//## 472 - 473 -Включает обязательную регистриацию клиента в программе настроенной на объектке. 474 - 475 -==== personallessonsskillstariffs ==== 476 - 477 -Тип данных:##// Array<number> //##//|## object##// 478 - 479 -По умолчанию:##// []//## 480 - 481 -Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. 482 - 483 -==== multidayslessonsskillstarif(% style="display:none" %) (%%)fs ==== 484 - 485 -Тип данных:##// Array<number> //##//|## object##// 486 - 487 -По умолчанию:##// []//## 488 - 489 -Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. 490 - 491 -==== saletermstype: 'checkbox' ##//string//## ==== 492 - 493 -Тип данных:##// string//## 494 - 495 -По умолчанию:##// '//default//'//## 496 - 497 -Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна 498 - 499 -{{code language="javascript"}} 500 -saletermstype: 'checkbox' // потребует установку галочки для согласия. 501 -saletermstype: 'dialog' // покажет всплывающее окно с правилами, которые нужно принять. 502 -saletermstype: 'default' // принятие правил не требуется. 503 -{{/code}} 112 +
- 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