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

Версия 22.1 от Михаил Галич на 13.12.2023, 10:20

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