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

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

<
От версии < 21.1 >
отредактировано Михаил Галич
на 12.12.2023, 15:46
К версии < 18.1 >
отредактировано Михаил Галич
на 12.12.2023, 11:26
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -2,7 +2,7 @@
2 2  
3 3  = Инструкция для подключения =
4 4  
5 -Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
5 +Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
6 6  
7 7  ~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения
8 8  
... ... @@ -111,13 +111,13 @@
111 111  
112 112  == Обязательные параметры WPInit ==
113 113  
114 -==== id: 1 ##//number//## ====
114 +==== id: 1 ====
115 115  
116 116  id виджета, который можно узнать в Административной панели
117 117  
118 118  == Возможные параметры WPInit ==
119 119  
120 -==== height: 480 ##//number//## ====
120 +==== height: 480 ====
121 121  
122 122  Высота виджета в пикселях, по умолчанию:
123 123  
... ... @@ -124,7 +124,7 @@
124 124  * 480px, если виджет запущен как type: 'modal'
125 125  * 100%, если виджет запущен как type: 'instant'
126 126  
127 -==== width: 640 ##//number//## ====
127 +==== width: 640 ====
128 128  
129 129  Ширина виджета в пикселях, по умолчанию:
130 130  
... ... @@ -131,7 +131,7 @@
131 131  * 640px, если виджет запущен как type: 'modal'
132 132  * 100%, если виджет запущен как type: 'instant'
133 133  
134 -==== type: 'modal' ##//string//## ====
134 +==== type: 'modal' ====
135 135  
136 136  Способ открытия виджета, по умолчанию 'instant':
137 137  
... ... @@ -138,7 +138,7 @@
138 138  * 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
139 139  * 'modal' Открытие виджета в модальном окне
140 140  
141 -==== place: '#place' ##//string//## ====
141 +==== place: '#place' ====
142 142  
143 143  Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'
144 144  
... ... @@ -153,38 +153,32 @@
153 153  
154 154  === Календарь и даты ===
155 155  
156 -==== nocalendar: false ##//boolean//## ====
156 +==== nocalendar: false ====
157 157  
158 158  Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false
159 159  
160 -==== mindate: '01.01.2019' ##//string//## ====
160 +==== mindate: '01.01.2019' ====
161 161  
162 162  Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
163 163  
164 -==== maxdate: '01.01.2020' ##//string//## ====
164 +==== maxdate: '01.01.2020' ====
165 165  
166 166  Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
167 167  
168 -==== forcedate: '12.06.2019' ##//string//## ====
168 +==== forcedate: '12.06.2019' ====
169 169  
170 170  Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
171 171  
172 -==== disableddates: ['23.02.2019', … ] ##//Array<string>//## ====
172 +==== disableddates: ['23.02.2019', … ] ====
173 173  
174 174  Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
175 -Пример использования:
175 +Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
176 176  
177 -{{code language="javascript"}}
178 -disableddates: ['23.02.2018', '08.03.2018']
179 -{{/code}}
180 -
181 -уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
182 -
183 183  ----
184 184  
185 185  === Услуги, пакеты услуг, группы услуг ===
186 186  
187 -==== tariffsid: [29, 30, … ] ##//Array<number>//## ====
181 +==== tariffsid: [29, 30, … ] ====
188 188  
189 189  Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
190 190  Пример использования:
... ... @@ -191,7 +191,7 @@
191 191  tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
192 192  tariffsid: false уберёт все тарифы с первой страницы
193 193  
194 -==== rtariffsid: [56, 57, … ] ##//Array<number>//## ====
188 +==== rtariffsid: [56, 57, … ] ====
195 195  
196 196  Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
197 197  Пример использования:
... ... @@ -198,7 +198,7 @@
198 198  rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
199 199  tariffsid: false уберёт все тарифы с первой страницы
200 200  
201 -==== bundlesid: [4, 5, … ] ##//Array<number>//## ====
195 +==== bundlesid: [4, 5, … ] ====
202 202  
203 203  Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
204 204  Пример использования:
... ... @@ -205,7 +205,7 @@
205 205  bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
206 206  bundlesid: false уберёт все пакеты услуг с первой страницы
207 207  
208 -==== groupid: 12 ##//number//## ====
202 +==== groupid: 12 ====
209 209  
210 210  Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
211 211  
... ... @@ -213,7 +213,7 @@
213 213  
214 214  === Предзаказ ===
215 215  
216 -==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ##//Array<object>//## ====
210 +==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ====
217 217  
218 218  Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
219 219  
... ... @@ -242,11 +242,11 @@
242 242  
243 243  === Отображение ===
244 244  
245 -==== forcetab: 'rewrite' ##//string//## ====
239 +==== forcetab: 'rewrite' ====
246 246  
247 -Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab##
241 +Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab
248 248  
249 -==== onlytab: 'rewrite' ##//string//## ====
243 +==== onlytab: 'rewrite' ====
250 250  
251 251  Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
252 252  
... ... @@ -253,110 +253,113 @@
253 253  * onlytab: 'service' покажет только вкладку «покупка услуг».
254 254  * onlytab: 'rewrite' покажет только вкладку «пополнение услуг».
255 255  
256 -==== forcemedia: 'E0012345678900' ##//string//## ====
250 +==== forcemedia: 'E0012345678900' ====
257 257  
258 258  Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
259 259  
260 -==== nopromo: false ##//boolean//## ====
254 +==== nopromo: false ====
261 261  
262 -Убирает вывод промокода на странице подтверждения заказа.
256 +Убирает вывод промокода на странице подтверждения заказа. По умолчанию false
263 263  
264 -По умолчанию ##false##
258 +==== terminal: true ====
265 265  
266 -==== terminal: true ##//boolean//## ====
267 -
268 268  Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
269 269  
270 -==== cartmaxitems: 5 ##//number//## ====
262 +==== cartmaxitems: 5 ====
271 271  
272 272  (% class="wikigeneratedid" %)
273 -Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60.
265 +Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6
274 274  
275 -(% class="wikigeneratedid" %)
276 -По умолчанию ##6##
267 +==== cartminitems: 2 ====
277 277  
278 -==== cartminitems: 2 ##//number//## ====
269 +==== ====
279 279  
280 -Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60.
271 +Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1
281 281  
282 -По умолчанию ##1##
273 +==== locale: 'ru' ====
283 283  
284 -==== locale: 'ru' ##//string//## ====
275 +==== ====
285 285  
286 286  Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
287 287  
288 -==== ordercomment: 'Комментарий к заказу' ##//string//## ====
279 +==== ordercomment: 'Комментарий к заказу' ====
289 289  
281 +==== ====
282 +
290 290  Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
291 291  
292 -==== disablemultipleseances: true ##//boolean//## ====
285 +==== disablemultipleseances: true ====
293 293  
287 +==== ====
288 +
294 294  Параметр предотвращает добавление в корзину тарифов с различными сеансами.
295 295  Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
296 -По умолчанию ##false##
291 +По умолчанию false
297 297  
298 -==== tariffsseancesfilter: true ##//boolean//## ====
293 +==== tariffsseancesfilter: true ====
299 299  
295 +==== ====
296 +
300 300  [[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
301 301  
302 -Включить отображение фильтра тарифов по сеансам.
299 +Включить отображение фильтра тарифов по сеансам. По умолчанию false
303 303  
304 -По умолчанию ##false##
301 +==== resetcart: true ====
305 305  
306 -==== resetcart: true ##//boolean//## ====
303 +==== ====
307 307  
308 -Автоматически очищать содержимое корзины.
305 +Автоматически очищать содержимое корзины. По умолчанию false
309 309  
310 -По умолчанию ##false##
307 +==== minimap: false ====
311 311  
312 -==== minimap: false ##//boolean//## ====
309 +==== ====
313 313  
314 -Отображать миникарту.
311 +Отображать миникарту. По умолчанию true
315 315  
316 -По умолчанию ##true##
313 +==== minimapaspect: 0.5 ====
317 317  
318 -==== minimapaspect: 0.5 ##//number//## ====
315 +==== ====
319 319  
320 -Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится.
317 +Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
321 321  
322 -По умолчанию ##0.2##
319 +==== forceseanceid: 42 ====
323 323  
324 -==== forceseanceid: 42 ##//number//## ====
321 +==== ====
325 325  
326 -Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий.
323 +Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
327 327  
328 -По умолчанию без указания идентификатора не учитывается.
325 +==== forcesectorid: 42 ====
329 329  
330 -==== forcesectorid: 42 ##//number//## ====
327 +==== ====
331 331  
332 -Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов.
329 +Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
333 333  
334 -По умолчанию без указания идентификатора не учитывается.
331 +==== requiredloyalty: true ====
335 335  
336 -==== requiredloyalty: true ##//boolean//## ====
333 +==== ====
337 337  
338 -Включает обязательную регистриацию клиента в программе настроенной на объектке.
335 +Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
339 339  
340 -По умолчанию ##false##
337 +==== personallessonsskillstariffs: [56, 57, … ] ====
341 341  
342 -==== personallessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ====
339 +==== ====
343 343  
344 -Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов.
341 +Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
345 345  
346 -По умолчанию ##[]##
343 +==== multidayslessonsskillstariffs: [56, 57, … ] ====
347 347  
348 -==== multidayslessonsskillstariffs: [56, 57, … ] ##//Array<number>//## ====
345 +==== ====
349 349  
350 -Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs.
347 +Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
351 351  
352 -По умолчанию ##[]##
349 +==== saletermstype: 'checkbox' ====
353 353  
354 -==== saletermstype: 'checkbox' ##//string//## ====
351 +==== ====
355 355  
356 356  Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
357 357  
358 -* saletermstype: ##'checkbox'## потребует установку галочки для согласия.
359 -* saletermstype: ##'dialog'## покажет всплывающее окно с правилами, которые нужно принять.
360 -* saletermstype: ##'default'## принятие правил не требуется.
355 +* saletermstype: 'checkbox' потребует установку галочки для согласия.
356 +* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять.
357 +* saletermstype: 'default' принятие правил не требуется.
361 361  
362 -По умолчанию ##'default'##
359 +По умолчанию 'default'