Изменения документа Для_разработчиков
Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
>
отредактировано Михаил Галич
на 12.12.2023, 12:30
на 12.12.2023, 12:30
отредактировано Михаил Галич
на 13.12.2023, 10:20
на 13.12.2023, 10:20
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (1 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -2,7 +2,7 @@ 2 2 3 3 = Инструкция для подключения = 4 4 5 -Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так: 5 +Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так: 6 6 7 7 ~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения 8 8 ... ... @@ -41,7 +41,7 @@ 41 41 42 42 ===== Минимальный способ инициализации: ===== 43 43 44 -* WPInit({ id: 1 }) 44 +* ##WPInit({ id: 1 })## 45 45 46 46 ===== Пример передаваемых данных: ===== 47 47 ... ... @@ -58,7 +58,7 @@ 58 58 59 59 == WPOpen({params}) == 60 60 61 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant' 61 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'## 62 62 63 63 ===== Пример передаваемых данных: ===== 64 64 ... ... @@ -71,11 +71,17 @@ 71 71 72 72 == WPOpenModal({params}) == 73 73 74 -Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal' 74 +Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'## 75 75 76 76 ===== Пример передаваемых данных: ===== 77 77 78 -{{{// показ виджета на нажатие кнопки с 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}} 79 79 80 80 == WPChange({status, data}) == 81 81 ... ... @@ -83,10 +83,10 @@ 83 83 84 84 ===== Примеры передаваемых данных: ===== 85 85 86 -* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 87 -* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки 88 -* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id 89 -* { 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 заказа 90 90 91 91 ===== Пример работы с данными: ===== 92 92 ... ... @@ -111,35 +111,53 @@ 111 111 112 112 == Обязательные параметры WPInit == 113 113 114 -==== id :1====120 +==== id ==== 115 115 122 +Тип данных:## //number//## 123 + 116 116 id виджета, который можно узнать в Административной панели 117 117 118 118 == Возможные параметры WPInit == 119 119 120 -==== height :480====128 +==== height ==== 121 121 130 +Тип данных:## //number //##//|## boolean##// 131 + 132 +По умолчанию:##// false//## 133 + 122 122 Высота виджета в пикселях, по умолчанию: 123 123 124 124 * 480px, если виджет запущен как type: 'modal' 125 125 * 100%, если виджет запущен как type: 'instant' 126 126 127 -==== width :640====139 +==== width ==== 128 128 141 +Тип данных:## //number //##//|## boolean##// 142 + 143 +По умолчанию:##// false//## 144 + 129 129 Ширина виджета в пикселях, по умолчанию: 130 130 131 131 * 640px, если виджет запущен как type: 'modal' 132 132 * 100%, если виджет запущен как type: 'instant' 133 133 134 -==== type :'modal'====150 +==== type ==== 135 135 136 - Способоткрытия виджета, по умолчанию'instant':152 +Тип данных:## //string//## 137 137 154 +По умолчанию:##// 'instant'//## 155 + 156 +Способ открытия виджета 157 + 138 138 * 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации 139 139 * 'modal' Открытие виджета в модальном окне 140 140 141 -==== place :'#place'====161 +==== place ==== 142 142 163 +Тип данных:## //string //##//|## boolean##// 164 + 165 +По умолчанию:##// false//## 166 + 143 143 Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant' 144 144 145 145 (% class="box warningmessage" %) ... ... @@ -153,23 +153,29 @@ 153 153 154 154 === Календарь и даты === 155 155 156 -==== nocalendar :false====180 +==== nocalendar ==== 157 157 158 -Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false 159 159 160 -==== mindate: '01.01.2019' ==== 161 161 162 - Параметр минимальнойотображаемойдатыв календаре (и в//покупке//и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня184 +Тип данных:## //boolean//## 163 163 164 - ====maxdate: '01.01.2020' ====186 +По умолчанию:##// false//## 165 165 188 +Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. 189 + 190 +==== maxdate: '01.01.2020' ##//string//## ==== 191 + 166 166 Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре. 167 167 168 -==== forcedate: '12.06.2019' ====194 +==== mindate: '01.01.2019' ##//string//## ==== 169 169 196 +Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 197 + 198 +==== forcedate: '12.06.2019' ##//string//## ==== 199 + 170 170 Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018. 171 171 172 -==== disableddates: ['23.02.2019', … ] ==== 202 +==== disableddates: ['23.02.2019', … ] ##//Array<string>//## ==== 173 173 174 174 Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 175 175 Пример использования: ... ... @@ -184,28 +184,31 @@ 184 184 185 185 === Услуги, пакеты услуг, группы услуг === 186 186 187 -==== tariffsid: [29, 30, … ] ==== 217 +==== tariffsid: [29, 30, … ] ##//Array<number> | boolean//## ==== 188 188 189 189 Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 220 + 190 190 Пример использования: 191 -tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 192 -tariffsid: false уберёт все тарифы с первой страницы 222 +##tariffsid: [29, 30]## покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 223 +##tariffsid: false## уберёт все тарифы с первой страницы 193 193 194 -==== rtariffsid: [56, 57, … ] ==== 225 +==== rtariffsid: [56, 57, … ] ##//Array<number> | boolean//## ==== 195 195 196 196 Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 228 + 197 197 Пример использования: 198 -rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 199 -tariffsid: false уберёт все тарифы с первой страницы 230 +##rtariffsid: [56, 57]## покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 231 +##tariffsid: false## уберёт все тарифы с первой страницы 200 200 201 -==== bundlesid: [4, 5, … ] ==== 233 +==== bundlesid: [4, 5, … ] ##//Array<number> | boolean//## ==== 202 202 203 203 Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него. 236 + 204 204 Пример использования: 205 -bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 206 -bundlesid: false уберёт все пакеты услуг с первой страницы 238 +##bundlesid: [4, 5]## покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 239 +##bundlesid: false## уберёт все пакеты услуг с первой страницы 207 207 208 -==== groupid: 12 ==== 241 +==== groupid: 12 ##//number//## ==== 209 209 210 210 Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете. 211 211 ... ... @@ -213,7 +213,7 @@ 213 213 214 214 === Предзаказ === 215 215 216 -==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ==== 249 +==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ##//Array<object>//## ==== 217 217 218 218 Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки. 219 219 ... ... @@ -242,11 +242,11 @@ 242 242 243 243 === Отображение === 244 244 245 -==== forcetab: 'rewrite' ==== 278 +==== forcetab: 'rewrite' ##//string//## ==== 246 246 247 -Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab 280 +Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab## 248 248 249 -==== onlytab: 'rewrite' ==== 282 +==== onlytab: 'rewrite' ##//string//## ==== 250 250 251 251 Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 252 252 ... ... @@ -253,85 +253,110 @@ 253 253 * onlytab: 'service' покажет только вкладку «покупка услуг». 254 254 * onlytab: 'rewrite' покажет только вкладку «пополнение услуг». 255 255 256 -==== forcemedia: 'E0012345678900' ==== 289 +==== forcemedia: 'E0012345678900' ##//string//## ==== 257 257 258 258 Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить. 259 259 260 -==== nopromo: false ==== 293 +==== nopromo: false ##//boolean//## ==== 261 261 262 -Убирает вывод промокода на странице подтверждения заказа. По умолчанию false295 +Убирает вывод промокода на странице подтверждения заказа. 263 263 264 - ====terminal: true====297 +По умолчанию ##false## 265 265 299 +==== terminal: true ##//boolean//## ==== 300 + 266 266 Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере. 267 267 268 -==== cartmaxitems: 5 ==== 303 +==== cartmaxitems: 5 ##//number//## ==== 269 269 270 270 (% class="wikigeneratedid" %) 271 -Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6306 +Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. 272 272 273 -==== cartminitems: 2 ==== 308 +(% class="wikigeneratedid" %) 309 +По умолчанию ##6## 274 274 275 - Ограничиваетминимальноекол-вотоваровв корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1311 +==== cartminitems: 2 ##//number//## ==== 276 276 277 - ====locale:'ru'====313 +Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. 278 278 315 +По умолчанию ##1## 316 + 317 +==== locale: 'ru' ##//string//## ==== 318 + 279 279 Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык. 280 280 281 -==== ordercomment: 'Комментарий к заказу' ==== 321 +==== ordercomment: 'Комментарий к заказу' ##//string//## ==== 282 282 283 283 Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 284 284 285 -==== disablemultipleseances: true ==== 325 +==== disablemultipleseances: true ##//boolean//## ==== 286 286 287 287 Параметр предотвращает добавление в корзину тарифов с различными сеансами. 288 288 Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 289 -По умолчанию false 329 +По умолчанию ##false## 290 290 291 -==== tariffsseancesfilter: true ==== 331 +==== tariffsseancesfilter: true ##//boolean//## ==== 292 292 293 293 [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 294 294 295 -Включить отображение фильтра тарифов по сеансам. По умолчанию false335 +Включить отображение фильтра тарифов по сеансам. 296 296 297 - ====resetcart: true ====337 +По умолчанию ##false## 298 298 299 - Автоматическиочищатьсодержимоекорзины. По умолчанию false339 +==== resetcart: true ##//boolean//## ==== 300 300 301 - ====minimap:false====341 +Автоматически очищать содержимое корзины. 302 302 303 - Отображать миникарту.По умолчаниюtrue343 +По умолчанию ##false## 304 304 305 -==== minimapas pect:0.5====345 +==== minimap: false ##//boolean//## ==== 306 306 307 - Размер миникартыотносительной полногоразмеракарты,анеконтейнера, в которой она находится. Поумолчанию 0.2347 +Отображать миникарту. 308 308 309 - ====forceseanceid: 42 ====349 +По умолчанию ##true## 310 310 311 - Заставитвиджетвыбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий.Безуказания идентификатора не учитывается.351 +==== minimapaspect: 0.5 ##//number//## ==== 312 312 313 - ====forcesectorid:42====353 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. 314 314 315 - Заставит виджет выбрать сектормероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указанияидентификатора не учитывается.355 +По умолчанию ##0.2## 316 316 317 -==== re quiredloyalty:true ====357 +==== forceseanceid: 42 ##//number//## ==== 318 318 319 - Включаетобязательнуюрегистриациюклиентавпрограмменастроеннойнаобъектке.По умолчанию false359 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. 320 320 321 - ====personallessonsskillstariffs:[56,57,…]====361 +По умолчанию без указания идентификатора не учитывается. 322 322 323 - Производитфильтрациютарифовдляиндивидуальных занятий. Принимает массив идентификаторов. По умолчанию []363 +==== forcesectorid: 42 ##//number//## ==== 324 324 325 - ====multidayslessonsskillstariffs:[56,57,…]====365 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. 326 326 327 -П роизводитфильтрациютарифов для многодневныхзанятий.Принимает массив идентификаторов. Параметрдополняетфильтрацию по параметру grouplessonsskillstariffs.По умолчанию []367 +По умолчанию без указания идентификатора не учитывается. 328 328 329 -==== saletermstype:'checkbox'====369 +==== requiredloyalty: true ##//boolean//## ==== 330 330 371 +Включает обязательную регистриацию клиента в программе настроенной на объектке. 372 + 373 +По умолчанию ##false## 374 + 375 +==== personallessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ==== 376 + 377 +Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. 378 + 379 +По умолчанию ##[]## 380 + 381 +==== multidayslessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ==== 382 + 383 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. 384 + 385 +По умолчанию ##[]## 386 + 387 +==== saletermstype: 'checkbox' ##//string//## ==== 388 + 331 331 Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна 332 332 333 -* saletermstype: 'checkbox' потребует установку галочки для согласия. 334 -* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять. 335 -* saletermstype: 'default' принятие правил не требуется. 391 +* saletermstype: ##'checkbox'## потребует установку галочки для согласия. 392 +* saletermstype: ##'dialog'## покажет всплывающее окно с правилами, которые нужно принять. 393 +* saletermstype: ##'default'## принятие правил не требуется. 336 336 337 -По умолчанию 'default' 395 +По умолчанию ##'default'##