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

Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
От версии < 2.1 >
отредактировано Михаил Галич
на 11.12.2023, 13:51
К версии < 22.1 >
отредактировано Михаил Галич
на 13.12.2023, 10:20
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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