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

Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
От версии < 22.1 >
отредактировано Михаил Галич
на 13.12.2023, 10:20
К версии < 5.2 >
отредактировано Михаил Галич
на 11.12.2023, 13:56
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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