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