Изменения документа Для_разработчиков
Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
>
отредактировано Михаил Галич
на 11.12.2023, 13:56
на 11.12.2023, 13:56
отредактировано Михаил Галич
на 13.12.2023, 10:20
на 13.12.2023, 10:20
Изменить комментарий:
К данной версии нет комментариев
Комментарий
-
Свойства страницы (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,97 +27,140 @@ 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 ===== Минимальный способ инициализации: ===== 40 40 41 -* WPInit({ id: 1 }) 44 +* ##WPInit({ id: 1 })## 42 42 43 43 ===== Пример передаваемых данных: ===== 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 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant' 61 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##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 -Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal' 74 +Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'## 68 68 69 69 ===== Пример передаваемых данных: ===== 70 70 71 -{{{// показ виджета на нажатие кнопки с 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}} 72 72 73 -== =WPChange({status, data}) ===86 +== WPChange({status, data}) == 74 74 75 75 Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript 76 76 77 77 ===== Примеры передаваемых данных: ===== 78 78 79 -* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать 80 -* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки 81 -* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id 82 -* { 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 заказа 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 } }}}} 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}} 87 87 88 -= =Параметры ==116 += Параметры = 89 89 90 -== ==Обязательные параметры WPInit ====118 +== Обязательные параметры WPInit == 91 91 92 -==== id :1====120 +==== id ==== 93 93 122 +Тип данных:## //number//## 123 + 94 94 id виджета, который можно узнать в Административной панели 95 95 96 -== ==Возможные параметры WPInit ====126 +== Возможные параметры WPInit == 97 97 98 -==== height :480====128 +==== height ==== 99 99 130 +Тип данных:## //number //##//|## boolean##// 131 + 132 +По умолчанию:##// false//## 133 + 100 100 Высота виджета в пикселях, по умолчанию: 101 101 102 102 * 480px, если виджет запущен как type: 'modal' 103 103 * 100%, если виджет запущен как type: 'instant' 104 104 105 -==== width :640====139 +==== width ==== 106 106 141 +Тип данных:## //number //##//|## boolean##// 142 + 143 +По умолчанию:##// false//## 144 + 107 107 Ширина виджета в пикселях, по умолчанию: 108 108 109 109 * 640px, если виджет запущен как type: 'modal' 110 110 * 100%, если виджет запущен как type: 'instant' 111 111 112 -==== type :'modal'====150 +==== type ==== 113 113 114 - Способоткрытия виджета, по умолчанию'instant':152 +Тип данных:## //string//## 115 115 154 +По умолчанию:##// 'instant'//## 155 + 156 +Способ открытия виджета 157 + 116 116 * 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации 117 117 * 'modal' Открытие виджета в модальном окне 118 118 119 -==== place :'#place'====161 +==== place ==== 120 120 163 +Тип данных:## //string //##//|## boolean##// 164 + 165 +По умолчанию:##// false//## 166 + 121 121 Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant' 122 122 123 123 (% class="box warningmessage" %) ... ... @@ -125,88 +125,81 @@ 125 125 **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery) 126 126 ))) 127 127 128 - ==== ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-- ====174 +---- 129 129 130 -== ==Возможные параметры WPOpen и WPOpenModal ====176 +== Возможные параметры WPOpen и WPOpenModal == 131 131 132 -=== ==Календарь и даты =====178 +=== Календарь и даты === 133 133 134 -==== nocalendar :false====180 +==== nocalendar ==== 135 135 136 - Убираеткалендарь внутри виджета (и в //покупке// и в //пополнении//), в случаях,когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false182 +Тип данных:## //boolean//## 137 137 138 - ====mindate: '01.01.2019' ====184 +По умолчанию:##// false//## 139 139 140 - Параметр минимальной отображаемой датывкалендаре (и в //покупке// и в //пополнении//).mindate:'20.05.2018' покажет20.05.2018каксамую первуюдату,доступнуюквыборувкалендаре, еслиона находитсяпослекущегодня186 +Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. 141 141 142 -==== maxdate: '01.01.2020' ==== 188 +==== maxdate: '01.01.2020' ##//string//## ==== 143 143 144 144 Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре. 145 145 146 -==== forcedate: '12.06.2019' ====192 +==== mindate: '01.01.2019' ##//string//## ==== 147 147 148 -Параметр дляоткрывания виджетасуказанной сразудатой(и в //покупке// и в //пополнении//).forcedate: '20.05.2018' покажет услугикпродаже надату20.05.2018.194 +Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня 149 149 150 -==== disableddates:['23.02.2019' ====196 +==== forcedate: '12.06.2019' ##//string//## ==== 151 151 152 - ====,…]====198 +Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018. 153 153 200 +==== disableddates: ['23.02.2019', … ] ##//Array<string>//## ==== 201 + 154 154 Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат. 155 -Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.203 +Пример использования: 156 156 157 -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-- 205 +{{code language="javascript"}} 206 +disableddates: ['23.02.2018', '08.03.2018'] 207 +{{/code}} 158 158 159 - ===== Услуги,пакетыуслуг,группыуслуг=====209 +уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре. 160 160 161 - ==== tariffsid: [29 ====211 +---- 162 162 163 -=== =,30====213 +=== Услуги, пакеты услуг, группы услуг === 164 164 165 -==== , … ] ==== 215 +==== tariffsid: [29, 30, … ] ##//Array<number> | boolean//## ==== 166 166 167 167 Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 218 + 168 168 Пример использования: 169 -tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 170 -tariffsid: false уберёт все тарифы с первой страницы 220 +##tariffsid: [29, 30]## покажет тарифы с id 29 и 30 во вкладке «Покупка услуг». 221 +##tariffsid: false## уберёт все тарифы с первой страницы 171 171 172 -==== rtariffsid: [56 ==== 223 +==== rtariffsid: [56, 57, … ] ##//Array<number> | boolean//## ==== 173 173 174 -==== , 57 ==== 175 - 176 -==== , … ] ==== 177 - 178 178 Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него. 226 + 179 179 Пример использования: 180 -rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 181 -tariffsid: false уберёт все тарифы с первой страницы 228 +##rtariffsid: [56, 57]## покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг» 229 +##tariffsid: false## уберёт все тарифы с первой страницы 182 182 183 -==== bundlesid: [4 ==== 231 +==== bundlesid: [4, 5, … ] ##//Array<number> | boolean//## ==== 184 184 185 -==== , 5 ==== 186 - 187 -==== , … ] ==== 188 - 189 189 Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него. 234 + 190 190 Пример использования: 191 -bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 192 -bundlesid: false уберёт все пакеты услуг с первой страницы 236 +##bundlesid: [4, 5]## покажет пакеты услуг с id 4 и 5 в момент открытия виджета. 237 +##bundlesid: false## уберёт все пакеты услуг с первой страницы 193 193 194 -==== groupid: 12 ==== 239 +==== groupid: 12 ##//number//## ==== 195 195 196 196 Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете. 197 197 198 - ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--243 +---- 199 199 200 -=== ==Предзаказ =====245 +=== Предзаказ === 201 201 202 -==== preorder: [{id: 57 ==== 247 +==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ##//Array<object>//## ==== 203 203 204 -==== , date: '06.06.2019' ==== 205 - 206 -==== , count: 1 ==== 207 - 208 -==== }, … ] ==== 209 - 210 210 Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки. 211 211 212 212 * id — id услуги к покупке ... ... @@ -213,10 +213,142 @@ 213 213 * date — дата, на которую покупается услуга 214 214 * count — количество покупаемых услуг 215 215 216 - 217 217 ===== Пример передаваемых данных: ===== 218 218 257 +{{code language="javascript"}} 258 +// либо WPOpenModal({}) 259 +WPOpen({ 260 + preorder: [ 261 + { 262 + id: 57, 263 + date: '06.06.2019', 264 + count: 1 265 + }, { 266 + id: 58, 267 + date: '07.06.2019', 268 + count: 2 269 + } 270 + ] 271 +}) 272 +{{/code}} 219 219 274 +=== Отображение === 220 220 276 +==== forcetab: 'rewrite' ##//string//## ==== 221 221 222 - 278 +Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab## 279 + 280 +==== onlytab: 'rewrite' ##//string//## ==== 281 + 282 +Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab 283 + 284 +* onlytab: 'service' покажет только вкладку «покупка услуг». 285 +* onlytab: 'rewrite' покажет только вкладку «пополнение услуг». 286 + 287 +==== forcemedia: 'E0012345678900' ##//string//## ==== 288 + 289 +Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить. 290 + 291 +==== nopromo: false ##//boolean//## ==== 292 + 293 +Убирает вывод промокода на странице подтверждения заказа. 294 + 295 +По умолчанию ##false## 296 + 297 +==== terminal: true ##//boolean//## ==== 298 + 299 +Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере. 300 + 301 +==== cartmaxitems: 5 ##//number//## ==== 302 + 303 +(% class="wikigeneratedid" %) 304 +Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. 305 + 306 +(% class="wikigeneratedid" %) 307 +По умолчанию ##6## 308 + 309 +==== cartminitems: 2 ##//number//## ==== 310 + 311 +Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. 312 + 313 +По умолчанию ##1## 314 + 315 +==== locale: 'ru' ##//string//## ==== 316 + 317 +Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык. 318 + 319 +==== ordercomment: 'Комментарий к заказу' ##//string//## ==== 320 + 321 +Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов. 322 + 323 +==== disablemultipleseances: true ##//boolean//## ==== 324 + 325 +Параметр предотвращает добавление в корзину тарифов с различными сеансами. 326 +Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты. 327 +По умолчанию ##false## 328 + 329 +==== tariffsseancesfilter: true ##//boolean//## ==== 330 + 331 +[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]] 332 + 333 +Включить отображение фильтра тарифов по сеансам. 334 + 335 +По умолчанию ##false## 336 + 337 +==== resetcart: true ##//boolean//## ==== 338 + 339 +Автоматически очищать содержимое корзины. 340 + 341 +По умолчанию ##false## 342 + 343 +==== minimap: false ##//boolean//## ==== 344 + 345 +Отображать миникарту. 346 + 347 +По умолчанию ##true## 348 + 349 +==== minimapaspect: 0.5 ##//number//## ==== 350 + 351 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. 352 + 353 +По умолчанию ##0.2## 354 + 355 +==== forceseanceid: 42 ##//number//## ==== 356 + 357 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. 358 + 359 +По умолчанию без указания идентификатора не учитывается. 360 + 361 +==== forcesectorid: 42 ##//number//## ==== 362 + 363 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. 364 + 365 +По умолчанию без указания идентификатора не учитывается. 366 + 367 +==== requiredloyalty: true ##//boolean//## ==== 368 + 369 +Включает обязательную регистриацию клиента в программе настроенной на объектке. 370 + 371 +По умолчанию ##false## 372 + 373 +==== personallessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ==== 374 + 375 +Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. 376 + 377 +По умолчанию ##[]## 378 + 379 +==== multidayslessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ==== 380 + 381 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. 382 + 383 +По умолчанию ##[]## 384 + 385 +==== saletermstype: 'checkbox' ##//string//## ==== 386 + 387 +Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна 388 + 389 +* saletermstype: ##'checkbox'## потребует установку галочки для согласия. 390 +* saletermstype: ##'dialog'## покажет всплывающее окно с правилами, которые нужно принять. 391 +* saletermstype: ##'default'## принятие правил не требуется. 392 + 393 +По умолчанию ##'default'##