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

Версия 21.1 от Михаил Галич на 12.12.2023, 15:46

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