axp-dev/cinemapark-api

PHP library for integration with information systems Cinema Park

Cinema Park API

PHP библиотека для интеграции с информационными системами Синема Парк., _(*1)

, _(*2)

Оглавление

1. Старт
   • Composer
   • Инициализация
2. Использование
   • Получение информации по кинотеатрам, фильмам и сеансам
     • Получение списка мультиплексов и городов
     • Получение списка фильмов
     • Привязка фильмов к мультиплексам
     • Получение расписания фильма
     • Получение расписания мультиплекса
     • Получение дополнительной информации по фильму
     • Получение списка залов по всем мультиплексам
     • Получение списка форматов показа фильмов
     • Комплексная выгрузка текущего расписания мультиплекса
   • Организация интернет-бронирования и продаж
     • Проверка возможности начать сессию выбора мест для бронирования или покупки мест
     • Инициализация сессии выбора мест для бронирования или покупки
     • Получение геометрической схемы зала
     • Получение состояния мест
     • Действие с местом в сессии выбора мест
     • Отмена или закрытие сессии выбора мест
     • Закрытие сессии выбора мест
     • Открытие сессии выбора мест после фиксации
     • Инициализация сессии оплаты
     • Фиксация факта оплаты заказа
     • Фиксация факта неудачи оплаты заказа
3. Вспомогательная информация
   • Код возрастных ограничений
   • Состояние сеанса
   • Режим открытия сессии выбора мест
   • Код доступности инициализации сессии
   • Возможность работы с сеансом
   • Статус сессии выбора мест
   • Состояние места
   • Идентификаторы платёжного агента
4. Автор
5. Лицензия

Старт

Установка через composer

$ composer require axp-dev/cinemapark-api

Инициализация

$CinemaPark = new AXP\CinemaPark\CinemaPark();

// Получаем информаицю по фильму "Гадкий я 3"
$film = $CinemaPark->getFilmInfo(3679);

Использование

Получение списка мультиплексов и городов

public function getMultiplexes() : array

Результат ответа

Получение списка фильмов

В список могут попадать фильмы, не значащиеся в расписании мультиплексов (к примеру, поставленные в прокат на будущее, но без конкретного расписания)., _(*3)

public function getFilms() : array

Результат ответа

Привязка фильмов к мультиплексам

В список могут попадать фильмы, не значащиеся в расписании мультиплексов (к примеру, поставленные в прокат на будущее, но без конкретного расписания)., _(*4)

public function getFilmsMultiplexes() : array

Результат ответа

Получение расписания фильма

Выводится всё известное расписание, в т.ч. и прошедшие сеансы., _(*5)

public function getRepertoir($id) : array

Параметры метода

Результат ответа

Получение расписания мультиплекса

public function getMultiplexRepertoir($id) : array

Параметры метода

Результат ответа

Получение дополнительной информации по фильму

public function getFilmInfo($id) : array

Параметры метода

Результат ответа

Получение списка залов по всем мультиплексам

public function getHalls() : array

Результат ответа

Получение списка форматов показа фильмов

public function getFormats() : array

Результат ответа

Комплексная выгрузка текущего расписания мультиплекса

public function getTimeTable($id) : array

Параметры метода

Результат ответа

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

public function checkBSession($multiplex_id, $repertoir_id, $mode) : array

Параметры метода

Результат ответа

Инициализация сессии выбора мест для бронирования или покупки

public function initBSession($multiplex_id, $repertoir_id, $mode) : array

Параметры метода

Результат ответа

Получение геометрической схемы зала

Схему зала можно кешировать, рассчитывая на то, что в данном конкретном сеансе она не изменится., _(*6)

public function seatsLayout($multiplex_id, $repertoir_id) : array

Параметры метода

Результат ответа

Получение состояния мест

public function seatStates($multiplex_id, $repertoir_id, $b_session_id, $timestamp_tz = 0) : array

Параметры метода

Результат ответа

Данные в b_session_data

Данные в seat_states

Действие с местом в сессии выбора мест

Выбор места или снятие выбора, _(*7)

public function seatAction($multiplex_id, $repertoir_id, $b_session_id, $action_type, $seat_id) : array

Параметры метода

Результат ответа

Отмена или закрытие сессии выбора мест

Используется, когда пользователь хочет отказаться от бронирования или покупки на стадии выбора мест, _(*8)

public function cancelBSession($multiplex_id, $repertoir_id, $b_session_id) : array

Параметры метода

Результат ответа

Закрытие сессии выбора мест

Фиксация выбора мест, _(*9)

public function commitBSession($multiplex_id, $repertoir_id, $b_session_id, $mode, $email, $phone, $provider_id) : array

Параметры метода

Результат ответа

Открытие сессии выбора мест после фиксации

Для брони – редактирование существующей брони, для продажи – возврат в режим выбора мест до осуществления оплаты Если существующая бронь была переведена в режим редактирования и после этого не произошло завершение сессии с фиксацией выбора мест через commitBSession(), то бронь будет отменена по тайм-ауту., _(*10)

public function editBooking($multiplex_id, $repertoir_id, $codeword) : array

Параметры метода

Результат ответа

Инициализация сессии оплаты

Вызывается перед направлением пользователя на страницу оплаты (после того, как был зафиксирован выбор мест, сформирована цена заказа и пользователь изъявил желание оплатить заказ), _(*11)

public function initSSession($multiplex_id, $order_id, $codeword, $provider_id) : array

Параметры метода

Результат ответа

Фиксация факта оплаты заказа

public function commitSSession($multiplex_id, $order_id, $provider_id, $amount, $dt_payment, $transaction_id, $payment_type, $payment_info, $security_key) : array

Параметры метода

Результат ответа

Фиксация факта неудачи оплаты заказа

public function registerPaymentFailure($multiplex_id, $order_id, $provider_id, $amount, $dt_payment, $transaction_id, $payment_type, $payment_info, $security_key) : array

Параметры метода

Параметры полностью идентичны используемым в commitSSession(). Подробнее, _(*12)

Результат ответа

Вспомогательная информация

Код возрастных ограничений

Состояние сеанса

Вопрос «показывать ли пользователю сеансы, где state != 1» остаётся на ваше усмотрение., _(*13)

Режим открытия сессии выбора мест

Код доступности инициализации сессии

Для IP, внесённых в «белый список», всегда должно возвращаться 1., _(*14)

Возможность работы с сеансом

Статус сессии выбора мест

Состояние места

Идентификаторы платёжного агента

Автор

Alexander Pushkarev, e-mail: axp-dev@yandex.com, _(*15)

Лицензия

Основой Cinema Park API являет открытый исходный код, в соответствии MIT license, _(*16)