Для разработчиков

== Для разработчиков ==

Назначение данного раздела — описать способы взаимодействия с виджетом Веб-платформы по задуманому вами сценарию. Типичный процесс подключения, открытия и отслеживания виджета выглядит так:

4

5

~1. Подключите скрипт external.script.js к вашему сайту. Его адрес будет доступен **после добавления сайта** в процессе настройки в **администраторской панели Веб-Платформы**, так же как и параметр id для подключения

6

7

2. Вставьте в необходимом месте на своём сайте код:

8

9

{{{<script type="text/javascript">

10

// инициализируем виджет с параметрами

WPInit({

id: 1,

width: 400,

type: 'modal'

})

// сразу откроем его для пользователя

18

WPOpenModal(); // вариант для модального окна

19

// WPOpen(); // вариант для открытия в теле страницы. Используется при инициализации виджета с type: 'instant'

20

21

// будем следить за состоянием виджета

22

WPChange = function(response) {

23

if (response.status == 'reserved') {

24

// если заказ зарезирвирован, занесём данные из response.data.order_id себе на сайт

25

}

26

if (response.status == 'completed') {

27

// если заказ оплачен, занесём данные из response.data.order_id себе на сайт

}

}

</script>}}}

== Функции ==

=== WPInit({params}) ===

36

37

Функция загрузки виджета с параметризацией, при создании необходимо передать id виджета, который можно найти в Административной панели

38

39

===== Минимальный способ инициализации: =====

* WPInit({ id: 1 })

===== Пример передаваемых данных: =====

44

45

Виджет можно инициализировать с различными параметрами, все из них опциональные, кроме id.

{{{WPInit({

id: 1,

width: 400,

height: 600,

type: 'modal'

})}}}

=== WPOpen({params}) ===

55

56

Функция открытия виджета в каком-либо блоке, используется при инициализации виджета с type: 'instant'

57

58

===== Пример передаваемых данных: =====

59

60

{{{// показ виджета с группой id 5

WPOpen({

groupid: [5]

})}}}

=== WPOpenModal({params}) ===

66

67

Функция открытия виджета в модальном окне, используется при инициализации виджета с type: 'modal'

68

69

===== Пример передаваемых данных: =====

70

71

{{{// показ виджета на нажатие кнопки с id "OpenButton" var OpenButton = document.getElementById('OpenButton'); OpenButton.onclick = function() { WPOpenModal({ tariffsid: [27, 28] }) }}}}

72

73

=== WPChange({status, data}) ===

74

75

Функция, которая вызывается каждый раз при изменении состояния виджета. Каждый раз передаёт в переменной response состояние в status и опционально данные в data. При переопределении этой функции у себя на странице, администратор может следить за состоянием виджета и статусом заказа из javascript

76

77

===== Примеры передаваемых данных: =====

78

79

* { status:'starting' } — виджет в процессе запуска, в этот момент определяется, что он должен в данный момент отображать

80

* { status:'started' } — виджет на начальном экране, где показывается список услуг для покупки

81

* { status:'reserved', data: { order_id: 2 } } — виджет находится на стадии забронированного заказ, в data передаётся id

82

* { status:'completed', data: { order_id: 2 } } — виджет находится на стадии оплаченного заказ, в data передаётся id заказа

83

84

===== Пример работы с данными: =====

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 } }}}}

== Параметры ==

==== Обязательные параметры WPInit ====

==== id: 1 ====

id виджета, который можно узнать в Административной панели

95

96

==== Возможные параметры WPInit ====

97

98

==== height: 480 ====

99

100

Высота виджета в пикселях, по умолчанию:

101

102

* 480px, если виджет запущен как type: 'modal'

103

* 100%, если виджет запущен как type: 'instant'

==== width: 640 ====

Ширина виджета в пикселях, по умолчанию:

108

109

* 640px, если виджет запущен как type: 'modal'

110

* 100%, если виджет запущен как type: 'instant'

111

112

==== type: 'modal' ====

113

114

Способ открытия виджета, по умолчанию 'instant':

115

116

* 'instant' Открытие виджета на месте, где был вызов виджета (на месте тэга script), либо в блоке place, если он указан в параметрах виджета при инициализации

117

* 'modal' Открытие виджета в модальном окне

118

119

==== place: '#place' ====

120

