Адаптируйте потребительский опыт для поездок по запросу, предоставив потребителям возможность сопровождать их во время поездки, чтобы получить заказ, поездку или другую услугу, которую вы им предоставляете.
Что такое Consumer SDK?
Consumer SDK является частью Fleet Engine для поездок по требованию. Он предоставляет интерфейсы, которые моделируют данные о поездках и отслеживают поездки в Fleet Engine, а также предоставляет классы, которые вы используете для создания насыщенного отображения на основе карты, чтобы делиться поездками с вашими пользователями-потребителями. Вы интегрируете Consumer SDK в свое приложение и устанавливаете соответствующие профили ролей в Fleet Engine для создания этого потребительского опыта.
API-интерфейсы Consumer SDK, специфичные для платформы, позволяют вам встраивать возможность делиться путешествиями в ваши приложения. 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
Выберите свою платформу, чтобы узнать, как начать отслеживать поездки в ваших потребительских приложениях.
андроид
| 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 | Настройка Consumer SDK в JavaScript | Чтобы отслеживать поездки по требованию в вашем приложении, настройте Consumer SDK. Для получения дополнительной информации см. Настройка JavaScript Consumer SDK . |
| 2 | Загрузите и настройте карту | Включите Maps JavaScript API и настройте авторизацию для настройки вашего потребительского опыта. Для получения дополнительной информации см. Настройка карты . |
| 3 | Следуйте за поездкой | Следуйте за поездкой, чтобы поделиться местоположением соответствующего транспортного средства с вашим потребителем. Для получения дополнительной информации см. раздел Следуйте за поездкой . |
| 5 | Обновляйте ход поездки и обрабатывайте ошибки поездки | Обновляйте данные о своих поездках, такие как расстояние и предполагаемое время прибытия, и обрабатывайте любые ошибки в поездке. Для получения дополнительной информации см. Обновление и отслеживание хода поездки и Обработка ошибок поездки . |
| 5 | Когда поездка завершена, прекратите следовать | Остановите отслеживание поездки, чтобы прекратить делиться местоположением транспортного средства с вашим потребителем. Для получения дополнительной информации см. Остановите отслеживание поездки . |
Компоненты
В этом разделе обобщены два необходимых компонента для сопровождения поездки:
При желании вы также можете настроить свой потребительский опыт с помощью следующих компонентов:
Сборщик токенов аутентификации
Чтобы контролировать доступ к данным о местоположении, хранящимся в Fleet Engine, необходимо выполнить следующие действия:
Реализуйте службу создания JSON Web Token (JWT) для Fleet Engine на вашем сервере. Для получения дополнительной информации см. Issue JWTs .
Реализуйте сборщик токенов аутентификации в своих веб-приложениях или мобильных приложениях для аутентификации доступа к данным о местоположении. Для получения дополнительной информации о настройке сборщика токенов см. руководство по настройке для Android , iOS или JavaScript .
Просмотр карты и трекеры поездок
Отслеживание поездки включает в себя компоненты для визуализации транспортных средств и путевых точек, а также потоки необработанных данных о расчетном времени прибытия водителя или оставшемся расстоянии до места назначения.
В следующей таблице описаны эти компоненты:
| Компонент | Описание |
|---|---|
| Просмотр карты потребителей | Вид карты управляет жизненным циклом поездки, показывая путевые точки для местонахождения транспортных средств по мере продвижения поездки. Если маршрут для транспортного средства известен, вид карты обновляет полилинию маршрута транспортного средства, чтобы указать прогресс транспортного средства по его маршруту. |
| Поставщик местоположения поездки в JavaScript | Для веб-приложений JavaScript поставщик местоположения поездки передает информацию о местоположении отслеживаемых объектов в общую карту поездки. Для получения дополнительной информации см. Создание экземпляра поставщика местоположения поездки . Вы можете использовать поставщика местоположения поездки для отслеживания следующих данных о поездке:
|
Отслеживаемые объекты местоположения
Поставщик данных о местоположении отслеживает местоположение объектов, таких как путевые точки и транспортные средства, описанных в следующей таблице.
| Отслеживаемое местоположение | Описание |
|---|---|
| Место получения | Место отправления — это место, где начинается поездка. |
| Место назначения | Место назначения — это место, где заканчивается поездка. Оно обозначает место высадки. |
| Местоположение точки маршрута | Местоположение путевой точки — это любое промежуточное местоположение на маршруте отслеживаемой поездки. Хотя технически говоря, путевые точки могут включать места посадки и высадки, путевые точки обычно относятся к промежуточным остановкам на маршруте. Например, остановки между местами посадки и назначения на маршруте доставки являются местоположениями путевых точек. Для получения дополнительной информации см. раздел Путевые точки поездки в документации Fleet Engine. |
| Местоположение транспортного средства | Местоположение транспортного средства — это сообщенное местоположение транспортного средства. Для получения дополнительной информации см. Местоположение транспортного средства в документации Fleet Engine. |
Создавайте стили для своих карт
Стили маркеров и полилиний определяют внешний вид и ощущение отслеживаемых объектов местоположения на карте. Вы можете использовать пользовательские параметры стиля, чтобы соответствовать стилю вашего веб-приложения.
Контроль видимости отслеживаемых местоположений
Предопределенные поставщики местоположения в Fleet Engine следуют этим правилам видимости для отслеживаемых объектов местоположения на карте. Если вы создаете пользовательский или производный поставщик местоположения, вы можете изменить правила видимости.
Транспортные средства видны только во время поездки : транспортное средство поездки видно с момента его назначения на поездку до момента высадки. Если поездка отменена, транспортное средство дольше видимо.
Все остальные маркеры местоположения всегда видны : Все остальные маркеры местоположения для исходной точки, пункта назначения и промежуточных точек всегда отображаются на карте. Например, место высадки или место доставки груза всегда отображается на карте, независимо от состояния поездки или доставки.
Что дальше?
Ознакомьтесь с документацией платформы, на которой вы хотите следить за поездками:
,Адаптируйте потребительский опыт для поездок по запросу, предоставив потребителям возможность сопровождать их во время поездки, чтобы получить заказ, поездку или другую услугу, которую вы им предоставляете.
Что такое Consumer SDK?
Consumer SDK является частью Fleet Engine для поездок по требованию. Он предоставляет интерфейсы, которые моделируют данные о поездках и отслеживают поездки в Fleet Engine, а также предоставляет классы, которые вы используете для создания насыщенного отображения на основе карты, чтобы делиться поездками с вашими пользователями-потребителями. Вы интегрируете Consumer SDK в свое приложение и устанавливаете соответствующие профили ролей в Fleet Engine для создания этого потребительского опыта.
API-интерфейсы Consumer SDK, специфичные для платформы, позволяют вам встраивать возможность делиться путешествиями в ваши приложения. 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
Выберите свою платформу, чтобы узнать, как начать отслеживать поездки в ваших потребительских приложениях.
андроид
| 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 | Настройка Consumer SDK в JavaScript | Чтобы отслеживать поездки по требованию в вашем приложении, настройте Consumer SDK. Для получения дополнительной информации см. Настройка JavaScript Consumer SDK . |
| 2 | Загрузите и настройте карту | Включите Maps JavaScript API и настройте авторизацию для настройки вашего потребительского опыта. Для получения дополнительной информации см. Настройка карты . |
| 3 | Следуйте за поездкой | Следуйте за поездкой, чтобы поделиться местоположением соответствующего транспортного средства с вашим потребителем. Для получения дополнительной информации см. раздел Следуйте за поездкой . |
| 5 | Обновляйте ход поездки и обрабатывайте ошибки поездки | Обновляйте данные о своих поездках, такие как расстояние и предполагаемое время прибытия, и обрабатывайте любые ошибки в поездке. Для получения дополнительной информации см. Обновление и отслеживание хода поездки и Обработка ошибок поездки . |
| 5 | Когда поездка завершена, прекратите следовать | Остановите отслеживание поездки, чтобы прекратить делиться местоположением транспортного средства с вашим потребителем. Для получения дополнительной информации см. Остановите отслеживание поездки . |
Компоненты
В этом разделе обобщены два необходимых компонента для сопровождения поездки:
При желании вы также можете настроить свой потребительский опыт с помощью следующих компонентов:
Сборщик токенов аутентификации
Чтобы контролировать доступ к данным о местоположении, хранящимся в Fleet Engine, необходимо выполнить следующие действия:
Реализуйте службу создания JSON Web Token (JWT) для Fleet Engine на вашем сервере. Для получения дополнительной информации см. Issue JWTs .
Реализуйте сборщик токенов аутентификации в своих веб-приложениях или мобильных приложениях для аутентификации доступа к данным о местоположении. Для получения дополнительной информации о настройке сборщика токенов см. руководство по настройке для Android , iOS или JavaScript .
Просмотр карты и трекеры поездок
Отслеживание поездки включает в себя компоненты для визуализации транспортных средств и путевых точек, а также потоки необработанных данных о расчетном времени прибытия водителя или оставшемся расстоянии до места назначения.
В следующей таблице описаны эти компоненты:
| Компонент | Описание |
|---|---|
| Просмотр карты потребителей | Вид карты управляет жизненным циклом поездки, показывая путевые точки для местонахождения транспортных средств по мере продвижения поездки. Если маршрут для транспортного средства известен, вид карты обновляет полилинию маршрута транспортного средства, чтобы указать прогресс транспортного средства по его маршруту. |
| Поставщик местоположения поездки в JavaScript | Для веб-приложений JavaScript поставщик местоположения поездки передает информацию о местоположении отслеживаемых объектов в общую карту поездки. Для получения дополнительной информации см. Создание экземпляра поставщика местоположения поездки . Вы можете использовать поставщика местоположения поездки для отслеживания следующих данных о поездке:
|
Отслеживаемые объекты местоположения
Поставщик данных о местоположении отслеживает местоположение объектов, таких как путевые точки и транспортные средства, описанных в следующей таблице.
| Отслеживаемое местоположение | Описание |
|---|---|
| Место получения | Место отправления — это место, где начинается поездка. |
| Место назначения | Место назначения — это место, где заканчивается поездка. Оно обозначает место высадки. |
| Местоположение точки маршрута | Местоположение путевой точки — это любое промежуточное местоположение на маршруте отслеживаемой поездки. Хотя технически говоря, путевые точки могут включать места посадки и высадки, путевые точки обычно относятся к промежуточным остановкам на маршруте. Например, остановки между местами посадки и назначения на маршруте доставки являются местоположениями путевых точек. Для получения дополнительной информации см. раздел Путевые точки поездки в документации Fleet Engine. |
| Местоположение транспортного средства | Местоположение транспортного средства — это сообщенное местоположение транспортного средства. Для получения дополнительной информации см. Местоположение транспортного средства в документации Fleet Engine. |
Создавайте стили для своих карт
Стили маркеров и полилиний определяют внешний вид и ощущение отслеживаемых объектов местоположения на карте. Вы можете использовать пользовательские параметры стиля, чтобы соответствовать стилю вашего веб-приложения.
Контроль видимости отслеживаемых местоположений
Предопределенные поставщики местоположения в Fleet Engine следуют этим правилам видимости для отслеживаемых объектов местоположения на карте. Если вы создаете пользовательский или производный поставщик местоположения, вы можете изменить правила видимости.
Транспортные средства видны только во время поездки : транспортное средство поездки видно с момента его назначения на поездку до момента высадки. Если поездка отменена, транспортное средство дольше видимо.
Все остальные маркеры местоположения всегда видны : Все остальные маркеры местоположения для исходной точки, пункта назначения и промежуточных точек всегда отображаются на карте. Например, место высадки или место доставки груза всегда отображается на карте, независимо от состояния поездки или доставки.
Что дальше?
Ознакомьтесь с документацией платформы, на которой вы хотите следить за поездками: