Изменения документа Для_разработчиков

Редактировал(а) Михаил Галич 26.11.2024, 12:16

<
От версии < 18.1 >
отредактировано Михаил Галич
на 12.12.2023, 11:26
К версии < 8.1 >
отредактировано Михаил Галич
на 12.12.2023, 10:53
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -1,10 +1,8 @@
1 -{{toc depth="4"/}}
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  
... ... @@ -33,9 +33,9 @@
33 33  </script>
34 34  {{/code}}
35 35  
36 -= Функции =
34 +== Функции ==
37 37  
38 -== WPInit({params}) ==
36 +=== WPInit({params}) ===
39 39  
40 40  Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
41 41  
... ... @@ -47,29 +47,25 @@
47 47  
48 48  Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
49 49  
50 -{{code language="javascript"}}
51 -WPInit({
48 +{{{WPInit({
52 52   id: 1,
53 53   width: 400,
54 54   height: 600,
55 55   type: 'modal'
56 -})
57 -{{/code}}
53 +})}}}
58 58  
59 -== WPOpen({params}) ==
55 +=== WPOpen({params}) ===
60 60  
61 61  Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'
62 62  
63 63  ===== Пример передаваемых данных: =====
64 64  
65 -{{code language="javascript"}}
66 -// показ виджета с группой id 5
61 +{{{// показ виджета с группой id 5
67 67  WPOpen({
68 68   groupid: [5]
69 -})
70 -{{/code}}
64 +})}}}
71 71  
72 -== WPOpenModal({params}) ==
66 +=== WPOpenModal({params}) ===
73 73  
74 74  Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
75 75  
... ... @@ -77,7 +77,7 @@
77 77  
78 78  {{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
79 79  
80 -== WPChange({status, data}) ==
74 +=== WPChange({status, data}) ===
81 81  
82 82  Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
83 83  
... ... @@ -90,32 +90,17 @@
90 90  
91 91  ===== Пример работы с данными: =====
92 92  
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 +{{{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 } }}}}
109 109  
110 -= Параметры =
89 +== Параметры ==
111 111  
112 -== Обязательные параметры WPInit ==
91 +==== Обязательные параметры WPInit ====
113 113  
114 114  ==== id: 1 ====
115 115  
116 116  id виджета, который можно узнать в Административной панели
117 117  
118 -== Возможные параметры WPInit ==
97 +==== Возможные параметры WPInit ====
119 119  
120 120  ==== height: 480 ====
121 121  
... ... @@ -147,11 +147,11 @@
147 147  **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
148 148  )))
149 149  
150 -----
129 +==== ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-- ====
151 151  
152 -== Возможные параметры WPOpen и WPOpenModal ==
131 +==== Возможные параметры WPOpen и WPOpenModal ====
153 153  
154 -=== Календарь и даты ===
133 +===== Календарь и даты =====
155 155  
156 156  ==== nocalendar: false ====
157 157  
... ... @@ -169,31 +169,45 @@
169 169  
170 170  Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
171 171  
172 -==== disableddates: ['23.02.2019', … ] ====
151 +==== disableddates: ['23.02.2019' ====
173 173  
153 +==== , … ] ====
154 +
174 174  Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
175 175  Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
176 176  
177 -----
158 +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
178 178  
179 -=== Услуги, пакеты услуг, группы услуг ===
160 +===== Услуги, пакеты услуг, группы услуг =====
180 180  
181 -==== tariffsid: [29, 30, … ] ====
162 +==== tariffsid: [29 ====
182 182  
164 +==== , 30 ====
165 +
166 +==== , … ] ====
167 +
183 183  Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
184 184  Пример использования:
185 185  tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
186 186  tariffsid: false уберёт все тарифы с первой страницы
187 187  
188 -==== rtariffsid: [56, 57, … ] ====
173 +==== rtariffsid: [56 ====
189 189  
175 +==== , 57 ====
176 +
177 +==== , … ] ====
178 +
190 190  Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
191 191  Пример использования:
192 192  rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
193 193  tariffsid: false уберёт все тарифы с первой страницы
194 194  
195 -==== bundlesid: [4, 5, … ] ====
184 +==== bundlesid: [4 ====
196 196  
186 +==== , 5 ====
187 +
188 +==== , … ] ====
189 +
197 197  Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
198 198  Пример использования:
199 199  bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
... ... @@ -203,12 +203,18 @@
203 203  
204 204  Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
205 205  
206 -----
199 +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
207 207  
208 -=== Предзаказ ===
201 +===== Предзаказ =====
209 209  
210 -==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ====
203 +==== preorder: [{id: 57 ====
211 211  
205 +==== , date: '06.06.2019' ====
206 +
207 +==== , count: 1 ====
208 +
209 +==== }, … ] ====
210 +
212 212  Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
213 213  
214 214  * id — id услуги к покупке
... ... @@ -217,8 +217,7 @@
217 217  
218 218  ===== Пример передаваемых данных: =====
219 219  
220 -{{code language="javascript"}}
221 -// либо WPOpenModal({})
219 +{{{// либо WPOpenModal({})
222 222  WPOpen({
223 223   preorder: [
224 224   {
... ... @@ -231,10 +231,9 @@
231 231   count: 2
232 232   }
233 233   ]
234 -})
235 -{{/code}}
232 +})}}}
236 236  
237 -=== Отображение ===
234 +===== Отображение =====
238 238  
239 239  ==== forcetab: 'rewrite' ====
240 240  
... ... @@ -261,38 +261,40 @@
261 261  
262 262  ==== cartmaxitems: 5 ====
263 263  
264 -(% class="wikigeneratedid" %)
261 +==== ====
262 +
265 265  Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6
266 266  
267 267  ==== cartminitems: 2 ====
268 268  
269 -==== ====
267 +==== ====
270 270  
271 271  Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1
272 272  
273 273  ==== locale: 'ru' ====
274 274  
275 -==== ====
273 +==== ====
276 276  
277 277  Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
278 278  
279 279  ==== ordercomment: 'Комментарий к заказу' ====
280 280  
281 -==== ====
279 +==== ====
282 282  
283 283  Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
284 284  
285 285  ==== disablemultipleseances: true ====
286 286  
287 -==== ====
285 +==== ====
288 288  
289 289  Параметр предотвращает добавление в корзину тарифов с различными сеансами.
290 290  Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
291 291  По умолчанию false
292 292  
291 +
293 293  ==== tariffsseancesfilter: true ====
294 294  
295 -==== ====
294 +==== ====
296 296  
297 297  [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
298 298  
... ... @@ -300,55 +300,63 @@
300 300  
301 301  ==== resetcart: true ====
302 302  
303 -==== ====
302 +==== ====
304 304  
305 305  Автоматически очищать содержимое корзины. По умолчанию false
306 306  
307 307  ==== minimap: false ====
308 308  
309 -==== ====
308 +==== ====
310 310  
311 311  Отображать миникарту. По умолчанию true
312 312  
313 313  ==== minimapaspect: 0.5 ====
314 314  
315 -==== ====
314 +==== ====
316 316  
317 317  Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
318 318  
319 319  ==== forceseanceid: 42 ====
320 320  
321 -==== ====
320 +==== ====
322 322  
323 323  Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
324 324  
325 325  ==== forcesectorid: 42 ====
326 326  
327 -==== ====
326 +==== ====
328 328  
329 329  Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
330 330  
331 331  ==== requiredloyalty: true ====
332 332  
333 -==== ====
332 +==== ====
334 334  
335 335  Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
336 336  
337 -==== personallessonsskillstariffs: [56, 57, … ] ====
336 +==== personallessonsskillstariffs: [56 ====
338 338  
339 -==== ====
338 +==== , 57 ====
340 340  
340 +==== , … ] ====
341 +
342 +==== ====
343 +
341 341  Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
342 342  
343 -==== multidayslessonsskillstariffs: [56, 57, … ] ====
346 +==== multidayslessonsskillstariffs: [56 ====
344 344  
345 -==== ====
348 +==== , 57 ====
346 346  
350 +==== , … ] ====
351 +
352 +==== ====
353 +
347 347  Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
348 348  
349 349  ==== saletermstype: 'checkbox' ====
350 350  
351 -==== ====
358 +==== ====
352 352  
353 353  Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
354 354  
... ... @@ -357,3 +357,6 @@
357 357  * saletermstype: 'default' принятие правил не требуется.
358 358  
359 359  По умолчанию 'default'
367 +
368 +
369 +