Adapta la experiencia del consumidor para los viajes a pedido permitiéndoles hacer un seguimiento del viaje de un pedido, un viaje o cualquier otro servicio que les proporciones.
¿Qué es el SDK para el consumidor?
El SDK para el consumidor es parte de Fleet Engine para viajes a pedido. Proporciona interfaces que modelan los datos de viaje y hacen un seguimiento de los viajes en Fleet Engine, y proporciona clases que usas para crear una visualización enriquecida basada en mapas para compartir recorridos con tus usuarios consumidores. Integra el SDK para el consumidor en tu app y establece los perfiles de roles adecuados en Fleet Engine para crear esta experiencia del consumidor.
Las APIs específicas de la plataforma del SDK para el consumidor te permiten incorporar la capacidad de compartir viajes de forma nativa en tus aplicaciones. El SDK para el consumidor está disponible para las siguientes plataformas:
¿Por qué usar el SDK para el consumidor?
Si integras el SDK para el consumidor en tus aplicaciones de viajes a pedido, puedes proporcionar una experiencia integral para el consumidor, 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 está su viaje o entrega.
¿Qué puedes hacer con el SDK para el consumidor?
Puedes usar la información del SDK para conductores y Fleet Engine para crear experiencias personalizadas para el consumidor, incluidas las siguientes funciones:
Personaliza la IU del mapa para que se adapte a tus necesidades de branding.
Haz un seguimiento de la ubicación actual del vehículo a medida que avanza por la ruta, con su posición actualizada periódicamente.
Muestra la hora estimada de llegada (ETA) para las ubicaciones de partida y llegada.
Muestra la distancia restante.
Muestra el tráfico en vivo en la ruta.
Cómo funciona el SDK para el consumidor
En un nivel superior, el SDK para el consumidor se basa en los siguientes mecanismos:
- Tener los roles adecuados de Fleet Engine para que una app autenticada pueda hacer un seguimiento del viaje asociado con el pedido de un consumidor.
- Una asociación entre el consumidor y el viaje, proporcionada por tu sistema de backend.
- Las clases
TripModelyJourneySharingSessiondel SDK que modelan los datos de viaje y comparten sesiones de viaje en la aplicación para consumidores.
El SDK para el 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 ETA y los datos de la ruta.
En esta tabla, se muestra el flujo de un viaje que sigue una aplicación para consumidores.
| 1 | La aplicación para consumidores solicita un viaje | Tu servidor de backend recibe una solicitud de viaje a pedido 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 acepta el viaje. |
| 3 | La aplicación para consumidores solicita acceso para hacer un seguimiento del viaje | La aplicación para consumidores obtiene el ID del viaje de tu backend y solicita comenzar a hacer un seguimiento del viaje. |
| 4 | El conductor inicia el viaje | Cuando el conductor usa la app para conductores para indicar que el viaje comenzó, la app notifica a tu servidor de backend a través del SDK para conductores. Por ejemplo, cuando el conductor está a punto de salir del restaurante o conducir hasta la ubicación de partida. |
| 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, y actualiza el viaje a medida que avanza. |
| 7 | Se cancela o completa el viaje | Cuando el conductor cancela o completa el viaje, la app para conductores inhabilita el seguimiento de la ubicación, y tu servidor de backend le indica a Fleet Engine que marque el viaje como cancelado o completado. |
| 8 | La aplicación para consumidores deja de hacer un seguimiento del 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 para el consumidor
Selecciona tu plataforma para ver cómo comenzar a hacer un seguimiento de los viajes en tus apps para el consumidor.
Android
| 1 | Configura el SDK para el consumidor en Android | Para hacer un seguimiento de los viajes a pedido en tu app, configura el SDK para el consumidor. Para obtener más información, consulta Obtén el SDK para el consumidor de Android. |
| 2 | Configura la interfaz visual | Define un mapa y agrega compatibilidad con mapas vectoriales para configurar tu experiencia del consumidor. Para obtener más información, consulta Configura un mapa. |
| 3 | Haz un seguimiento de un viaje | Haz un seguimiento de un viaje para compartir la ubicación del vehículo adecuado con tu consumidor. Para obtener más información, consulta Haz un seguimiento de un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores del viaje | Actualiza los detalles de tus viajes, como la distancia de viaje y la hora estimada de llegada, y controla los errores durante un viaje. Para obtener más información, consulta Actualiza el progreso del viaje y Controla los errores del viaje. |
| 5 | Cuando se complete un viaje, deja de hacer un seguimiento | Deja de hacer un seguimiento de un viaje para dejar de compartir la ubicación de un vehículo con tu consumidor. Para obtener más información, consulta Deja de hacer un seguimiento de un viaje. |
iOS
| 1 | Configura el SDK para el consumidor en iOS | Para hacer un seguimiento de los viajes a pedido en tu app, configura el SDK para el consumidor. Para obtener más información, consulta Obtén el SDK para el consumidor de iOS. |
| 2 | Configura la interfaz visual | Inicializa la vista del mapa y controla los eventos del mapa para configurar tu experiencia del consumidor. Para obtener más información, consulta Configura un mapa. |
| 3 | Haz un seguimiento de un viaje | Haz un seguimiento de un viaje para compartir la ubicación del vehículo adecuado con tu consumidor. Para obtener más información, consulta Haz un seguimiento de un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores del viaje | Actualiza los detalles de tus viajes, como la distancia de viaje y la hora estimada de llegada, y controla los errores durante un viaje. Para obtener más información, consulta Actualiza el progreso del viaje y Controla los errores del viaje. |
| 5 | Cuando se complete un viaje, deja de hacer un seguimiento | Deja de hacer un seguimiento de un viaje para dejar de compartir la ubicación de un vehículo con tu consumidor. Para obtener más información, consulta Deja de hacer un seguimiento de un viaje. |
JavaScript
| 1 | Configura el SDK para el consumidor en JavaScript | Para hacer un seguimiento de los viajes a pedido en tu app, configura el SDK para el consumidor. Para obtener más información, consulta Configura el SDK para el consumidor de JavaScript. |
| 2 | Carga y personaliza un mapa | Habilita la API de Maps JavaScript y configura la autorización para configurar tu experiencia del consumidor. Para obtener más información, consulta Configura un mapa. |
| 3 | Haz un seguimiento de un viaje | Haz un seguimiento de un viaje para compartir la ubicación del vehículo adecuado con tu consumidor. Para obtener más información, consulta Haz un seguimiento de un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores del viaje | Actualiza los detalles de tus viajes, como la distancia de viaje y la hora estimada de llegada, y controla los errores durante un viaje. Para obtener más información, consulta Actualiza y sigue el progreso del viaje y Controla los errores del viaje. |
| 5 | Cuando se complete un viaje, deja de hacer un seguimiento | Deja de hacer un seguimiento de un viaje para dejar de compartir la ubicación de un vehículo con tu consumidor. Para obtener más información, consulta Deja de hacer un seguimiento de un viaje. |
Componentes
En esta sección, se resumen dos componentes necesarios para hacer un seguimiento de un viaje:
De manera opcional, también puedes personalizar tu experiencia del consumidor con estos componentes:
Obtención 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 JWTs.
Implementa un buscador de tokens de autenticación en tus apps para la Web o para dispositivos móviles para autenticar el acceso a los datos de ubicación. Para obtener más información sobre la configuración de un buscador de tokens, consulta la guía de configuración para Android, iOS o JavaScript.
Vista del 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 ETA de un conductor o la distancia restante para conducir.
En la siguiente tabla, se describen estos componentes:
| Componente | Descripción |
|---|---|
| Vista de mapa del consumidor | La vista del mapa administra el ciclo de vida de un viaje y muestra los 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 del 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 | Para las apps web de JavaScript, el proveedor de ubicación de viajes alimenta la información de ubicación de los objetos rastreados 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 de viajes para hacer un seguimiento de los siguientes detalles de un viaje:
|
Objetos de ubicación rastreados
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 rastreada | Descripción |
|---|---|
| Lugar de recogida | El lugar de recogida es la ubicación donde comienza un viaje. |
| Ubicación de destino | La ubicación de destino es la ubicación donde termina un viaje. Marca el lugar de llegada. |
| 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 rastreado. Si bien, técnicamente, los puntos de referencia pueden incluir ubicaciones de partida y destino, por lo general, se refieren a paradas intermedias a lo largo de la ruta. Por ejemplo, las paradas entre las ubicaciones de partida y destino en una ruta de entrega son ubicaciones de puntos de referencia. Para obtener más información, consulta Puntos de referencia de viajes 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 rastreados en el mapa. Puedes usar opciones de diseño personalizadas para que coincidan con el estilo de tu aplicación web.
Controla 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 rastreados 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 son 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, una ubicación de llegada de un viaje o una ubicación de entrega de un envío siempre se muestra en el mapa, independientemente del estado del viaje o la entrega.
¿Qué sigue?
Consulta la documentación de la plataforma en la que deseas hacer un seguimiento de los viajes: