Исходный код вики Для разработчиков

Версия 27.1 от Михаил Галич на 13.12.2023, 14:29

version	line-number	content
17.1	1	{{toc depth="4"/}}
13.1	2
15.1	3	= Инструкция для подключения =
13.1	4
21.1	5	Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманному вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:
1.1	6
13.1	7	~1. Подключите скрипт ##external.script.js## к вашему сайту. Его адрес будет доступен после добавления сайта в процессе настройки в администраторской панели Веб-Платформы, так же как и параметр ##id## для подключения
1.1	8
	9	2. Вставьте в необходимом месте на своём сайте код:
	10
8.1	11	{{code language="html"}}
	12	<script type="text/javascript">
5.1	13	// инициализируем виджет с параметрами
	14	WPInit({
	15	id: 1,
	16	width: 400,
	17	type: 'modal'
	18	})
1.1	19
5.1	20	// сразу откроем его для пользователя
	21	WPOpenModal(); // вариант для модального окна
	22	// WPOpen(); // вариант для открытия в теле страницы. Используется при инициализации виджета с type: 'instant'
1.1	23
5.1	24	// будем следить за состоянием виджета
	25	WPChange = function(response) {
	26	if (response.status == 'reserved') {
	27	// если заказ зарезирвирован, занесём данные из response.data.order_id себе на сайт
	28	}
	29	if (response.status == 'completed') {
	30	// если заказ оплачен, занесём данные из response.data.order_id себе на сайт
	31	}
	32	}
8.1	33	</script>
	34	{{/code}}
5.1	35
15.1	36	= Функции =
1.1	37
16.1	38	== WPInit({params}) ==
1.2	39
	40	Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели
	41
	42	===== Минимальный способ инициализации: =====
	43
25.1	44	{{code language="javascript"}}
	45	WPInit({ id: 1 })
	46	{{/code}}
1.2	47
	48	===== Пример передаваемых данных: =====
	49
	50	Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.
	51
10.1	52	{{code language="javascript"}}
	53	WPInit({
1.2	54	id: 1,
	55	width: 400,
	56	height: 600,
	57	type: 'modal'
10.1	58	})
	59	{{/code}}
1.2	60
16.1	61	== WPOpen({params}) ==
1.2	62
22.1	63	Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с ##type: 'instant'##
1.2	64
	65	===== Пример передаваемых данных: =====
	66
9.1	67	{{code language="javascript"}}
10.1	68	// показ виджета с группой id 5
	69	WPOpen({
	70	groupid: [5]
9.1	71	})
	72	{{/code}}
1.2	73
16.1	74	== WPOpenModal({params}) ==
1.2	75
22.1	76	Функция открытия виджета в модальном окне, используется при инициализации виджета с ##type: 'modal'##
1.2	77
	78	===== Пример передаваемых данных: =====
	79
22.1	80	{{code language="javascript"}}
	81	// показ виджета на нажатие кнопки с id "OpenButton"
	82	var OpenButton = document.getElementById('OpenButton');
	83	OpenButton.onclick = function () {
	84	WPOpenModal({ tariffsid: [27, 28] });
	85	};
	86	{{/code}}
1.2	87
16.1	88	== WPChange({status, data}) ==
1.2	89
	90	Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript
	91
	92	===== Примеры передаваемых данных: =====
	93
22.1	94	* ##{ status:'starting' }## — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать
	95	* ##{ status:'started' }## — виджет на начальном экране, где показывается список услуг для покупки
	96	* ##{ status:'reserved', data: { order_id: 2 } }## — виджет находится на стадии забронированного заказ, в data передаётся id
	97	* ##{ status:'completed', data: { order_id: 2 } }## — виджет находится на стадии оплаченного заказ, в data передаётся id заказа
1.2	98
	99	===== Пример работы с данными: =====
	100
16.1	101	{{code language="javascript"}}
	102	WPChange = function(response) {
	103	if (response.status == 'starting') {
	104	// действие на внешней странице
	105	}
	106	if (response.status == 'started') {
	107	// действие на внешней странице
	108	}
	109	if (response.status == 'reserved') {
	110	// id зарезервированного заказа: response.data.order_id
	111	}
	112	if (response.status == 'completed') {
	113	// id оплаченного заказа: response.data.order_id
	114	}
	115	}
	116	{{/code}}
1.2	117
15.1	118	= Параметры =
1.2	119
16.1	120	== Обязательные параметры WPInit ==
1.2	121
22.1	122	==== id ====
1.2	123
22.1	124	Тип данных:## //number//##
	125
1.2	126	id виджета, который можно узнать в Административной панели
	127
16.1	128	== Возможные параметры WPInit ==
1.2	129
22.1	130	==== height ====
1.2	131
22.1	132	Тип данных:## //number //##//\|## boolean##//
	133
	134	По умолчанию:##// false//##
	135
1.2	136	Высота виджета в пикселях, по умолчанию:
	137
	138	* 480px, если виджет запущен как type: 'modal'
	139	* 100%, если виджет запущен как type: 'instant'
	140
22.1	141	==== width ====
1.2	142
22.1	143	Тип данных:## //number //##//\|## boolean##//
	144
	145	По умолчанию:##// false//##
	146
1.2	147	Ширина виджета в пикселях, по умолчанию:
	148
	149	* 640px, если виджет запущен как type: 'modal'
	150	* 100%, если виджет запущен как type: 'instant'
	151
22.1	152	==== type ====
5.2	153
22.1	154	Тип данных:## //string//##
5.2	155
22.1	156	По умолчанию:##// 'instant'//##
	157
	158	Способ открытия виджета
	159
5.2	160	* 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации
	161	* 'modal' Открытие виджета в модальном окне
	162
22.1	163	==== place ====
5.2	164
22.1	165	Тип данных:## //string //##//\|## boolean##//
	166
	167	По умолчанию:##// false//##
	168
5.2	169	Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'
	170
	171	(% class="box warningmessage" %)
	172	(((
	173	Важно: элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)
	174	)))
	175
13.1	176	----
6.1	177
16.1	178	== Возможные параметры WPOpen и WPOpenModal ==
5.2	179
16.1	180	=== Календарь и даты ===
5.2	181
25.1	182	==== disableddates ====
5.2	183
25.1	184	Тип данных:##// Array<string>//##
	185
	186	По умолчанию:##// []//##
	187
24.1	188	Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.
	189	Пример использования:
5.2	190
24.1	191	{{code language="javascript"}}
	192	disableddates: ['23.02.2018', '08.03.2018']
	193	{{/code}}
22.1	194
24.1	195	уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.
22.1	196
24.1	197	==== forcedate ====
5.2	198
25.1	199	Тип данных:##// string//##
24.1	200
	201	По умолчанию:##// undefined//##
	202
	203	Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.
	204
	205	==== maxdate ====
	206
25.1	207	Тип данных:##// string//##
24.1	208
	209	По умолчанию:##// undefined//##
	210
5.2	211	Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.
	212
24.1	213	==== mindate ====
22.1	214
25.1	215	Тип данных:##// string//##
22.1	216
24.1	217	По умолчанию:##// undefined//##
5.2	218
24.1	219	Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня
5.2	220
24.1	221	==== nocalendar ====
5.2	222
24.1	223	Тип данных:## //boolean//##
5.2	224
24.1	225	По умолчанию:##// false//##
20.1	226
24.1	227	Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна.
20.1	228
13.1	229	----
6.1	230
16.1	231	=== Услуги, пакеты услуг, группы услуг ===
5.2	232
25.1	233	==== tariffsid ====
5.2	234
25.1	235	Тип данных:##// Array<number> //##//\|## boolean##//
	236
	237	По умолчанию:##// []//##
	238
5.2	239	Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
22.1	240
5.2	241	Пример использования:
	242
25.1	243	{{code language="javascript"}}
	244	tariffsid: [29, 30] // покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».
	245	tariffsid: false // уберёт все тарифы с первой страницы
	246	{{/code}}
5.2	247
25.1	248	==== rtariffsid ====
	249
	250	Тип данных:##// Array<number> //##//\|## boolean##//
	251
	252	По умолчанию:##// []//##
	253
5.2	254	Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.
22.1	255
5.2	256	Пример использования:
	257
25.1	258	{{code language="javascript"}}
	259	rtariffsid: [56, 57] // покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»
	260	rtariffsid: false // уберёт все тарифы во вкладке «Пополнение услуг»
	261	{{/code}}
5.2	262
25.1	263	==== bundlesid ====
	264
	265	Тип данных:##// Array<number> //##//\|## boolean##//
	266
	267	По умолчанию:##// []//##
	268
5.2	269	Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.
22.1	270
5.2	271	Пример использования:
	272
25.1	273	{{code language="javascript"}}
	274	bundlesid: [4, 5] // покажет пакеты услуг с id 4 и 5 в момент открытия виджета.
	275	bundlesid: false // уберёт все пакеты услуг с первой страницы
	276	{{/code}}
5.2	277
25.1	278	==== groupid ====
	279
	280	Тип данных:##// number//##
	281
	282	По умолчанию:##// undefined//##
	283
5.2	284	Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.
	285
13.1	286	----
5.2	287
16.1	288	=== Предзаказ ===
5.2	289
25.1	290	==== preorder ====
5.2	291
25.1	292	Тип данных:##// Array<object>//##
	293
	294	По умолчанию:##// undefined//##
	295
5.2	296	Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.
	297
	298	* id — id услуги к покупке
	299	* date — дата, на которую покупается услуга
	300	* count — количество покупаемых услуг
	301
	302	===== Пример передаваемых данных: =====
	303
11.1	304	{{code language="javascript"}}
	305	// либо WPOpenModal({})
6.2	306	WPOpen({
	307	preorder: [
	308	{
	309	id: 57,
	310	date: '06.06.2019',
	311	count: 1
	312	}, {
	313	id: 58,
	314	date: '07.06.2019',
	315	count: 2
	316	}
	317	]
11.1	318	})
	319	{{/code}}
5.2	320
16.1	321	=== Отображение ===
5.2	322
25.1	323	==== forcetab ====
5.2	324
25.1	325	Тип данных:##// string//##
	326
	327	По умолчанию:##// ''//##
	328
21.1	329	Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром ##onlytab##
6.2	330
25.1	331	==== onlytab ====
6.2	332
25.1	333	Тип данных:##// string //##//\|## Array<string>##//
	334
	335	По умолчанию:##// []//##
	336
6.2	337	Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab
	338
25.1	339	{{code language="javascript"}}
	340	onlytab: 'service' // покажет только вкладку «покупка услуг».
	341	onlytab: 'rewrite' // покажет только вкладку «пополнение услуг».
	342	onlytab: ['service', 'rewrite'] // покажет только вкладки «покупка услуг» и «пополнение услуг»;
	343	{{/code}}
6.2	344
25.1	345	==== forcemedia ====
6.2	346
25.1	347	Тип данных:##// string//##
	348
	349	По умолчанию:##// ''//##
	350
6.2	351	Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.
	352
25.1	353	Пример:
6.2	354
25.1	355	{{code language="javascript"}}
	356	forcemedia: 'E0012345678900'
	357	{{/code}}
	358
	359	==== nopromo ====
	360
	361	Тип данных:##// boolean//##
	362
	363	По умолчанию:##// false//##
	364
21.1	365	Убирает вывод промокода на странице подтверждения заказа.
6.2	366
25.1	367	==== terminal ====
6.2	368
25.1	369	Тип данных:##// boolean//##
21.1	370
25.1	371	По умолчанию:##// false//##
	372
6.2	373	Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.
	374
26.1	375	==== cartmaxitems ====
6.2	376
26.1	377	Тип данных:##// number//##
6.2	378
26.1	379	По умолчанию:##// 6//##
	380
21.1	381	(% class="wikigeneratedid" %)
26.1	382	Ограничивает максимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.##
6.2	383
26.1	384	==== cartminitems ====
6.2	385
26.1	386	Тип данных:##// number//##
6.2	387
26.1	388	По умолчанию:##// 1//##
21.1	389
26.1	390	Ограничивает минимальное кол-во товаров в корзине. ##Минимальное значение 1. Максимальное значение 60.##
21.1	391
26.1	392	==== locale ====
	393
	394	Тип данных:##// string//##
	395
	396	По умолчанию:##// ''//##
	397
6.2	398	Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.
	399
26.1	400	==== ordercomment ====
6.2	401
26.1	402	Тип данных:##// string//##
	403
	404	По умолчанию:##// ''//##
	405
6.2	406	Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.
	407
26.1	408	==== disablemultipleseances ====
6.2	409
26.1	410	Тип данных:##// boolean//##
	411
	412	По умолчанию:##// false//##
	413
6.2	414	Параметр предотвращает добавление в корзину тарифов с различными сеансами.
	415	Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.
	416
26.1	417	==== tariffsseancesfilter ====
6.2	418
26.1	419	Тип данных:##// boolean//##
	420
	421	По умолчанию:##// false//##
	422
6.2	423	[[image:https://info.moipass.ru/images/tariffsseancesfilter.png\|\|alt="Example"]]
	424
21.1	425	Включить отображение фильтра тарифов по сеансам.
6.2	426
26.1	427	==== resetcart ====
6.2	428
26.1	429	Тип данных:##// boolean//##
6.2	430
26.1	431	По умолчанию:##// false//##
	432
21.1	433	Автоматически очищать содержимое корзины.
6.2	434
26.1	435	==== minimap ====
6.2	436
26.1	437	Тип данных:##// boolean//##
6.2	438
26.1	439	По умолчанию:##// true//##
	440
21.1	441	Отображать миникарту.
6.2	442
26.1	443	==== minimapaspect ====
6.2	444
26.1	445	Тип данных:##// number//##
6.2	446
26.1	447	По умолчанию:##// 0.2//##
	448
21.1	449	Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится.
6.2	450
26.1	451	==== forceseanceid ====
6.2	452
26.1	453	Тип данных:##// number//##
6.2	454
26.1	455	По умолчанию без указания идентификатора не учитывается.
	456
21.1	457	Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий.
6.2	458
26.1	459	==== forcesectorid ====
	460
	461	Тип данных:##// number//##
	462
21.1	463	По умолчанию без указания идентификатора не учитывается.
6.2	464
21.1	465	Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов.
6.2	466
27.1	467	==== requiredloyalty ====
6.2	468
26.1	469	Тип данных:##// boolean//##
	470
	471	По умолчанию:##// false//##
	472
21.1	473	Включает обязательную регистриацию клиента в программе настроенной на объектке.
	474
26.1	475	==== personallessonsskillstariffs ====
21.1	476
26.1	477	Тип данных:##// Array<number> //##//\|## object##//
21.1	478
26.1	479	По умолчанию:##// []//##
	480
21.1	481	Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов.
	482
26.1	483	==== multidayslessonsskillstarif(% style="display:none" %) (%%)fs ====
21.1	484
26.1	485	Тип данных:##// Array<number> //##//\|## object##//
21.1	486
26.1	487	По умолчанию:##// []//##
	488
21.1	489	Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs.
	490
27.1	491	==== saletermstype ====
21.1	492
26.1	493	Тип данных:##// string//##
	494
	495	По умолчанию:##// '//default//'//##
	496
6.2	497	Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна
	498
26.1	499	{{code language="javascript"}}
	500	saletermstype: 'checkbox' // потребует установку галочки для согласия.
	501	saletermstype: 'dialog' // покажет всплывающее окно с правилами, которые нужно принять.
	502	saletermstype: 'default' // принятие правил не требуется.
	503	{{/code}}