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

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