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