РЕАЛИЗАЦИЯ API ДЛЯ РАЗНЫХ ТИПОВ ИНТЕРФЕЙСОВ
РЕАЛИЗАЦИЯ API ДЛЯ РАЗНЫХ ТИПОВ ИНТЕРФЕЙСОВ
ВЫБОР ТИПА ИНТЕРФЕЙСА
ИНТЕРФЕЙС «БИЛЕТНАЯ СИСТЕМА»
ИНТЕРФЕЙС «БРАУЗЕР»
ДОСТАВКА БИЛЕТОВ
API BIL24 применяется пользователями платформы с ролью Агент, со следующими типами интерфейсов : «Билетная система», «Браузер», «Android»
и «IOS» . При реализации API, Агенту необходимо учитывать важные различия между интерфейсом «Билетная система» с одной стороны, и
интерфейсами «Браузер», «Android» и «IOS» с другой. Эти различия связаны с использованием интернет-эквайринга, авторизацией пользователя
и доставкой электронных билетов покупателям.
Интерфейсы «Браузер», «Android» и «IOS» , с точки зрения использования команд API – идентичны, поэтому рассмотрим различные варианты реализации
API для двух типов интерфейсов: «Билетная система» и «Браузер».
Если агент использует собственную полнофункциональную билетную систему, то для реализации API BIL24 необходимо выбрать интерфейс
«Билетная система». Под полнофункциональностью системы агента в данном случае понимается:
- способность регистрировать покупателей билетов и предоставлять им доступ в личный кабинет,
- использование собственного интернет-эквайринга внутри системы,
- самостоятельная доставка билетов покупателю, например, через email.
В данном случае, покупателей полностью обслуживает система Агента, а BIL24 служит только источником билетов.
Если агент использует платформу BIL24 в качестве своей билетной системы, то необходимо выбрать интерфейс «Браузер».
В этом случае покупатели билетов будут использовать существующий в BIL24 интернет-эквайринг агента, получат доступ в личный кабинет
платформы. Доставка электронных билетов покупателю также будет выполнена средствами BIL24.
В любом из вариантов стоит учитывать, что API BIL24 представляет собой конструктор, который позволяет организовать взаимодействие с платформой
различными способами.
Базовый план использования команд API для покупки билетов через интерфейс типа «Билетная система»:
1. Команда CREATE_USER и сохранение в системе Агента параметров userId и sessionId. Эти параметры могут понадобиться в дальнейшем для
доступа к билетам пользователя, например, при отображении билетов в личном кабинете в системе агента. Во многих билетных системах
учет пользователей, работа с их заказами и билетами организована собственными средствами и никак не связана с BIL24. В этом случае,
можно использовать ограниченный пул пользователей, созданных CREATE_USER, для «непересекающегося» обслуживания покупателей в режиме
реального времени. Под «непересечением» понимается отсутствие смешивания билетов разных покупателей в одном заказе, c одним userID.
2. Команда RESERVATION для бронирования мест.
3. Команда CREATE_ORDER_EXT для создания заказа с билетами. В этой команде можно передать необязательный параметр email – почтовый адрес
покупателя билетов. BIL24 не будет отправлять билеты на этот адрес.
4. Команда PAY_ORDER для информирования BIL24 о том, что заказ оплачен внутри билетной системы Агента.
Базовый план использования команд API для покупки билетов через интерфейс типа «БРАУЗЕР»:
1. Команда AUTH – команда для авторизации пользователя (покупателя билетов). Данные для команды необходимо брать из локального хранилища
браузера или мобильного приложения, если ранее уже выполнялся данный запрос. Если запрос выполняется первый раз, то userId и sessionId
в запросе не передавать.
2. Привязка почты покупателя:
2.1. Команда BIND_EMAIL. На указанную почту придет код подтверждения.
2.2. Команда CONFIRM_EMAIL с кодом, пришедшим на почту. В ответе придут данные аккаунта (userId, sessionId), к которым успешно прикреплена
почта. С этими данными необходимо выполнять последующие запросы.
3. Команда RESERVATION для бронирования мест.
4. Команда CREATE_ORDER для создания заказа с билетами. В ответе команды будет параметр formUrl - ссылка для оплаты.
Необходимо направить покупателя по этой ссылке на страницу инетрнет-эквайринга банка, где он сможет ввести данные своей карты и оплатить
заказ. В параметрах команды присутствуют две ссылки для редиректа покупателя после попытки оплаты заказа: successUrl - после успешной
оплаты, failUrl – после НЕуспешной оплаты.
В настоящий момент платформа BIL24 доставляет билеты по email, в разработке сервис доставки через Watsapp, Telegram, Viber. Адреса email хранятся в платформе в двух объектах:
Пользователь и Заказ. В объекте Пользователь хранится подтвержденный email пользователя. Этот email используется при оформлении заказа с билетами, и сохраняется в объекте Заказ.
В отличие от Email в объекте Пользователь , адрес email в Заказе может быть изменен, например, при пересылке заказа на другой email в приложении Отчеты (Reporter).
При использовании интерфейса «Браузер», приобретенные пользователем билеты автоматически отправляются на его email. При применении интерфейса «Билетная система»,
билеты НЕ отправляются на адрес пользователя, даже если он указан в поле email команды CREATE_ORDER_EXT. Тем не менее, у Агента, использующего интерфейс этого типа, есть возможности получить билеты с помощью следующих команд:
SEND TICKETS_TO_EMAIL
PRINT_TICKETS