Документация по установке ВИДЖЕТА, тонкости настройки

Виджет для продажи билетов - специальный веб-интерфейс, который позволяет пользователям на любом сайте приобретать билеты в кинотеатры сети Киномакс.

Настоящая документация содержит описание процесса установки и использования виджета.

Установка ВИДЖЕТА
Виджет написан как плагин KMWidget для JS-фреймворка JQuery, поэтому наличие последнего является обязательным.

В случае, если на вашем сайте уже используется другой JS-фреймворк, возможна ситуация, при которой фреймворки будут конфликтовать (т.к. зачастую используется $ в качестве названия объекта). У JQuery есть метод защиты от таких конфликтов. За дополнительной информацией обратитесь к официальной документации: http://api.jquery.com/jquery.noconflict/

Для установки виджета:

Получите уникальный числовой идентификатор партнёра (обратитесь к администратору сайта по адресу webmaster@kinomax.ru).
Подключите фреймворк JQuery к тем страницам вашего сайта, где будет использоваться виджет. Библиотеку можно как скачать с официального сайта и залить себе на сайт, так и просто использовать её с любого публичного CDN, например, от Google:

< script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"> < /script>.

Подключать все скрипты рекомендуется в конце страницы, перед закрывающим тегом < /body>.
После JQuery подключите плагин для работы виджета:

< script id=km_widget_script type=text/javascript language=JavaScript src=http://widget.kinomax.ru/js/libs/widget.jquery-1.0.js?partner=1234567> < /script>.
Задайте на странице класс 'km_widget' тем элементам, при клике на которые должен вызываться виджет:

< button id=button class="km_widget"> Виджет < /button>

Настройка ВИДЖЕТА
Для настройки виджета доступны несколько параметров:

partner - уникальный числовой идентификатор партнера, обязательный параметр (запросите ВАШ уникальный идентификатор у webmaster@kinomax.ru).
wclass - название класса, по которому ведется поиск элементов, которые будут являться точкой входа в виджет. По умолчанию это km_widget.
noselect - параметр используется для более тонкой настройки возможностей виджета. Если вы хотите, например, чтобы у клиента не было возможности смены кинотеатра или города, то нужно указать noselect=true. По умолчанию, равен false.

Провести настройку виджета можно двумя способами:

Передача настроек в URL
Настройки, перечисленные выше, можно просто передать в URL обращения к скрипту. В разделе "установка виджета" на третьем шаге передается параметр partner. Точно также, можно добавить и остальные параметры. Например:

< script id=km_widget_script type=text/javascript language=JavaScript src=http://widget.kinomax.ru/js/libs/widget.jquery-1.0.js?partner=1234567&noselect=true&wclass=widget> < /script>.

Смена настроек методом config
Настройки виджета можно сменить уже после его загрузки. Для этого используется метод config:

$.fn.KMWidget('config', {'partner':1234567, 'noselect':true, 'wclass':'widget'});

При использовании такого метода настройки нужно прописать его вызов на событие загрузки страницы.

Изменение точки входа
Пользователь имеет возможность начать работать с виджетом с нескольких экранов:

экран выбора кинотеатра;
экран с расписанием;
экран со схемой зала.

Для определения точки входа элемент с классом km_widget должен дополнительно иметь аттрибут data-kmwidget, который используется для задания параметров.

-- Экран выбора кинотеатра --
< button id=button class=km_widget data-kmwidget='{"cityID":"1"}'> Москва < /button>

-- Экран расписания кинотеатра --
< button id=button2 class=km_widget data-kmwidget='{"cinemaID":"2"}'> Киномакс-XL < /button>

-- Экран со схемой зала (если есть идентификаторы сеансов) --
< button id=button3 class=km_widget data-kmwidget='{"sessionID":"468860"}'> Годзилла, 21 мая, 17:00 < /button>

-- Экран со схемой зала (если известно только время) --
< button id=button4 class=km_widget data-kmwidget='{"sessionID":"2-20140521-1700"}'> Годзилла, 21 мая, 17:00 < /button>

В последнем примере в атрибуте data-kmwidget передается указание времени сеанса вместо указания его идентификатора. При этом используется следующий формат:
cinemaID-sessionDate-sessionTime, где

cinemaID - числовой идентификатор кинотеатра;
sessionDate - дата сеанса в формате ГГГГММДД;
sessionTime - время сеанса в формате ЧЧММ.

Числовые идентификаторы кинотеатров перечислены ниже:
2 - Киномакс-XL, Москва
4 - Киномакс-Буревестник, Владимир
5 - Киномакс-Солярис, Москва
6 - Киномакс-Урал, Челябинск
8 - Киномакс-Волгоград
10 - Киномакс 3D-Мегаполис, Екатеринбург
11 - Киномакс-Тандем, Казань
13 - Киномакс-Пермь,
14 - Киномакс-Дон, Ростов-на-Дону
20 - Киномакс-Томск
23 - Киномакс-Фестиваль, Парк Тамбов
24 - Киномакс-Планета, Красноярск
25 - Киномакс-Краснодар
26 - Киномакс-Альтаир, Ярославль
27 - Киномакс-Ижевск
28 - Киномакс-Киров
29 - Киномакс-Club, Казань
30 - Киномакс-Родник, Челябинск
31 - Киномакс IMAX, Астрахань
32 - Киномакс IMAX, Рязань
33 - Киномакс-Волжский
34 - Киномакс-Уфа
35 - Киномакс-Тюмень
37 - Киномакс-Акварель, Тамбов
38 - Киномакс-Аура, Ярославль
40 - Киномакс-Плаза, Ростов-на-Дону
41 - Киномакс-Самара
42 - Киномакс-Водный, Москва
43 - Киномакс-Пражская, Москва
44 - Киномакс-Кожуховская, Москва

Настройка смены кинотеатра/города
Параметр noselect позволяет заблокировать возможность смены кинотеатра или города.

Если вы передали параметр noselect, то виджет не даст пользователю подняться выше той точки входа, которая определена вами.

Например, если вы указываете noselect=true и пользователь при клике попадает на экран кинотеатра, то у него не будет возможности выбрать другой кинотеатр. То же самое и с городом - noselect=true и выбран город, то пользователь не будет иметь возможности его сменить.

По вопросам установки и работы ВИДЖЕТА/API "КИНОМАКС": webmaster@kinomax.ru

Политика конфиденциальности