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

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

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

Комментарий

Подробности

Свойства страницы
Содержимое
... ... @@ -1,15 +1,12 @@
1 -{{toc depth="4"/}}
1 +== Для разработчиков ==
2 2  
3 -= Инструкция для подключения =
4 -
5 5  Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
6 6  
7 -~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр ##id## для подключения
5 +~1. Подключите скрипт external.script.js к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения
8 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,13 +30,13 @@
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  ===== Минимальный способ инициализации: =====
... ... @@ -47,29 +47,25 @@
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 61  Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с 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 74  Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'
75 75  
... ... @@ -77,7 +77,7 @@
77 77  
78 78  {{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}
79 79  
80 -== WPChange({status, data}) ==
73 +=== WPChange({status, data}) ===
81 81  
82 82  Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
83 83  
... ... @@ -90,32 +90,17 @@
90 90  
91 91  ===== Пример работы с данными: =====
92 92  
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}}
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 } }}}}
109 109  
110 -= Параметры =
88 +== Параметры ==
111 111  
112 -== Обязательные параметры WPInit ==
90 +==== Обязательные параметры WPInit ====
113 113  
114 114  ==== id: 1 ====
115 115  
116 116  id виджета, который можно узнать в Административной панели
117 117  
118 -== Возможные параметры WPInit ==
96 +==== Возможные параметры WPInit ====
119 119  
120 120  ==== height: 480 ====
121 121  
... ... @@ -147,12 +147,10 @@
147 147  **Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
148 148  )))
149 149  
150 -----
128 +==== Возможные параметры WPOpen и WPOpenModal ====
151 151  
152 -== Возможные параметры WPOpen и WPOpenModal ==
130 +===== Календарь и даты =====
153 153  
154 -=== Календарь и даты ===
155 -
156 156  ==== nocalendar: false ====
157 157  
158 158  Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false
... ... @@ -169,31 +169,43 @@
169 169  
170 170  Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
171 171  
172 -==== disableddates: ['23.02.2019', … ] ====
148 +==== disableddates: ['23.02.2019' ====
173 173  
150 +==== , … ] ====
151 +
174 174  Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
175 175  Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
176 176  
177 -----
155 +===== Услуги, пакеты услуг, группы услуг =====
178 178  
179 -=== Услуги, пакеты услуг, группы услуг ===
157 +==== tariffsid: [29 ====
180 180  
181 -==== tariffsid: [29, 30, … ] ====
159 +==== , 30 ====
182 182  
161 +==== , … ] ====
162 +
183 183  Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
184 184  Пример использования:
185 185  tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
186 186  tariffsid: false уберёт все тарифы с первой страницы
187 187  
188 -==== rtariffsid: [56, 57, … ] ====
168 +==== rtariffsid: [56 ====
189 189  
170 +==== , 57 ====
171 +
172 +==== , … ] ====
173 +
190 190  Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
191 191  Пример использования:
192 192  rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
193 193  tariffsid: false уберёт все тарифы с первой страницы
194 194  
195 -==== bundlesid: [4, 5, … ] ====
179 +==== bundlesid: [4 ====
196 196  
181 +==== , 5 ====
182 +
183 +==== , … ] ====
184 +
197 197  Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
198 198  Пример использования:
199 199  bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
... ... @@ -203,12 +203,18 @@
203 203  
204 204  Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
205 205  
206 -----
194 +~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--
207 207  
208 -=== Предзаказ ===
196 +===== Предзаказ =====
209 209  
210 -==== preorder: [{id: 57, date: '06.06.2019', count: 1}, … ] ====
198 +==== preorder: [{id: 57 ====
211 211  
200 +==== , date: '06.06.2019' ====
201 +
202 +==== , count: 1 ====
203 +
204 +==== }, … ] ====
205 +
212 212  Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
213 213  
214 214  * id — id услуги к покупке
... ... @@ -215,117 +215,10 @@
215 215  * date — дата, на которую покупается услуга
216 216  * count — количество покупаемых услуг
217 217  
212 +
218 218  ===== Пример передаваемых данных: =====
219 219  
220 -{{code language="javascript"}}
221 -// либо WPOpenModal({})
222 -WPOpen({
223 - preorder: [
224 - {
225 - id: 57,
226 - date: '06.06.2019',
227 - count: 1
228 - }, {
229 - id: 58,
230 - date: '07.06.2019',
231 - count: 2
232 - }
233 - ]
234 -})
235 -{{/code}}
236 236  
237 -=== Отображение ===
238 238  
239 -==== forcetab: 'rewrite' ====
240 240  
241 -Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab
242 -
243 -==== onlytab: 'rewrite' ====
244 -
245 -Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
246 -
247 -* onlytab: 'service' покажет только вкладку «покупка услуг».
248 -* onlytab: 'rewrite' покажет только вкладку «пополнение услуг».
249 -
250 -==== forcemedia: 'E0012345678900' ====
251 -
252 -Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
253 -
254 -==== nopromo: false ====
255 -
256 -Убирает вывод промокода на странице подтверждения заказа. По умолчанию false
257 -
258 -==== terminal: true ====
259 -
260 -Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
261 -
262 -==== cartmaxitems: 5 ====
263 -
264 -(% class="wikigeneratedid" %)
265 -Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6
266 -
267 -==== cartminitems: 2 ====
268 -
269 -Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1
270 -
271 -==== locale: 'ru' ====
272 -
273 -Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
274 -
275 -==== ordercomment: 'Комментарий к заказу' ====
276 -
277 -Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
278 -
279 -==== disablemultipleseances: true ====
280 -
281 -Параметр предотвращает добавление в корзину тарифов с различными сеансами.
282 -Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
283 -По умолчанию false
284 -
285 -==== tariffsseancesfilter: true ====
286 -
287 -[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]
288 -
289 -Включить отображение фильтра тарифов по сеансам. По умолчанию false
290 -
291 -==== resetcart: true ====
292 -
293 -Автоматически очищать содержимое корзины. По умолчанию false
294 -
295 -==== minimap: false ====
296 -
297 -Отображать миникарту. По умолчанию true
298 -
299 -==== minimapaspect: 0.5 ====
300 -
301 -Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2
302 -
303 -==== forceseanceid: 42 ====
304 -
305 -Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.
306 -
307 -==== forcesectorid: 42 ====
308 -
309 -Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.
310 -
311 -==== requiredloyalty: true ====
312 -
313 -Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false
314 -
315 -==== personallessonsskillstariffs: [56, 57, … ] ====
316 -
317 -Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []
318 -
319 -==== multidayslessonsskillstariffs: [56, 57, … ] ====
320 -
321 -Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []
322 -
323 -==== saletermstype: 'checkbox' ====
324 -
325 -Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
326 -
327 -* saletermstype: 'checkbox' потребует установку галочки для согласия.
328 -* saletermstype: 'dialog' покажет всплывающее окно с правилами, которые нужно принять.
329 -* saletermstype: 'default' принятие правил не требуется.
330 -
331 -По умолчанию 'default'
218 +