Исходный код вики Для разработчиков

Версия 9.1 от Михаил Галич на 12.12.2023, 10:54
Последние авторы
1 == Для разработчиков ==
2
3 Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
4
5 ~1. Подключите скрипт external.script.js к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения
6
7 2. Вставьте в необходимом месте на своём сайте код:
8
9 {{code language="html"}}
10 <script type="text/javascript">
11 // инициализируем виджет с параметрами
12 WPInit({
13 id: 1,
14 width: 400,
15 type: 'modal'
16 })
17
18 // сразу откроем его для пользователя
19 WPOpenModal(); // вариант для модального окна
20 // WPOpen(); // вариант для открытия в теле страницы. Используется при инициализации виджета с type: 'instant'
21
22 // будем следить за состоянием виджета
23 WPChange = function(response) {
24 if (response.status == 'reserved') {
25 // если заказ зарезирвирован, занесём данные из response.data.order_id себе на сайт
26 }
27 if (response.status == 'completed') {
28 // если заказ оплачен, занесём данные из response.data.order_id себе на сайт
29 }
30 }
31 </script>
32 {{/code}}
33
34 == Функции ==
35
36 === WPInit({params}) ===
37
38 Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
39
40 ===== Минимальный способ инициализации: =====
41
42 * WPInit({ id: 1 })
43
44 ===== Пример передаваемых данных: =====
45
46 Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
47
48 === {{code language="javascript"}}WPInit({
49 id: 1,
50 width: 400,
51 height: 600,
52 type: 'modal'
53 }){{/code}} ===
54
55 === WPOpen({params}) ===
56
57 Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'
58
59 ===== Пример передаваемых данных: =====
60
61 {{code language="javascript"}}
62 WPInit({
63 id: 1,
64 width: 400,
65 height: 600,
66 type: 'modal'
67 })
68 {{/code}}
69
70 === WPOpenModal({params}) ===
71
72 Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
73
74 ===== Пример передаваемых данных: =====
75
76 {{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
77
78 === WPChange({status, data}) ===
79
80 Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
81
82 ===== Примеры передаваемых данных: =====
83
84 * { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
85 * { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки
86 * { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id
87 * { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа
88
89 ===== Пример работы с данными: =====
90
91 {{{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 } }}}}
92
93 == Параметры ==
94
95 ==== Обязательные параметры WPInit ====
96
97 ==== id: 1 ====
98
99 id виджета, который можно узнать в Административной панели
100
101 ==== Возможные параметры WPInit ====
102
103 ==== height: 480 ====
104
105 Высота виджета в пикселях, по умолчанию:
106
107 * 480px, если виджет запущен как type: 'modal'
108 * 100%, если виджет запущен как type: 'instant'
109
110 ==== width: 640 ====
111
112 Ширина виджета в пикселях, по умолчанию:
113
114 * 640px, если виджет запущен как type: 'modal'
115 * 100%, если виджет запущен как type: 'instant'
116
117 ==== type: 'modal' ====
118
119 Способ открытия виджета, по умолчанию 'instant':
120
121 * 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
122 * 'modal' Открытие виджета в модальном окне
123
124 ==== place: '#place' ====
125
126 Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'
127
128 (% class="box warningmessage" %)
129 (((
130 **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
131 )))
132
133 ==== ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-- ====
134
135 ==== Возможные параметры WPOpen и WPOpenModal ====
136
137 ===== Календарь и даты =====
138
139 ==== nocalendar: false ====
140
141 Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false
142
143 ==== mindate: '01.01.2019' ====
144
145 Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
146
147 ==== maxdate: '01.01.2020' ====
148
149 Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
150
151 ==== forcedate: '12.06.2019' ====
152
153 Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
154
155 ==== disableddates: ['23.02.2019' ====
156
157 ==== , … ] ====
158
159 Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
160 Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
161
162 ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
163
164 ===== Услуги, пакеты услуг, группы услуг =====
165
166 ==== tariffsid: [29 ====
167
168 ==== , 30 ====
169
170 ==== , … ] ====
171
172 Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
173 Пример использования:
174 tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
175 tariffsid: false уберёт все тарифы с первой страницы
176
177 ==== rtariffsid: [56 ====
178
179 ==== , 57 ====
180
181 ==== , … ] ====
182
183 Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
184 Пример использования:
185 rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
186 tariffsid: false уберёт все тарифы с первой страницы
187
188 ==== bundlesid: [4 ====
189
190 ==== , 5 ====
191
192 ==== , … ] ====
193
194 Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
195 Пример использования:
196 bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
197 bundlesid: false уберёт все пакеты услуг с первой страницы
198
199 ==== groupid: 12 ====
200
201 Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
202
203 ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
204
205 ===== Предзаказ =====
206
207 ==== preorder: [{id: 57 ====
208
209 ==== , date: '06.06.2019' ====
210
211 ==== , count: 1 ====
212
213 ==== }, … ] ====
214
215 Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
216
217 * id — id услуги к покупке
218 * date — дата, на которую покупается услуга
219 * count — количество покупаемых услуг
220
221 ===== Пример передаваемых данных: =====
222
223 {{{// либо WPOpenModal({})
224 WPOpen({
225 preorder: [
226 {
227 id: 57,
228 date: '06.06.2019',
229 count: 1
230 }, {
231 id: 58,
232 date: '07.06.2019',
233 count: 2
234 }
235 ]
236 })}}}
237
238 ===== Отображение =====
239
240 ==== forcetab: 'rewrite' ====
241
242 Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab
243
244 ==== onlytab: 'rewrite' ====
245
246 Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
247
248 * onlytab: 'service' покажет только вкладку «покупка услуг».
249 * onlytab: 'rewrite' покажет только вкладку «пополнение услуг».
250
251 ==== forcemedia: 'E0012345678900' ====
252
253 Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
254
255 ==== nopromo: false ====
256
257 Убирает вывод промокода на странице подтверждения заказа. По умолчанию false
258
259 ==== terminal: true ====
260
261 Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
262
263 ==== cartmaxitems: 5 ====
264
265 ==== ====
266
267 Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6
268
269 ==== cartminitems: 2 ====
270
271 ==== ====
272
273 Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1
274
275 ==== locale: 'ru' ====
276
277 ==== ====
278
279 Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
280
281 ==== ordercomment: 'Комментарий к заказу' ====
282
283 ==== ====
284
285 Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
286
287 ==== disablemultipleseances: true ====
288
289 ==== ====
290
291 Параметр предотвращает добавление в корзину тарифов с различными сеансами.
292 Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
293 По умолчанию false
294
295
296 ==== tariffsseancesfilter: true ====
297
298 ==== ====
299
300 [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
301
302 Включить отображение фильтра тарифов по сеансам. По умолчанию false
303
304 ==== resetcart: true ====
305
306 ==== ====
307
308 Автоматически очищать содержимое корзины. По умолчанию false
309
310 ==== minimap: false ====
311
312 ==== ====
313
314 Отображать миникарту. По умолчанию true
315
316 ==== minimapaspect: 0.5 ====
317
318 ==== ====
319
320 Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
321
322 ==== forceseanceid: 42 ====
323
324 ==== ====
325
326 Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
327
328 ==== forcesectorid: 42 ====
329
330 ==== ====
331
332 Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
333
334 ==== requiredloyalty: true ====
335
336 ==== ====
337
338 Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
339
340 ==== personallessonsskillstariffs: [56 ====
341
342 ==== , 57 ====
343
344 ==== , … ] ====
345
346 ==== ====
347
348 Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
349
350 ==== multidayslessonsskillstariffs: [56 ====
351
352 ==== , 57 ====
353
354 ==== , … ] ====
355
356 ==== ====
357
358 Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
359
360 ==== saletermstype: 'checkbox' ====
361
362 ==== ====
363
364 Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
365
366 * saletermstype: 'checkbox' потребует установку галочки для согласия.
367 * saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять.
368 * saletermstype: 'default' принятие правил не требуется.
369
370 По умолчанию 'default'