121

Идентификатор элемента DOM, в который необходимо поместить виджет, например: #widget. Используется совместно с type: 'instant'

122

123

(% class="box warningmessage" %)

124

(((

125

**Важно:** элемент DOM для place должен быть либо на странице до вставки инициализации виджета (WPInit), либо инициализация виджета должна быть исполнена после загрузки DOM (например, обёрнута в событие $(document).ready(function(){}) в jQuery)

126

)))

127

128

==== ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-- ====

129

130

==== Возможные параметры WPOpen и WPOpenModal ====

131

132

===== Календарь и даты =====

133

134

==== nocalendar: false ====

135

136

Убирает календарь внутри виджета (и в //покупке// и в //пополнении//), в случаях, когда дата, на которую покупается/пополняется билет, не важна. По умолчанию false

137

138

==== mindate: '01.01.2019' ====

139

140

Параметр минимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). mindate: '20.05.2018' покажет 20.05.2018 как самую первую дату, доступную к выбору в календаре, если она находится после текущего дня

141

142

==== maxdate: '01.01.2020' ====

143

144

Параметр максимальной отображаемой даты в календаре (и в //покупке// и в //пополнении//). maxdate: '20.05.2018' покажет 20.05.2018 как самую последнюю дату, доступную к выбору в календаре.

145

146

==== forcedate: '12.06.2019' ====

147

148

Параметр для открывания виджета с указанной сразу датой (и в //покупке// и в //пополнении//). forcedate: '20.05.2018' покажет услуги к продаже на дату 20.05.2018.

149

150

==== disableddates: ['23.02.2019' ====

==== , … ] ====

Параметр отключения дат в календаре (и в //покупке// и в //пополнении//). Делает невозможным выбор определённых дней в массиве дат.

155

Пример использования: disableddates: ['23.02.2018', '08.03.2018'] уберёт даты 23.02.2018 и 08.03.2018 из возможных для выбора дат в календаре.

156

157

~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--

158

159

===== Услуги, пакеты услуг, группы услуг =====

160

161

==== tariffsid: [29 ====

==== , 30 ====

==== , … ] ====

Тарифы, которые следует показать на вкладке «Покупка услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.

168

Пример использования:

169

tariffsid: [29, 30] покажет тарифы с id 29 и 30 во вкладке «Покупка услуг».

170

tariffsid: false уберёт все тарифы с первой страницы

171

172

==== rtariffsid: [56 ====

==== , 57 ====

==== , … ] ====

Тарифы, которые следует показать после ввода карты во вкладке «Пополнение услуг». По умолчанию массив пуст и не показывает отдельно никакие из услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать услуги, доступные только для него.

179

Пример использования:

180

rtariffsid: [56, 57] покажет тарифы с id 56 и 57 после ввода карты во вкладке «Пополнение услуг»

181

tariffsid: false уберёт все тарифы с первой страницы

182

183

==== bundlesid: [4 ====

==== , 5 ====

==== , … ] ====

Пакеты услуг, которые следует показать на первой странице. По умолчанию массив пуст и не показывает отдельно никакие из пакетов услуг. Используется для принудительной фильтрации в том случае, когда определённому пользователю необходимо показывать пакеты услуг, доступные только для него.

190

Пример использования:

191

bundlesid: [4, 5] покажет пакеты услуг с id 4 и 5 в момент открытия виджета.

192

bundlesid: false уберёт все пакеты услуг с первой страницы

193

194

==== groupid: 12 ====

195

196

Параметр, который форсирует показ определённой группы услуг ппс. groupid: 5 покажет только одну группу с id 5 в виджете.

197

198

~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~--

199

200

===== Предзаказ =====

201

202

==== preorder: [{id: 57 ====

203

204

==== , date: '06.06.2019' ====

==== , count: 1 ====

==== }, … ] ====

Параметр, позволяющий купить сразу несколько услуг и перейти к подтверждению покупки.

211

212

* id — id услуги к покупке

213

* date — дата, на которую покупается услуга

214

* count — количество покупаемых услуг

215

216

===== Пример передаваемых данных: =====

217

218

{{{// либо WPOpenModal({})

WPOpen({

preorder: [

{

id: 57,

date: '06.06.2019',

count: 1

}, {

id: 58,

date: '07.06.2019',

count: 2

}

]

})}}}

===== Отображение =====

234

235

==== forcetab: 'rewrite' ====

236

237

Переключение на необходимую вкладку виджета («покупка услуг» или «пополнение услуг») при загрузке. По умолчанию открывается вкладка «покупка услуг». forcetab: 'rewrite' принудительно откроет «пополнение услуг». Обычно используется в комбинации с параметром onlytab

238

239

==== onlytab: 'rewrite' ====

240

241

Скрытие других вкладок виджета («покупка услуг» или «пополнение услуг») при загрузке. Обычно используется в комбинации с параметром forcetab

242

243

* onlytab: 'service' покажет только вкладку «покупка услуг».

244

* onlytab: 'rewrite' покажет только вкладку «пополнение услуг».

245

246

247

==== forcemedia: 'E0012345678900' ====

248

249

Параметр, который вставяет строчку с носителем в поле носителя во вкладке «Пополнение услуг». Используется, например, для QR-кода нанесённого на носитель, чтобы быстро его пополнить.

250

251

==== nopromo: false ====

252

253

Убирает вывод промокода на странице подтверждения заказа. По умолчанию false

254

255

==== terminal: true ====

256

257

Включение режима «терминал» для работы виджета. При этом режиме убирается возможность отослать заказ на SMS, а сам заказ распечатывается на принтере.

258

259

==== cartmaxitems: 5 ====

==== ====

Ограничивает максимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 6

264

265

==== cartminitems: 2 ====

==== ====

Ограничивает минимальное кол-во товаров в корзине. Минимальное значение 1. Максимальное значение 60. По умолчанию 1

270

271

==== locale: 'ru' ====

==== ====

Параметр локализации. Позволяет переключать между языками виджета, например 'ru' - русский язык, 'en' - английский язык.

276

277

==== ordercomment: 'Комментарий к заказу' ====

==== ====

Опциональный комментарий к заказу. Максимальная длинна комментария 50 символов.

282

283

==== disablemultipleseances: true ====

==== ====

Параметр предотвращает добавление в корзину тарифов с различными сеансами.

288

Таким образом как только в корзине появится хоть один товар с сеансом "10:00 - 11:30", товары, у которых есть сеанс например "13:00 - 14:30" будет невозможно добавить в корзину. Товары без сеансов не будут затронуты.

По умолчанию false

==== tariffsseancesfilter: true ====

==== ====

[[image:https://info.moipass.ru/images/tariffsseancesfilter.png||alt="Example"]]

297

298

Включить отображение фильтра тарифов по сеансам. По умолчанию false

299

300

==== resetcart: true ====

==== ====

Автоматически очищать содержимое корзины. По умолчанию false

305

306

==== minimap: false ====

==== ====

Отображать миникарту. По умолчанию true

311

312

==== minimapaspect: 0.5 ====

==== ====

Размер миникарты относительной полного размера карты, а не контейнера, в которой она находится. По умолчанию 0.2

317

318

==== forceseanceid: 42 ====

==== ====

Заставит виджет выбрать мероприятие арены по идентификатору платформы и не позволять вернуться к этапу выбора других мероприятий. Без указания идентификатора не учитывается.

323

324

==== forcesectorid: 42 ====

==== ====

Заставит виджет выбрать сектор мероприятия по id и не позволять вернуться к этапу выбора других секторов. Без указания идентификатора не учитывается.

329

330

==== requiredloyalty: true ====

==== ====

Включает обязательную регистриацию клиента в программе настроенной на объектке. По умолчанию false

335

336

==== personallessonsskillstariffs: [56 ====

==== , 57 ====

==== , … ] ====

==== ====

Производит фильтрацию тарифов для индивидуальных занятий. Принимает массив идентификаторов. По умолчанию []

345

346

==== multidayslessonsskillstariffs: [56 ====

==== , 57 ====

==== , … ] ====

==== ====

Производит фильтрацию тарифов для многодневных занятий. Принимает массив идентификаторов. Параметр дополняет фильтрацию по параметру grouplessonsskillstariffs. По умолчанию []

355

356

==== saletermstype: 'checkbox' ====

==== ====

Перед оплатой просит пользователя согласиться с правилами в форме галочки или всплывающего окна

361

362

* saletermstype: 'checkbox' потребует установку галочки для согласия.