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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -1,12 +1,15 @@
1 -== Для разработчиков ==
1 +{{toc depth="3"/}}
2 2  
3 += Инструкция для подключения =
4 +
3 3  Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
4 4  
5 -~1. Подключите скрипт external.script.js к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения
7 +~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения
6 6  
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,11 +27,11 @@
27 27   // если заказ оплачен, занесём данные из response.data.order_id себе на сайт
28 28   }
29 29  }
30 -</script>}}}
33 +</script>
34 +{{/code}}
31 31  
36 += Функции =
32 32  
33 -== Функции ==
34 -
35 35  === WPInit({params}) ===
36 36  
37 37  Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
... ... @@ -44,12 +44,14 @@
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 54  === WPOpen({params}) ===
55 55  
... ... @@ -57,10 +57,12 @@
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 65  === WPOpenModal({params}) ===
66 66  
... ... @@ -85,7 +85,7 @@
85 85  
86 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 } }}}}
87 87  
88 -== Параметры ==
95 += Параметры =
89 89  
90 90  ==== Обязательные параметры WPInit ====
91 91  
... ... @@ -125,6 +125,8 @@
125 125  **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
126 126  )))
127 127  
135 +----
136 +
128 128  ==== Возможные параметры WPOpen и WPOpenModal ====
129 129  
130 130  ===== Календарь и даты =====
... ... @@ -152,6 +152,8 @@
152 152  Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
153 153  Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
154 154  
164 +----
165 +
155 155  ===== Услуги, пакеты услуг, группы услуг =====
156 156  
157 157  ==== tariffsid: [29 ====
... ... @@ -191,7 +191,7 @@
191 191  
192 192  Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
193 193  
194 -~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
205 +----
195 195  
196 196  ===== Предзаказ =====
197 197  
... ... @@ -209,10 +209,155 @@
209 209  * date — дата, на которую покупается услуга
210 210  * count — количество покупаемых услуг
211 211  
212 -
213 213  ===== Пример передаваемых данных: =====
214 214  
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}}
215 215  
242 +===== Отображение =====
216 216  
244 +==== forcetab: 'rewrite' ====
217 217  
218 -
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'