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

Редактировал(а) Михаил Галич 26.11.2024, 12:16
<
От версии < 5.1 >
отредактировано Михаил Галич
на 11.12.2023, 13:54
К версии < 20.1 >
отредактировано Михаил Галич
на 12.12.2023, 12:30
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

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