Personalize a experiência do consumidor para viagens sob demanda, permitindo que os clientes acompanhem a viagem de um pedido, corrida ou outro serviço que você oferece.
O que é o SDK do consumidor?
O SDK do consumidor faz parte do Fleet Engine para viagens sob demanda. Ele oferece interfaces que modelam dados de viagens e acompanham viagens no Fleet Engine, além de classes que você usa para criar uma exibição avançada baseada em mapas para compartilhar jornadas com seus usuários consumidores. Você integra o SDK do consumidor ao seu app e define os perfis de função adequados no Fleet Engine para criar essa experiência do consumidor.
As APIs específicas da plataforma do SDK do consumidor permitem criar a capacidade de compartilhar jornadas de forma nativa nos seus aplicativos. O SDK do consumidor está disponível para as seguintes plataformas:
Por que usar o SDK do consumidor?
A integração do SDK do consumidor aos seus aplicativos de viagens sob demanda permite oferecer uma experiência abrangente ao consumidor, com atualizações de localização quase em tempo real e posições ajustadas à via. Seus consumidores podem ver a rota do veículo sobreposta a um mapa, incluindo detalhes de progresso que ajudam a entender onde a viagem ou entrega está.
O que você pode fazer com o SDK do consumidor?
Você pode usar informações do SDK do motorista e do Fleet Engine para criar experiências personalizadas para o consumidor, incluindo os seguintes recursos:
Personalize a interface do mapa para atender às necessidades da sua marca.
Acompanhe a localização atual do veículo à medida que ele avança pela rota, com a posição atualizada periodicamente.
Mostre o horário previsto de chegada (HEC) para locais de retirada e desembarque.
Mostre a distância restante.
Mostre o trânsito em tempo real no trajeto.
Como o SDK do consumidor funciona
Em um nível alto, o SDK do consumidor depende dos seguintes mecanismos:
- Ter as funções adequadas do Fleet Engine para que um app autenticado possa acompanhar a viagem associada ao pedido de um consumidor.
- Uma associação entre o consumidor e a viagem, fornecida pelo sistema de back-end.
- As classes do SDK
TripModeleJourneySharingSessionque modelam dados de viagens e compartilham sessões de viagens no aplicativo para o consumidor.
O SDK do consumidor também oferece outras interfaces e classes para que você possa criar uma experiência de app avançada com detalhes como trânsito, marcadores de mapa, HEC e dados de trajeto.
Esta tabela mostra o fluxo de uma viagem acompanhada por um aplicativo para o consumidor.
| 1 | O aplicativo para o consumidor solicita uma viagem | O servidor de back-end recebe uma solicitação de viagem sob demanda e faz o
seguinte:
|
| 2 | O motorista aceita a viagem | O app do motorista recebe o ID e as informações da viagem, e o motorista aceita a viagem. |
| 3 | O aplicativo para o consumidor solicita acesso para acompanhar a viagem | O aplicativo para o consumidor recebe o ID da viagem do back-end e solicita o início do acompanhamento da viagem. |
| 4 | O motorista inicia a viagem | Quando o motorista usa o app para indicar que a viagem começou, o app notifica o servidor de back-end pelo SDK do motorista. Por exemplo, quando o motorista está prestes a sair do restaurante ou dirigir até o local de embarque. |
| 5 | O Fleet Engine começa a enviar informações da viagem | O Fleet Engine começa a rastrear a viagem e compartilhar o progresso dela com o aplicativo para o consumidor. |
| 6 | O aplicativo para o consumidor mostra as informações da viagem | O aplicativo para o consumidor notifica o consumidor e começa a mostrar as informações da viagem, atualizando-a à medida que ela avança. |
| 7 | A viagem é cancelada ou concluída | Quando o motorista cancela ou conclui a viagem, o app do motorista desativa o rastreamento de localização, e o servidor de back-end informa ao Fleet Engine para marcar a viagem como cancelada ou concluída. |
| 8 | O aplicativo para o consumidor para de acompanhar a viagem | A viagem é mostrada como cancelada ou concluída. |
| 9 | O processo se repete para a próxima viagem | Uma nova viagem é criada e o processo se repete. |
Como usar o SDK do consumidor
Selecione sua plataforma para saber como começar a acompanhar viagens nos apps do consumidor.
Android
| 1 | Configurar o SDK do consumidor no Android | Para acompanhar viagens sob demanda no seu app, configure o SDK do consumidor. Para mais informações, consulte Receber o SDK do consumidor do Android. |
| 2 | Configurar a interface visual | Defina um mapa e adicione suporte a mapas vetoriais para configurar a experiência do consumidor. Para mais informações, consulte Configurar um mapa. |
| 3 | Acompanhar uma viagem | Acompanhe uma viagem para compartilhar a localização do veículo adequado com o consumidor. Para mais informações, consulte Acompanhar uma viagem. |
| 5 | Atualizar o progresso da viagem e processar erros de viagem | Atualize detalhes sobre suas viagens, como distância percorrida e horário previsto de chegada, e processe erros durante uma viagem. Para mais informações, consulte Atualizar o progresso da viagem e Processar erros de viagem. |
| 5 | Quando uma viagem é concluída, pare de acompanhar | Pare de acompanhar uma viagem para interromper o compartilhamento da localização de um veículo com o consumidor. Para mais informações, consulte Parar de acompanhar uma viagem. |
iOS
| 1 | Configurar o SDK do consumidor no iOS | Para acompanhar viagens sob demanda no seu app, configure o SDK do consumidor. Para mais informações, consulte Receber o SDK do consumidor do iOS. |
| 2 | Configurar a interface visual | Inicialize a visualização do mapa e processe eventos do mapa para configurar a experiência do consumidor. Para mais informações, consulte Configurar um mapa. |
| 3 | Acompanhar uma viagem | Acompanhe uma viagem para compartilhar a localização do veículo adequado com o consumidor. Para mais informações, consulte Acompanhar uma viagem. |
| 5 | Atualizar o progresso da viagem e processar erros de viagem | Atualize detalhes sobre suas viagens, como distância percorrida e horário previsto de chegada, e processe erros durante uma viagem. Para mais informações, consulte Atualizar o progresso da viagem e Processar erros de viagem. |
| 5 | Quando uma viagem é concluída, pare de acompanhar | Pare de acompanhar uma viagem para interromper o compartilhamento da localização de um veículo com o consumidor. Para mais informações, consulte Parar de acompanhar uma viagem. |
JavaScript
| 1 | Configurar o SDK do consumidor no JavaScript | Para acompanhar viagens sob demanda no seu app, configure o SDK do consumidor. Para mais informações, consulte Configurar o SDK do consumidor do JavaScript. |
| 2 | Carregar e personalizar um mapa | Ative a API Maps JavaScript e configure a autorização para configurar a experiência do consumidor. Para mais informações, consulte Configurar um mapa. |
| 3 | Acompanhar uma viagem | Acompanhe uma viagem para compartilhar a localização do veículo adequado com o consumidor. Para mais informações, consulte Acompanhar uma viagem. |
| 5 | Atualizar o progresso da viagem e processar erros de viagem | Atualize detalhes sobre suas viagens, como distância percorrida e horário previsto de chegada, e processe erros em uma viagem. Para mais informações, consulte Atualizar e acompanhar o progresso da viagem e Processar erros de viagem. |
| 5 | Quando uma viagem é concluída, pare de acompanhar | Pare de acompanhar uma viagem para interromper o compartilhamento da localização de um veículo com o consumidor. Para mais informações, consulte Parar de acompanhar uma viagem. |
Componentes
Esta seção resume dois componentes necessários para acompanhar uma viagem:
Opcionalmente, você também pode personalizar a experiência do consumidor com estes componentes:
Buscador de token de autenticação
Para controlar o acesso aos dados de localização armazenados no Fleet Engine, faça o seguinte:
Implemente um serviço de criação de JSON Web Token (JWT) para o Fleet Engine no seu servidor. Para mais informações, consulte Emitir JWTs.
Implemente um coletor de token de autenticação nos seus apps da Web ou para dispositivos móveis para autenticar o acesso aos dados de local. Para mais informações sobre como configurar um buscador de token, consulte o guia de configuração para Android, iOS ou JavaScript.
Visualização do mapa e rastreadores de viagens
O acompanhamento de uma viagem inclui componentes para visualização de veículos e waypoints, bem como feeds de dados brutos para o HEC de um motorista ou a distância restante a ser percorrida.
A tabela a seguir descreve esses componentes:
| Componente | Descrição |
|---|---|
| Visualização do mapa do consumidor | A visualização do mapa gerencia o ciclo de vida de uma viagem, mostrando waypoints para a localização dos veículos à medida que a viagem avança. Se o trajeto de um veículo for conhecido, a visualização do mapa vai atualizar a polilinha do trajeto do veículo para indicar o progresso do veículo ao longo do trajeto. |
| Provedor de localização de viagens em JavaScript | Para apps da Web JavaScript, o provedor de localização de viagens alimenta informações de localização para objetos rastreados no mapa de viagens compartilhadas. Para mais
informações, consulte
Instanciar um provedor de localização de viagens.
Você pode usar o provedor de localização de viagens para rastrear os seguintes detalhes de uma viagem:
|
Objetos de localização rastreados
O provedor de localização rastreia a localização de objetos, como waypoints e veículos, descritos na tabela a seguir.
| Local rastreado | Descrição |
|---|---|
| Local de retirada | O local de retirada é o local onde uma viagem começa. |
| Local de destino | O local de destino é o local onde uma viagem termina. Ele marca o local de desembarque. |
| Local do waypoint | Um local de waypoint é qualquer local intermediário ao longo do trajeto de uma viagem rastreada. Embora, tecnicamente, os waypoints possam incluir locais de embarque e desembarque, eles normalmente se referem a paradas intermediárias ao longo do trajeto. Por exemplo, as paradas entre os locais de retirada e destino em um trajeto de entrega são locais de waypoint. Para mais informações, consulte Waypoints de viagens na documentação do Fleet Engine. |
| Localização do veículo | A localização do veículo é o local informado de um veículo. Para mais informações, consulte Localização do veículo na documentação do Fleet Engine. |
Personalizar seus mapas
Os estilos de marcador e polilinha determinam a aparência dos objetos de localização rastreados no mapa. Você pode usar opções de estilo personalizadas para corresponder ao estilo do seu aplicativo da Web.
Controlar a visibilidade dos locais rastreados
Os provedores de localização predefinidos no Fleet Engine seguem estas regras de visibilidade para objetos de localização rastreados no mapa. Se você criar um provedor de localização personalizado ou derivado, poderá mudar as regras de visibilidade.
Os veículos ficam visíveis apenas quando a viagem está em andamento: um veículo de viagem fica visível desde o momento em que é atribuído a uma viagem até o momento do desembarque. Se a viagem for cancelada, o veículo não ficará mais visível.
Todos os outros marcadores de localização estão sempre visíveis: todos os outros marcadores de localização para origem, destino e waypoints são sempre mostrados no mapa. Por exemplo, um local de desembarque de viagem ou um local de entrega de remessa é sempre mostrado no mapa, independentemente do estado da viagem ou entrega.
A seguir
Consulte a documentação da plataforma em que você quer acompanhar viagens: