Изменения документа Для_разработчиков
Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
>
отредактировано Михаил Галич
на 11.12.2023, 13:53
на 11.12.2023, 13:53
отредактировано Михаил Галич
на 13.12.2023, 10:42
на 13.12.2023, 10:42
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (1 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -1,91 +1,405 @@ 1 - ==Для разработчиков==1 +{{toc depth="4"/}} 2 2 3 - Назначениеданного раздела — описать способы взаимодействияс виджетом Веб-платформыпозадуманому вами сценарию. Типичный процесс подключения,открытия и отслеживания виджета выглядит так:3 += Инструкция для подключения = 4 4 5 - ~1. Подключитескрипт external.script.js к вашемусайту. Его адресбудетдоступен**после добавлениясайта**впроцессе настройкив**администраторскойпанелиВеб-Платформы**,такжекаки параметрid дляподключения5 +Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так: 6 6 7 +~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения 8 + 7 7 2. Вставьте в необходимом месте на своём сайте код: 8 8 9 -{{{<script type="text/javascript"> // инициализируем виджет с параметрами WPInit({ id: 1, width: 400, type: 'modal' }) // сразу откроем его для пользователя WPOpenModal(); // вариант для модального окна // WPOpen(); // вариант для открытия в теле страницы. Используется при инициализации виджета с type: 'instant' // будем следить за состоянием виджета WPChange = function(response) { if (response.status == 'reserved') { // если заказ зарезирвирован, занесём данные из response.data.order_id себе на сайт } if (response.status == 'completed') { // если заказ оплачен, занесём данные из response.data.order_id себе на сайт } } </script>}}} 11 +{{code language="html"}} 12 +<script type="text/javascript"> 13 +// инициализируем виджет с параметрами 14 +WPInit({ 15 + id: 1, 16 + width: 400, 17 + type: 'modal' 18 +}) 10 10 20 +// сразу откроем его для пользователя 21 +WPOpenModal(); // вариант для модального окна 22 +// WPOpen(); // вариант для открытия в теле страницы. Используется при инициализации виджета с type: 'instant' 11 11 12 -== Функции == 24 +// будем следить за состоянием виджета 25 +WPChange = function(response) { 26 + if (response.status == 'reserved') { 27 + // если заказ зарезирвирован, занесём данные из response.data.order_id себе на сайт 28 + } 29 + if (response.status == 'completed') { 30 + // если заказ оплачен, занесём данные из response.data.order_id себе на сайт 31 + } 32 +} 33 +</script> 34 +{{/code}} 13 13 14 -= ==WPInit({params})===36 += Функции = 15 15 38 +== WPInit({params}) == 39 + 16 16 Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели 17 17 18 18 ===== Минимальный способ инициализации: ===== 19 19 20 -* WPInit({ id: 1 }) 44 +* ##WPInit({ id: 1 })## 21 21 22 22 ===== Пример передаваемых данных: ===== 23 23 24 24 Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id. 25 25 26 -{{{WPInit({ 50 +{{code language="javascript"}} 51 +WPInit({ 27 27 id: 1, 28 28 width: 400, 29 29 height: 600, 30 30 type: 'modal' 31 -})}}} 56 +}) 57 +{{/code}} 32 32 33 -== =WPOpen({params}) ===59 +== WPOpen({params}) == 34 34 35 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant' 61 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'## 36 36 37 37 ===== Пример передаваемых данных: ===== 38 38 39 -{{{// показ виджета с группой id 5 65 +{{code language="javascript"}} 66 +// показ виджета с группой id 5 40 40 WPOpen({ 41 41 groupid: [5] 42 -})}}} 69 +}) 70 +{{/code}} 43 43 44 -== =WPOpenModal({params}) ===72 +== WPOpenModal({params}) == 45 45 46 -Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal' 74 +Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'## 47 47 48 48 ===== Пример передаваемых данных: ===== 49 49 50 -{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}} 78 +{{code language="javascript"}} 79 +// показ виджета на нажатие кнопки с id "OpenButton" 80 +var OpenButton = document.getElementById('OpenButton'); 81 +OpenButton.onclick = function () { 82 + WPOpenModal({ tariffsid: [27, 28] }); 83 +}; 84 +{{/code}} 51 51 52 -== =WPChange({status, data}) ===86 +== WPChange({status, data}) == 53 53 54 54 Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript 55 55 56 56 ===== Примеры передаваемых данных: ===== 57 57 58 -* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 59 -* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки 60 -* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id 61 -* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа 92 +* ##{ status:'starting' }## — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 93 +* ##{ status:'started' }## — виджет на начальном экране, где показывается список услуг для покупки 94 +* ##{ status:'reserved', data: { order_id: 2 } }## — виджет находится на стадии забронированного заказ, в data передаётся id 95 +* ##{ status:'completed', data: { order_id: 2 } }## — виджет находится на стадии оплаченного заказ, в data передаётся id заказа 62 62 63 63 ===== Пример работы с данными: ===== 64 64 65 -{{{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 } }}}} 99 +{{code language="javascript"}} 100 +WPChange = function(response) { 101 + if (response.status == 'starting') { 102 + // действие на внешней странице 103 + } 104 + if (response.status == 'started') { 105 + // действие на внешней странице 106 + } 107 + if (response.status == 'reserved') { 108 + // id зарезервированного заказа: response.data.order_id 109 + } 110 + if (response.status == 'completed') { 111 + // id оплаченного заказа: response.data.order_id 112 + } 113 +} 114 +{{/code}} 66 66 67 -= =Параметры ==116 += Параметры = 68 68 69 -== ==Обязательные параметры WPInit ====118 +== Обязательные параметры WPInit == 70 70 71 -==== id :1====120 +==== id ==== 72 72 122 +Тип данных:## //number//## 123 + 73 73 id виджета, который можно узнать в Административной панели 74 74 75 -== ==Возможные параметры WPInit ====126 +== Возможные параметры WPInit == 76 76 77 -==== height :480====128 +==== height ==== 78 78 130 +Тип данных:## //number //##//|## boolean##// 131 + 132 +По умолчанию:##// false//## 133 + 79 79 Высота виджета в пикселях, по умолчанию: 80 80 81 81 * 480px, если виджет запущен как type: 'modal' 82 82 * 100%, если виджет запущен как type: 'instant' 83 83 84 -==== width :640====139 +==== width ==== 85 85 141 +Тип данных:## //number //##//|## boolean##// 142 + 143 +По умолчанию:##// false//## 144 + 86 86 Ширина виджета в пикселях, по умолчанию: 87 87 88 88 * 640px, если виджет запущен как type: 'modal' 89 89 * 100%, если виджет запущен как type: 'instant' 90 90 91 - 150 +==== type ==== 151 + 152 +Тип данных:## //string//## 153 + 154 +По умолчанию:##// 'instant'//## 155 + 156 +Способ открытия виджета 157 + 158 +* 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации 159 +* 'modal' Открытие виджета в модальном окне 160 + 161 +==== place ==== 162 + 163 +Тип данных:## //string //##//|## boolean##// 164 + 165 +По умолчанию:##// false//## 166 + 167 +Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant' 168 + 169 +(% class="box warningmessage" %) 170 +((( 171 +**Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery) 172 +))) 173 + 174 +---- 175 + 176 +== Возможные параметры WPOpen и WPOpenModal == 177 + 178 +=== Календарь и даты === 179 + 180 +==== disableddates: ['23.02.2019', … ] ##//Array<string>//## ==== 181 + 182 +Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 183 +Пример использования: 184 + 185 +{{code language="javascript"}} 186 +disableddates: ['23.02.2018', '08.03.2018'] 187 +{{/code}} 188 + 189 +уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре. 190 + 191 +==== forcedate ==== 192 + 193 +Тип данных:##// string//## 194 + 195 +По умолчанию:##// undefined//## 196 + 197 +Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018. 198 + 199 +==== maxdate ==== 200 + 201 +Тип данных:##// string//## 202 + 203 +По умолчанию:##// undefined//## 204 + 205 +Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре. 206 + 207 +==== mindate ==== 208 + 209 +Тип данных:##// string//## 210 + 211 +По умолчанию:##// undefined//## 212 + 213 +Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 214 + 215 +==== nocalendar ==== 216 + 217 +Тип данных:## //boolean//## 218 + 219 +По умолчанию:##// false//## 220 + 221 +Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. 222 + 223 +---- 224 + 225 +=== Услуги, пакеты услуг, группы услуг === 226 + 227 +==== tariffsid: [29, 30, … ] ##//Array<number> | boolean//## ==== 228 + 229 +Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 230 + 231 +Пример использования: 232 +##tariffsid: [29, 30]## покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 233 +##tariffsid: false## уберёт все тарифы с первой страницы 234 + 235 +==== rtariffsid: [56, 57, … ] ##//Array<number> | boolean//## ==== 236 + 237 +Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 238 + 239 +Пример использования: 240 +##rtariffsid: [56, 57]## покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 241 +##tariffsid: false## уберёт все тарифы с первой страницы 242 + 243 +==== bundlesid: [4, 5, … ] ##//Array<number> | boolean//## ==== 244 + 245 +Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него. 246 + 247 +Пример использования: 248 +##bundlesid: [4, 5]## покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 249 +##bundlesid: false## уберёт все пакеты услуг с первой страницы 250 + 251 +==== groupid: 12 ##//number//## ==== 252 + 253 +Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете. 254 + 255 +---- 256 + 257 +=== Предзаказ === 258 + 259 +==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ##//Array<object>//## ==== 260 + 261 +Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки. 262 + 263 +* id — id услуги к покупке 264 +* date — дата, на которую покупается услуга 265 +* count — количество покупаемых услуг 266 + 267 +===== Пример передаваемых данных: ===== 268 + 269 +{{code language="javascript"}} 270 +// либо WPOpenModal({}) 271 +WPOpen({ 272 + preorder: [ 273 + { 274 + id: 57, 275 + date: '06.06.2019', 276 + count: 1 277 + }, { 278 + id: 58, 279 + date: '07.06.2019', 280 + count: 2 281 + } 282 + ] 283 +}) 284 +{{/code}} 285 + 286 +=== Отображение === 287 + 288 +==== forcetab: 'rewrite' ##//string//## ==== 289 + 290 +Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab## 291 + 292 +==== onlytab: 'rewrite' ##//string//## ==== 293 + 294 +Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 295 + 296 +* onlytab: 'service' покажет только вкладку «покупка услуг». 297 +* onlytab: 'rewrite' покажет только вкладку «пополнение услуг». 298 + 299 +==== forcemedia: 'E0012345678900' ##//string//## ==== 300 + 301 +Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить. 302 + 303 +==== nopromo: false ##//boolean//## ==== 304 + 305 +Убирает вывод промокода на странице подтверждения заказа. 306 + 307 +По умолчанию ##false## 308 + 309 +==== terminal: true ##//boolean//## ==== 310 + 311 +Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере. 312 + 313 +==== cartmaxitems: 5 ##//number//## ==== 314 + 315 +(% class="wikigeneratedid" %) 316 +Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. 317 + 318 +(% class="wikigeneratedid" %) 319 +По умолчанию ##6## 320 + 321 +==== cartminitems: 2 ##//number//## ==== 322 + 323 +Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. 324 + 325 +По умолчанию ##1## 326 + 327 +==== locale: 'ru' ##//string//## ==== 328 + 329 +Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык. 330 + 331 +==== ordercomment: 'Комментарий к заказу' ##//string//## ==== 332 + 333 +Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 334 + 335 +==== disablemultipleseances: true ##//boolean//## ==== 336 + 337 +Параметр предотвращает добавление в корзину тарифов с различными сеансами. 338 +Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 339 +По умолчанию ##false## 340 + 341 +==== tariffsseancesfilter: true ##//boolean//## ==== 342 + 343 +[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 344 + 345 +Включить отображение фильтра тарифов по сеансам. 346 + 347 +По умолчанию ##false## 348 + 349 +==== resetcart: true ##//boolean//## ==== 350 + 351 +Автоматически очищать содержимое корзины. 352 + 353 +По умолчанию ##false## 354 + 355 +==== minimap: false ##//boolean//## ==== 356 + 357 +Отображать миникарту. 358 + 359 +По умолчанию ##true## 360 + 361 +==== minimapaspect: 0.5 ##//number//## ==== 362 + 363 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. 364 + 365 +По умолчанию ##0.2## 366 + 367 +==== forceseanceid: 42 ##//number//## ==== 368 + 369 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. 370 + 371 +По умолчанию без указания идентификатора не учитывается. 372 + 373 +==== forcesectorid: 42 ##//number//## ==== 374 + 375 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. 376 + 377 +По умолчанию без указания идентификатора не учитывается. 378 + 379 +==== requiredloyalty: true ##//boolean//## ==== 380 + 381 +Включает обязательную регистриацию клиента в программе настроенной на объектке. 382 + 383 +По умолчанию ##false## 384 + 385 +==== personallessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ==== 386 + 387 +Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. 388 + 389 +По умолчанию ##[]## 390 + 391 +==== multidayslessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ==== 392 + 393 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. 394 + 395 +По умолчанию ##[]## 396 + 397 +==== saletermstype: 'checkbox' ##//string//## ==== 398 + 399 +Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна 400 + 401 +* saletermstype: ##'checkbox'## потребует установку галочки для согласия. 402 +* saletermstype: ##'dialog'## покажет всплывающее окно с правилами, которые нужно принять. 403 +* saletermstype: ##'default'## принятие правил не требуется. 404 + 405 +По умолчанию ##'default'##