Personaliza la experiencia del consumidor para los viajes a pedido permitiéndole seguir el viaje de un pedido, un viaje o cualquier otro servicio que le proporciones.
¿Qué es el SDK de Consumer?
El SDK para el consumidor forma parte de Fleet Engine para viajes a pedido. Proporciona interfaces que modelan datos de viajes y hacen un seguimiento de los viajes en Fleet Engine, y también proporciona clases que usas para crear una pantalla enriquecida basada en mapas para compartir viajes con tus usuarios consumidores. Para crear esta experiencia del consumidor, debes integrar el SDK para el consumidor en tu app y establecer los perfiles de roles adecuados en Fleet Engine.
Las APIs específicas de la plataforma del SDK de Consumer te permiten incorporar de forma nativa la capacidad de compartir viajes en tus aplicaciones. El SDK para consumidores está disponible para las siguientes plataformas:
¿Por qué usar el SDK de Consumer?
Integrar el SDK de Consumer en tus aplicaciones de viajes a pedido te permite brindar una experiencia integral al consumidor, con actualizaciones de ubicación casi en tiempo real y posiciones ajustadas a la ruta. Tus clientes 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 Consumer?
Puedes usar la información del SDK del Driver y de Fleet Engine para crear experiencias personalizadas para el usuario, incluidas las siguientes funciones:
Personaliza la IU del mapa para que se ajuste a las necesidades de tu marca.
Sigue la ubicación actual del vehículo a medida que avanza por la ruta, con su posición actualizada periódicamente.
Mostrar la hora estimada de llegada (ETA) a las ubicaciones de partida y destino
Mostrar la distancia restante
Mostrar el tráfico en tiempo real en la ruta
Cómo funciona el SDK de Consumer
En un nivel general, el SDK de Consumer 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, proporcionada por tu sistema de backend.
- Las clases del SDK
TripModelyJourneySharingSessionque modelan los datos de viajes y comparten sesiones de viajes en la app para el consumidor.
El SDK de Consumer también proporciona otras interfaces y clases para que puedas crear una experiencia de app enriquecida 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 app para consumidores.
| 1 | La app para el consumidor 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 app para el consumidor solicita acceso para seguir el viaje | La app para el usuario 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 para conductores 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á a punto de 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 app para el consumidor. |
| 6 | La app para consumidores muestra la información del viaje | La app para el consumidor le notifica al usuario y comienza a mostrarle la información del viaje, y la actualiza a medida que avanza. |
| 7 | Se canceló o completó 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 app para el consumidor deja de hacer el seguimiento del viaje | El viaje se muestra como cancelado o completado. |
| 9 | El proceso se repite para el siguiente viaje | Se crea un nuevo viaje y se repite el proceso. |
Cómo usar el SDK de Consumer
Selecciona tu plataforma para ver cómo comenzar a seguir viajes en tus apps para consumidores.
Android
| 1 | Cómo configurar el SDK de Consumer en Android | Para seguir los viajes a pedido en tu app, configura el SDK del consumidor. Para obtener más información, consulta Cómo obtener el SDK de Android Consumer. |
| 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 | Cómo seguir un viaje | Sigue un viaje para compartir la ubicación del vehículo adecuado con tu consumidor. Para obtener más información, consulta Cómo seguir un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores | Actualizar los detalles de tus viajes, como la distancia de viaje y la hora de llegada estimada, y controlar cualquier error 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 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 Consumer en iOS | Para seguir los viajes a pedido en tu app, configura el SDK del consumidor. Para obtener más información, consulta Cómo obtener el SDK de iOS Consumer. |
| 2 | Configura la interfaz visual | Inicializa la vista del mapa y controla los eventos del mapa para configurar la experiencia del consumidor. Para obtener más información, consulta Cómo configurar un mapa. |
| 3 | Cómo seguir un viaje | Sigue un viaje para compartir la ubicación del vehículo adecuado con tu consumidor. Para obtener más información, consulta Cómo seguir un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores | Actualizar los detalles de tus viajes, como la distancia de viaje y la hora de llegada estimada, y controlar cualquier error 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 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 Consumer en JavaScript | Para seguir los viajes a pedido en tu app, configura el SDK del consumidor. Para obtener más información, consulta Configura el SDK de JavaScript Consumer. |
| 2 | Cómo cargar y personalizar 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 Cómo configurar un mapa. |
| 3 | Cómo seguir un viaje | Sigue un viaje para compartir la ubicación del vehículo adecuado con tu consumidor. Para obtener más información, consulta Cómo seguir un viaje. |
| 5 | Actualiza el progreso del viaje y controla los errores | Actualizar los detalles de tus viajes, como la distancia y la hora de llegada estimada, y controlar los errores que se produzcan 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 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 los siguientes 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 Cómo emitir JWTs.
Implementa un buscador de tokens de autenticación en tus aplicaciones web o para dispositivos móviles para autenticar el acceso a los datos de ubicación. Si quieres obtener más información para configurar un buscador de tokens, consulta la guía de configuración para Android, iOS o JavaScript.
Vista de mapa y rastreadores 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 por conducir.
En la siguiente tabla, se describen estos componentes:
| Componente | Descripción |
|---|---|
| Vista de mapa para el 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 | 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 rastreados al mapa del viaje compartido. Para obtener más información, consulta Cómo crear una instancia de un proveedor de ubicación de viaje.
Puedes usar el proveedor de ubicación del viaje para hacer un seguimiento de los siguientes detalles de un viaje:
|
Objetos de ubicación rastreada
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 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 rastreado. Si bien, técnicamente, los puntos de referencia pueden incluir ubicaciones de partida y llegada, suelen referirse 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 Paradas de 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 diseño a tus mapas
Los diseños 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 diseño de tu aplicación web.
Cómo 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 rastreados en el mapa. Si creas un proveedor de ubicación personalizado o derivado, puedes cambiar las reglas de visibilidad.
Los vehículos solo se ven cuando el viaje está en curso: Un vehículo de viaje se ve desde el momento en que se asigna a un viaje hasta el momento de la parada. Si se cancela el viaje, el vehículo ya no se ve.
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 destino 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 la entrega.
¿Qué sigue?
Consulta la documentación de la plataforma en la que deseas seguir viajes: