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

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

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

Комментарий

Подробности

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