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

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

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

Комментарий

Подробности

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