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

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