Personaliza la experiencia del consumidor para los viajes on demand permitiendo que los consumidores sigan el viaje de un pedido, un viaje en auto o cualquier otro servicio que les proporciones.
¿Qué es el SDK de consumidor?
El SDK para consumidores forma parte de Fleet Engine para viajes on demand. Proporciona interfaces que modelan los datos de los viajes y los siguen en Fleet Engine, y proporciona clases que usas para crear una visualización enriquecida basada en mapas para compartir los recorridos con tus usuarios consumidores. Para crear esta experiencia del consumidor, debes integrar el SDK para consumidores en tu app y establecer los perfiles de rol adecuados en Fleet Engine.
Las APIs específicas de la plataforma del SDK de consumidor te permiten incorporar la capacidad de compartir viajes de forma nativa en tus aplicaciones. El SDK para consumidores está disponible para las siguientes plataformas:
¿Por qué usar el SDK de consumidor?
La integración del SDK de consumidor en tus aplicaciones de viajes on demand te permite proporcionar una experiencia del consumidor integral, con actualizaciones de ubicación casi en tiempo real y posiciones ajustadas a la ruta. Tus consumidores pueden ver la ruta del vehículo superpuesta en un mapa, incluidos los detalles del progreso que los ayudan a comprender dónde se encuentra su viaje o entrega.
¿Qué puedes hacer con el SDK de consumidor?
Puedes usar la información del SDK de Driver y de Fleet Engine para crear experiencias personalizadas para los consumidores, incluidas las siguientes funciones:
Personaliza la IU del mapa para que se adapte a tus necesidades de desarrollo de la marca.
Sigue la ubicación actual del vehículo mientras avanza por la ruta, con su posición actualizada periódicamente.
Muestra la hora estimada de llegada (ETA) para las ubicaciones de partida y destino.
Muestra la distancia restante.
Muestra el tráfico en tiempo real en la ruta.
Cómo funciona el SDK de consumidor
En términos generales, el SDK para consumidores se basa en los siguientes mecanismos:
- Tener los roles de Fleet Engine adecuados para que una app autenticada pueda seguir el viaje asociado con el pedido de un consumidor
- Es una asociación entre el consumidor y el viaje, que proporciona tu sistema de backend.
- Las clases del SDK de
TripModelyJourneySharingSessionque modelan los datos de viaje y comparten las sesiones de viaje en la aplicación para consumidores.
El SDK de consumidor también proporciona otras interfaces y clases para que puedas crear una experiencia enriquecida en la app con detalles como el tráfico, los marcadores de mapa, la hora de llegada estimada y los datos de la ruta.
En esta tabla, se muestra el flujo de un viaje seguido por una app para consumidores.
| 1 | La aplicación para consumidores solicita un viaje | Tu servidor de backend recibe una solicitud de viaje on demand y hace lo siguiente:
|
| 2 | El conductor acepta el viaje | La app para conductores obtiene el ID y la información del viaje, y el conductor lo acepta. |
| 3 | La aplicación para consumidores solicita acceso para seguir el viaje | La aplicación para consumidores obtiene el ID del viaje de tu backend y solicita comenzar a seguir el viaje. |
| 4 | El conductor inicia el viaje | Cuando el conductor usa la app de conductor para indicar que comenzó el viaje, la app notifica a tu servidor de backend a través del SDK de Driver. Por ejemplo, cuando el conductor está por salir del restaurante o conducir hasta la ubicación de retiro. |
| 5 | Fleet Engine comienza a enviar información del viaje | Fleet Engine comienza a hacer un seguimiento del viaje y a compartir su progreso con la aplicación para consumidores. |
| 6 | La aplicación para consumidores muestra la información del viaje | La aplicación para consumidores notifica al consumidor y comienza a mostrarle la información del viaje, que se actualiza a medida que avanza. |
| 7 | El viaje se cancela o se completa | Cuando el conductor cancela o completa el viaje, la app del conductor inhabilita el seguimiento de ubicación, y tu servidor de backend le indica a Fleet Engine que marque el viaje como cancelado o completado. |
| 8 | La app para consumidores deja de seguir el viaje | El viaje se muestra como cancelado o completado. |
| 9 | El proceso se repite para el siguiente viaje | Se crea un viaje nuevo y se repite el proceso. |
Cómo usar el SDK de consumidor
Selecciona tu plataforma para ver cómo comenzar a seguir viajes en tus aplicaciones para consumidores.
Android
| 1 | Configura el SDK de consumidor en Android | Para seguir los viajes on demand en tu app, configura el SDK de consumidor. Para obtener más información, consulta Obtén el SDK de consumidor para Android. |
| 2 | Configura la interfaz visual | Define un mapa y agrega compatibilidad con mapas de vectores para configurar la experiencia del consumidor. Para obtener más información, consulta Cómo configurar un mapa. |
| 3 | Sigue un viaje | Sigue un viaje para compartir la ubicación del vehículo correspondiente con tu consumidor. Para obtener más información, consulta Sigue un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores de viaje | Actualiza los detalles de tus viajes, como la distancia y la hora estimada de llegada, y controla los errores que se produzcan durante un viaje. Para obtener más información, consulta Actualiza el progreso del viaje y Controla los errores del viaje. |
| 5 | Cómo dejar de seguir un viaje cuando se completa | Deja de seguir un viaje para dejar de compartir la ubicación de un vehículo con tu consumidor. Para obtener más información, consulta Cómo dejar de seguir un viaje. |
iOS
| 1 | Configura el SDK de consumidor en iOS | Para seguir los viajes on demand en tu app, configura el SDK de consumidor. Para obtener más información, consulta Obtén el SDK de consumidor para iOS. |
| 2 | Configura la interfaz visual | Inicializa la vista de mapa y controla los eventos de mapa para configurar la experiencia del consumidor. Para obtener más información, consulta Cómo configurar un mapa. |
| 3 | Sigue un viaje | Sigue un viaje para compartir la ubicación del vehículo correspondiente con tu consumidor. Para obtener más información, consulta Sigue un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores de viaje | Actualiza los detalles de tus viajes, como la distancia y la hora estimada de llegada, y controla los errores que se produzcan durante un viaje. Para obtener más información, consulta Actualiza el progreso del viaje y Controla los errores del viaje. |
| 5 | Cómo dejar de seguir un viaje cuando se completa | Deja de seguir un viaje para dejar de compartir la ubicación de un vehículo con tu consumidor. Para obtener más información, consulta Cómo dejar de seguir un viaje. |
JavaScript
| 1 | Configura el SDK de consumidor en JavaScript | Para seguir los viajes on demand en tu app, configura el SDK de consumidor. Para obtener más información, consulta Configura el SDK de consumidor para JavaScript. |
| 2 | Cómo cargar y personalizar un mapa | Habilita la API de Maps JavaScript y configura la autorización para configurar la experiencia del consumidor. Para obtener más información, consulta Cómo configurar un mapa. |
| 3 | Sigue un viaje | Sigue un viaje para compartir la ubicación del vehículo correspondiente con tu consumidor. Para obtener más información, consulta Sigue un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores de viaje | Actualiza los detalles de tus viajes, como la distancia y la hora estimada de llegada, y controla los errores que se produzcan durante un viaje. Para obtener más información, consulta Cómo actualizar y seguir el progreso de un viaje y Cómo controlar los errores de viaje. |
| 5 | Cómo dejar de seguir un viaje cuando se completa | Deja de seguir un viaje para dejar de compartir la ubicación de un vehículo con tu consumidor. Para obtener más información, consulta Cómo dejar de seguir un viaje. |
Componentes
En esta sección, se resumen dos componentes necesarios para seguir un viaje:
De manera opcional, también puedes personalizar la experiencia del consumidor con estos componentes:
Recuperador de tokens de autenticación
Para controlar el acceso a los datos de ubicación almacenados en Fleet Engine, debes hacer lo siguiente:
Implementa un servicio de creación de tokens web JSON (JWT) para Fleet Engine en tu servidor. Para obtener más información, consulta Emite JWT.
Implementa un recuperador de tokens de autenticación en tus apps web o para dispositivos móviles para autenticar el acceso a los datos de ubicación. Para obtener más información sobre cómo configurar un recuperador de tokens, consulta la guía de configuración para Android, iOS o JavaScript.
Vista de mapa y seguimiento de viajes
El seguimiento de un viaje incluye componentes para la visualización de vehículos y puntos de referencia, así como feeds de datos sin procesar para la hora estimada de llegada de un conductor o la distancia restante que debe recorrer.
En la siguiente tabla, se describen estos componentes:
| Componente | Descripción |
|---|---|
| Vista de mapa para consumidores | La vista de mapa administra el ciclo de vida de un viaje y muestra puntos de referencia para la ubicación de los vehículos a medida que avanza el viaje. Si se conoce la ruta de un vehículo, la vista de mapa actualiza la polilínea de la ruta del vehículo para indicar el progreso del vehículo a lo largo de su ruta. |
| Proveedor de ubicación de viajes en JavaScript | En el caso de las apps web de JavaScript, el proveedor de ubicación del viaje proporciona información de ubicación de los objetos de los que se hace un seguimiento en el mapa de viajes compartido. Para obtener más información, consulta Crea una instancia de un proveedor de ubicación de viajes.
Puedes usar el proveedor de ubicación del viaje para hacer un seguimiento de los siguientes detalles de un viaje:
|
Objetos de ubicación con seguimiento
El proveedor de ubicación hace un seguimiento de la ubicación de objetos, como puntos de referencia y vehículos, que se describen en la siguiente tabla.
| Ubicación con seguimiento | Descripción |
|---|---|
| Lugar de recogida | La ubicación de partida es el lugar donde comienza un viaje. |
| Ubicación de destino | La ubicación de destino es el lugar donde finaliza un viaje. Marca la ubicación de destino. |
| Ubicación del punto de referencia | Una ubicación de punto de referencia es cualquier ubicación intermedia a lo largo de la ruta de un viaje con seguimiento. Si bien, técnicamente, los puntos de referencia pueden incluir ubicaciones de partida y llegada, suelen referirse a paradas intermedias en la ruta. Por ejemplo, las paradas entre las ubicaciones de retiro y destino en una ruta de entrega son ubicaciones de puntos de referencia. Para obtener más información, consulta Puntos de referencia del viaje en la documentación de Fleet Engine. |
| Ubicación del vehículo | La ubicación del vehículo es la ubicación informada de un vehículo. Para obtener más información, consulta Ubicación del vehículo en la documentación de Fleet Engine. |
Aplica estilos a tus mapas
Los estilos de marcadores y polilíneas determinan el aspecto de los objetos de ubicación con seguimiento en el mapa. Puedes usar opciones de estilo personalizado para que coincidan con el estilo de tu aplicación web.
Controlar la visibilidad de las ubicaciones que sigues
Los proveedores de ubicación predefinidos en Fleet Engine siguen estas reglas de visibilidad para los objetos de ubicación con seguimiento en el mapa. Si creas un proveedor de ubicación personalizado o derivado, puedes cambiar las reglas de visibilidad.
Los vehículos solo son visibles cuando el viaje está en curso: Un vehículo de viaje es visible desde el momento en que se asigna a un viaje hasta el momento de la llegada. Si se cancela el viaje, el vehículo ya no es visible.
Todos los demás marcadores de ubicación siempre están visibles: Todos los demás marcadores de ubicación para el origen, el destino y los puntos de referencia siempre se muestran en el mapa. Por ejemplo, la ubicación de llegada de un viaje o la ubicación de entrega de un envío siempre se muestran en el mapa, independientemente del estado del viaje o de la entrega.
¿Qué sigue?
Consulta la documentación de la plataforma en la que deseas seguir los viajes: