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

Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
От версии < 5.1 >
отредактировано Михаил Галич
на 11.12.2023, 13:54
К версии < 25.1 >
отредактировано Михаил Галич
на 13.12.2023, 11:36
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -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,86 +27,438 @@
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 +{{code language="javascript"}}
45 +WPInit({ id: 1 })
46 +{{/code}}
42 42  
43 43  ===== Пример передаваемых данных: =====
44 44  
45 45  Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
46 46  
47 -{{{WPInit({
52 +{{code language="javascript"}}
53 +WPInit({
48 48   id: 1,
49 49   width: 400,
50 50   height: 600,
51 51   type: 'modal'
52 -})}}}
58 +})
59 +{{/code}}
53 53  
54 -=== WPOpen({params}) ===
61 +== WPOpen({params}) ==
55 55  
56 -Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'
63 +Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'##
57 57  
58 58  ===== Пример передаваемых данных: =====
59 59  
60 -{{{// показ виджета с группой id 5
67 +{{code language="javascript"}}
68 +// показ виджета с группой id 5
61 61  WPOpen({
62 62   groupid: [5]
63 -})}}}
71 +})
72 +{{/code}}
64 64  
65 -=== WPOpenModal({params}) ===
74 +== WPOpenModal({params}) ==
66 66  
67 -Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
76 +Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'##
68 68  
69 69  ===== Пример передаваемых данных: =====
70 70  
71 -{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
80 +{{code language="javascript"}}
81 +// показ виджета на нажатие кнопки с id "OpenButton"
82 +var OpenButton = document.getElementById('OpenButton');
83 +OpenButton.onclick = function () {
84 + WPOpenModal({ tariffsid: [27, 28] });
85 +};
86 +{{/code}}
72 72  
73 -=== WPChange({status, data}) ===
88 +== 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 заказа
94 +* ##{ status:'starting' }## — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
95 +* ##{ status:'started' }## — виджет на начальном экране, где показывается список услуг для покупки
96 +* ##{ status:'reserved', data: { order_id: 2 } }## — виджет находится на стадии забронированного заказ, в data передаётся id
97 +* ##{ 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 } }}}}
101 +{{code language="javascript"}}
102 +WPChange = function(response) {
103 + if (response.status == 'starting') {
104 + // действие на внешней странице
105 + }
106 + if (response.status == 'started') {
107 + // действие на внешней странице
108 + }
109 + if (response.status == 'reserved') {
110 + // id зарезервированного заказа: response.data.order_id
111 + }
112 + if (response.status == 'completed') {
113 + // id оплаченного заказа: response.data.order_id
114 + }
115 +}
116 +{{/code}}
87 87  
88 -== Параметры ==
118 += Параметры =
89 89  
90 -==== Обязательные параметры WPInit ====
120 +== Обязательные параметры WPInit ==
91 91  
92 -==== id: 1 ====
122 +==== id ====
93 93  
124 +Тип данных:## //number//##
125 +
94 94  id виджета, который можно узнать в Административной панели
95 95  
96 -==== Возможные параметры WPInit ====
128 +== Возможные параметры WPInit ==
97 97  
98 -==== height: 480 ====
130 +==== height ====
99 99  
132 +Тип данных:## //number //##//|## boolean##//
133 +
134 +По умолчанию:##// false//##
135 +
100 100  Высота виджета в пикселях, по умолчанию:
101 101  
102 102  * 480px, если виджет запущен как type: 'modal'
103 103  * 100%, если виджет запущен как type: 'instant'
104 104  
105 -==== width: 640 ====
141 +==== width ====
106 106  
143 +Тип данных:## //number //##//|## boolean##//
144 +
145 +По умолчанию:##// false//##
146 +
107 107  Ширина виджета в пикселях, по умолчанию:
108 108  
109 109  * 640px, если виджет запущен как type: 'modal'
110 110  * 100%, если виджет запущен как type: 'instant'
111 111  
112 -
152 +==== type ====
153 +
154 +Тип данных:## //string//##
155 +
156 +По умолчанию:##// 'instant'//##
157 +
158 +Способ открытия виджета
159 +
160 +* 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
161 +* 'modal' Открытие виджета в модальном окне
162 +
163 +==== place ====
164 +
165 +Тип данных:## //string //##//|## boolean##//
166 +
167 +По умолчанию:##// false//##
168 +
169 +Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'
170 +
171 +(% class="box warningmessage" %)
172 +(((
173 +**Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
174 +)))
175 +
176 +----
177 +
178 +== Возможные параметры WPOpen и WPOpenModal ==
179 +
180 +=== Календарь и даты ===
181 +
182 +==== disableddates ====
183 +
184 +Тип данных:##// Array<string>//##
185 +
186 +По умолчанию:##// []//##
187 +
188 +Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
189 +Пример использования:
190 +
191 +{{code language="javascript"}}
192 +disableddates: ['23.02.2018', '08.03.2018']
193 +{{/code}}
194 +
195 +уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
196 +
197 +==== forcedate ====
198 +
199 +Тип данных:##// string//##
200 +
201 +По умолчанию:##// undefined//##
202 +
203 +Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
204 +
205 +==== maxdate ====
206 +
207 +Тип данных:##// string//##
208 +
209 +По умолчанию:##// undefined//##
210 +
211 +Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
212 +
213 +==== mindate ====
214 +
215 +Тип данных:##// string//##
216 +
217 +По умолчанию:##// undefined//##
218 +
219 +Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
220 +
221 +==== nocalendar ====
222 +
223 +Тип данных:## //boolean//##
224 +
225 +По умолчанию:##// false//##
226 +
227 +Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна.
228 +
229 +----
230 +
231 +=== Услуги, пакеты услуг, группы услуг ===
232 +
233 +==== tariffsid ====
234 +
235 +Тип данных:##// Array<number> //##//|## boolean##//
236 +
237 +По умолчанию:##// []//##
238 +
239 +Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
240 +
241 +Пример использования:
242 +
243 +{{code language="javascript"}}
244 +tariffsid: [29, 30] // покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
245 +tariffsid: false // уберёт все тарифы с первой страницы
246 +{{/code}}
247 +
248 +==== rtariffsid ====
249 +
250 +Тип данных:##// Array<number> //##//|## boolean##//
251 +
252 +По умолчанию:##// []//##
253 +
254 +Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
255 +
256 +Пример использования:
257 +
258 +{{code language="javascript"}}
259 +rtariffsid: [56, 57] // покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
260 +rtariffsid: false // уберёт все тарифы во вкладке «Пополнение услуг»
261 +{{/code}}
262 +
263 +==== bundlesid ====
264 +
265 +Тип данных:##// Array<number> //##//|## boolean##//
266 +
267 +По умолчанию:##// []//##
268 +
269 +Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
270 +
271 +Пример использования:
272 +
273 +{{code language="javascript"}}
274 +bundlesid: [4, 5] // покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
275 +bundlesid: false // уберёт все пакеты услуг с первой страницы
276 +{{/code}}
277 +
278 +==== groupid ====
279 +
280 +Тип данных:##// number//##
281 +
282 +По умолчанию:##// undefined//##
283 +
284 +Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
285 +
286 +----
287 +
288 +=== Предзаказ ===
289 +
290 +==== preorder ====
291 +
292 +Тип данных:##// Array<object>//##
293 +
294 +По умолчанию:##// undefined//##
295 +
296 +Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
297 +
298 +* id — id услуги к покупке
299 +* date — дата, на которую покупается услуга
300 +* count — количество покупаемых услуг
301 +
302 +===== Пример передаваемых данных: =====
303 +
304 +{{code language="javascript"}}
305 +// либо WPOpenModal({})
306 +WPOpen({
307 + preorder: [
308 + {
309 + id: 57,
310 + date: '06.06.2019',
311 + count: 1
312 + }, {
313 + id: 58,
314 + date: '07.06.2019',
315 + count: 2
316 + }
317 + ]
318 +})
319 +{{/code}}
320 +
321 +=== Отображение ===
322 +
323 +==== forcetab ====
324 +
325 +Тип данных:##// string//##
326 +
327 +По умолчанию:##// ''//##
328 +
329 +Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab##
330 +
331 +==== onlytab ====
332 +
333 +Тип данных:##// string //##//|## Array<string>##//
334 +
335 +По умолчанию:##// []//##
336 +
337 +Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
338 +
339 +{{code language="javascript"}}
340 +onlytab: 'service' // покажет только вкладку «покупка услуг».
341 +onlytab: 'rewrite' // покажет только вкладку «пополнение услуг».
342 +onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»;
343 +{{/code}}
344 +
345 +==== forcemedia ====
346 +
347 +Тип данных:##// string//##
348 +
349 +По умолчанию:##// ''//##
350 +
351 +Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
352 +
353 +Пример:
354 +
355 +{{code language="javascript"}}
356 +forcemedia: 'E0012345678900'
357 +{{/code}}
358 +
359 +==== nopromo ====
360 +
361 +Тип данных:##// boolean//##
362 +
363 +По умолчанию:##// false//##
364 +
365 +Убирает вывод промокода на странице подтверждения заказа.
366 +
367 +==== terminal ====
368 +
369 +Тип данных:##// boolean//##
370 +
371 +По умолчанию:##// false//##
372 +
373 +Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
374 +
375 +==== cartmaxitems: 5 ##//number//## ====
376 +
377 +(% class="wikigeneratedid" %)
378 +Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60.
379 +
380 +(% class="wikigeneratedid" %)
381 +По умолчанию ##6##
382 +
383 +==== cartminitems: 2 ##//number//## ====
384 +
385 +Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60.
386 +
387 +По умолчанию ##1##
388 +
389 +==== locale: 'ru' ##//string//## ====
390 +
391 +Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
392 +
393 +==== ordercomment: 'Комментарий к заказу' ##//string//## ====
394 +
395 +Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
396 +
397 +==== disablemultipleseances: true ##//boolean//## ====
398 +
399 +Параметр предотвращает добавление в корзину тарифов с различными сеансами.
400 +Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
401 +По умолчанию ##false##
402 +
403 +==== tariffsseancesfilter: true ##//boolean//## ====
404 +
405 +[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
406 +
407 +Включить отображение фильтра тарифов по сеансам.
408 +
409 +По умолчанию ##false##
410 +
411 +==== resetcart: true ##//boolean//## ====
412 +
413 +Автоматически очищать содержимое корзины.
414 +
415 +По умолчанию ##false##
416 +
417 +==== minimap: false ##//boolean//## ====
418 +
419 +Отображать миникарту.
420 +
421 +По умолчанию ##true##
422 +
423 +==== minimapaspect: 0.5 ##//number//## ====
424 +
425 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится.
426 +
427 +По умолчанию ##0.2##
428 +
429 +==== forceseanceid: 42 ##//number//## ====
430 +
431 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий.
432 +
433 +По умолчанию без указания идентификатора не учитывается.
434 +
435 +==== forcesectorid: 42 ##//number//## ====
436 +
437 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов.
438 +
439 +По умолчанию без указания идентификатора не учитывается.
440 +
441 +==== requiredloyalty: true ##//boolean//## ====
442 +
443 +Включает обязательную регистриацию клиента в программе настроенной на объектке.
444 +
445 +По умолчанию ##false##
446 +
447 +==== personallessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ====
448 +
449 +Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов.
450 +
451 +По умолчанию ##[]##
452 +
453 +==== multidayslessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ====
454 +
455 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs.
456 +
457 +По умолчанию ##[]##
458 +
459 +==== saletermstype: 'checkbox' ##//string//## ====
460 +
461 +Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
462 +
463 +* saletermstype: ##'checkbox'## потребует установку галочки для согласия.
464 +* saletermstype: ##'dialog'## покажет всплывающее окно с правилами, которые нужно принять.
465 +* saletermstype: ##'default'## принятие правил не требуется.
466 +
467 +По умолчанию ##'default'##