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

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

Комментарий

Подробности

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