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

Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
От версии < 8.1 >
отредактировано Михаил Галич
на 12.12.2023, 10:53
К версии < 21.1 >
отредактировано Михаил Галич
на 12.12.2023, 15:46
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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