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