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

Редактировал(а) Михаил Галич 26.11.2024, 12:16

<
От версии < 23.1 >
отредактировано Михаил Галич
на 13.12.2023, 10:20
К версии < 14.1 >
отредактировано Михаил Галич
на 12.12.2023, 11:11
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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