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