Персонализируйте пользовательский опыт для поездок по запросу, позволяя клиентам отслеживать ход поездки при оформлении заказа, получении услуги или выполнении другого предоставляемого вами сервиса.
Что такое Consumer SDK?
Consumer SDK является частью Fleet Engine для организации поездок по запросу. Он предоставляет интерфейсы для моделирования данных о поездках и отслеживания маршрутов в Fleet Engine, а также классы, которые вы используете для создания информативного отображения маршрутов на основе карты для обмена информацией с вашими пользователями. Вы интегрируете Consumer SDK в свое приложение и устанавливаете соответствующие профили ролей в Fleet Engine для создания этого пользовательского интерфейса.
Платформоспецифичные API-интерфейсы Consumer SDK позволяют интегрировать возможность обмена сценариями взаимодействия непосредственно в ваши приложения. Consumer SDK доступен для следующих платформ:
Почему стоит использовать Consumer SDK?
Интеграция потребительского SDK в ваши приложения для заказа поездок позволяет обеспечить всесторонний пользовательский опыт с обновлениями местоположения практически в реальном времени и привязкой к дороге. Ваши клиенты смогут видеть маршрут транспортного средства, наложенный на карту, включая подробную информацию о ходе движения, что поможет им понять, где находится их поездка или доставка.
Что можно делать с помощью Consumer SDK?
Вы можете использовать информацию из Driver SDK и Fleet Engine для создания персонализированных пользовательских интерфейсов, включая следующие функции:
Настройте пользовательский интерфейс карты в соответствии с вашими фирменными предпочтениями.
Следите за текущим местоположением транспортного средства по мере его движения по маршруту, при этом его координаты периодически обновляются.
Укажите расчетное время прибытия (ETA) в пункты отправления и прибытия.
Покажите оставшееся расстояние.
Отображение текущей дорожной ситуации на маршруте.
Как работает потребительский SDK
В общих чертах, потребительский SDK опирается на следующие механизмы:
- Необходимо наличие соответствующих ролей в системе управления автопарком, чтобы авторизованное приложение могло отслеживать маршрут, связанный с заказом потребителя.
- Связь между потребителем и поездкой, обеспечиваемая вашей внутренней системой.
- Классы SDK
TripModelиJourneySharingSession, которые моделируют данные о поездках и позволяют обмениваться данными о поездках в пользовательском приложении.
Комплект разработчика для потребителей (Consumer SDK) также предоставляет другие интерфейсы и классы, позволяющие создать многофункциональное приложение с подробной информацией, такой как данные о дорожном движении, маркеры на карте, расчетное время прибытия и маршрут.
В этой таблице показана последовательность действий в поездке, выполняемой с помощью потребительского приложения.
| 1 | Пользовательское приложение запрашивает поездку | Ваш бэкэнд-сервер получает запрос на поездку по требованию и выполняет следующие действия:
|
| 2 | Водитель соглашается на поездку | Приложение для водителя получает идентификатор поездки и информацию о ней, после чего водитель принимает поездку. |
| 3 | Пользовательское приложение запрашивает доступ для отслеживания поездки. | Пользовательское приложение получает идентификатор поездки из вашей серверной части и запрашивает разрешение на отслеживание поездки. |
| 4 | Водитель начинает поездку | Когда водитель использует приложение для водителей, чтобы сообщить о начале поездки, приложение уведомляет ваш бэкэнд-сервер через SDK водителя. Например, когда водитель собирается покинуть ресторан или отправиться к месту посадки. |
| 5 | Fleet Engine начинает отправлять информацию о поездке. | Fleet Engine начинает отслеживать поездку и делиться информацией о ее ходе с пользовательским приложением. |
| 6 | В пользовательском приложении отображается информация о поездке. | Приложение для пользователей уведомляет пользователя и начинает отображать информацию о поездке, обновляя данные по мере ее выполнения. |
| 7 | Поездка отменена или завершена | Когда водитель отменяет или завершает поездку, приложение для водителя отключает отслеживание местоположения, и ваш сервер сообщает Fleet Engine о необходимости отметить поездку как отмененную или завершенную. |
| 8 | Пользовательское приложение перестает отслеживать поездку. | Поездка отображается как отмененная или завершенная. |
| 9 | Процесс повторяется и для следующей поездки. | Создается новая поездка, и процесс повторяется. |
Как использовать Consumer SDK
Выберите свою платформу, чтобы узнать, как начать отслеживать поездки в ваших потребительских приложениях.
Android
| 1 | Настройте Consumer SDK в Android. | Чтобы отслеживать поездки по запросу в вашем приложении, настройте Consumer SDK. Для получения дополнительной информации см. раздел «Получить Android Consumer SDK» . |
| 2 | Настройте визуальный интерфейс. | Создайте карту и добавьте поддержку векторных карт, чтобы настроить взаимодействие с пользователем. Для получения дополнительной информации см. раздел «Настройка карты» . |
| 3 | Следуйте за поездкой | Отслеживание поездки позволяет сообщить клиенту местоположение соответствующего транспортного средства. Для получения дополнительной информации см. раздел «Отслеживание поездки» . |
| 5 | Отслеживание хода поездки и обработка ошибок, возникших во время поездки. | Обновляйте информацию о своих поездках, такую как расстояние и предполагаемое время прибытия, и обрабатывайте любые ошибки во время поездки. Для получения дополнительной информации см. разделы «Обновление хода поездки» и «Обработка ошибок в поездке» . |
| 5 | По завершении поездки прекратите следовать указаниям. | Чтобы прекратить передачу данных о местоположении транспортного средства клиенту, перейдите по ссылке «Прекратить передачу данных о поездке». Для получения дополнительной информации см. раздел «Прекратить передачу данных о поездке» . |
iOS
| 1 | Настройте Consumer SDK в iOS. | Чтобы отслеживать поездки по запросу в вашем приложении, настройте Consumer SDK. Для получения дополнительной информации см. раздел «Получение iOS Consumer SDK» . |
| 2 | Настройте визуальный интерфейс. | Для настройки пользовательского интерфейса инициализируйте отображение карты и обрабатывайте события карты. Дополнительную информацию см. в разделе «Настройка карты» . |
| 3 | Следуйте за поездкой | Отслеживание поездки позволяет сообщить клиенту местоположение соответствующего транспортного средства. Для получения дополнительной информации см. раздел «Отслеживание поездки» . |
| 5 | Отслеживание хода поездки и обработка ошибок, возникших во время поездки. | Обновляйте информацию о своих поездках, такую как расстояние и предполагаемое время прибытия, и обрабатывайте любые ошибки во время поездки. Для получения дополнительной информации см. разделы «Обновление хода поездки» и «Обработка ошибок в поездке» . |
| 5 | По завершении поездки прекратите следовать указаниям. | Чтобы прекратить передачу данных о местоположении транспортного средства клиенту, перейдите по ссылке «Прекратить передачу данных о поездке». Для получения дополнительной информации см. раздел «Прекратить передачу данных о поездке» . |
JavaScript
| 1 | Настройте SDK потребителя на JavaScript. | Чтобы отслеживать поездки по запросу в вашем приложении, настройте SDK потребителя. Дополнительную информацию см. в разделе «Настройка JavaScript SDK потребителя» . |
| 2 | Загрузите и настройте карту | Включите JavaScript API для работы с картами и настройте авторизацию, чтобы создать пользовательский интерфейс. Дополнительную информацию см. в разделе «Настройка карты» . |
| 3 | Следуйте за поездкой | Отслеживание поездки позволяет сообщить клиенту местоположение соответствующего транспортного средства. Для получения дополнительной информации см. раздел «Отслеживание поездки» . |
| 5 | Отслеживание хода поездки и обработка ошибок, возникших во время поездки. | Обновляйте информацию о своих поездках, такую как расстояние и предполагаемое время прибытия, и обрабатывайте любые ошибки в поездке. Для получения дополнительной информации см. разделы «Обновление и отслеживание хода поездки» и «Обработка ошибок в поездке» . |
| 5 | По завершении поездки прекратите следовать указаниям. | Чтобы прекратить передачу данных о местоположении транспортного средства клиенту, перейдите по ссылке «Прекратить передачу данных о поездке». Для получения дополнительной информации см. раздел «Прекратить передачу данных о поездке» . |
Компоненты
В этом разделе кратко изложены два необходимых компонента для успешного завершения поездки:
При желании вы также можете настроить пользовательский интерфейс с помощью следующих компонентов:
средство получения токенов аутентификации
Для управления доступом к данным о местоположении, хранящимся в Fleet Engine, необходимо выполнить следующие действия:
Внедрите на своем сервере службу создания JSON Web Token (JWT) для Fleet Engine. Дополнительную информацию см. в разделе «Выполнение JWT-запросов» .
Внедрите в свои веб- или мобильные приложения механизм получения токенов аутентификации для проверки доступа к данным о местоположении. Более подробную информацию о настройке механизма получения токенов см. в руководстве по настройке для Android , iOS или JavaScript .
Просмотр карты и отслеживание поездок
Отслеживание поездки включает в себя компоненты для визуализации транспортных средств и путевых точек, а также потоки необработанных данных о расчетном времени прибытия водителя или оставшемся расстоянии до места назначения.
В следующей таблице описаны эти компоненты:
| Компонент | Описание |
|---|---|
| Карта потребителей | Карта управляет жизненным циклом поездки, отображая путевые точки для определения местоположения транспортных средств по мере продвижения по маршруту. Если маршрут транспортного средства известен, карта обновляет полилинию маршрута транспортного средства, указывая на его продвижение по маршруту. |
| Поставщик данных о местоположении поездки в JavaScript | В веб-приложениях на JavaScript поставщик местоположения поездки передает информацию о местоположении отслеживаемых объектов в общую карту поездки. Дополнительную информацию см. в разделе «Создание экземпляра поставщика местоположения поездки» . Вы можете использовать поставщик местоположения поездки для отслеживания следующих данных о поездке:
|
Отслеживаемые объекты местоположения
Поставщик данных о местоположении отслеживает местоположение таких объектов, как путевые точки и транспортные средства, как описано в следующей таблице.
| Отслеживаемое местоположение | Описание |
|---|---|
| Место получения | Место отправления — это место, откуда начинается поездка. |
| Место назначения | Пункт назначения — это место, где заканчивается поездка. Он обозначает место высадки. |
| Местоположение контрольной точки | Точка маршрута — это любая промежуточная точка вдоль отслеживаемого маршрута. Хотя технически точки маршрута могут включать места посадки и высадки, обычно под точками маршрута подразумеваются промежуточные остановки. Например, остановки между местами посадки и высадки на маршруте доставки являются точками маршрута. Для получения дополнительной информации см. раздел «Точки маршрута» в документации Fleet Engine. |
| местоположение транспортного средства | Местоположение транспортного средства — это указанное местоположение транспортного средства. Для получения дополнительной информации см. раздел «Местоположение транспортного средства» в документации Fleet Engine. |
Оформите свои карты
Стили маркеров и полилиний определяют внешний вид объектов, отслеживаемых по местоположению, на карте. Вы можете использовать пользовательские параметры стиля, чтобы он соответствовал стилю вашего веб-приложения.
Контроль видимости отслеживаемых местоположений
В Fleet Engine предопределенные поставщики местоположения следуют этим правилам видимости для отслеживаемых объектов местоположения на карте. Если вы создаете пользовательский или производный поставщик местоположения, вы можете изменить правила видимости.
Транспортные средства видны только во время выполнения поездки : транспортное средство видно с момента его назначения на поездку до момента высадки. Если поездка отменяется, транспортное средство больше не видно.
Все остальные маркеры местоположения всегда видны : все остальные маркеры местоположения для пункта отправления, пункта назначения и путевых точек всегда отображаются на карте. Например, место высадки пассажира или место доставки груза всегда отображается на карте независимо от состояния поездки или доставки.
Что дальше?
См. документацию по платформе, на которой вы хотите отслеживать поездки: