Personalize a experiência do consumidor para viagens on demand, permitindo que ele acompanhe o trajeto de um pedido, uma 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 on demand. Ele fornece interfaces que modelam dados de viagem e seguem viagens no Fleet Engine, além de classes que você usa para criar uma exibição avançada baseada em mapa para compartilhar jornadas com seus usuários consumidores. Para criar essa experiência, integre o SDK do Consumidor ao seu app e defina os perfis de função adequados no Fleet Engine.
As APIs específicas da plataforma do SDK do Consumidor permitem que você crie 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 o trajeto do veículo sobreposto em um mapa, incluindo detalhes do progresso que os ajudam a entender onde está a viagem ou entrega.
O que você pode fazer com o SDK do Consumidor?
Você pode usar as informações do SDK do Driver 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.
Siga a localização atual do veículo enquanto ele se desloca pelo trajeto, com a posição atualizada periodicamente.
Mostre o horário previsto de chegada (HEC) para os locais de retirada e entrega.
Mostra a distância restante.
Mostre o trânsito em tempo real no trajeto.
Como o SDK do Consumidor funciona
Em geral, o SDK do Consumidor depende dos seguintes mecanismos:
- Ter os papéis adequados 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 seu sistema de back-end.
- As classes do SDK
TripModeleJourneySharingSessionque modelam dados de viagem e compartilham sessões de viagem no aplicativo para o consumidor.
O SDK do Consumidor também oferece outras interfaces e classes para que você possa criar uma experiência no app completa com detalhes como tráfego, marcadores do mapa, HEC e dados de rota.
Esta tabela mostra o fluxo de uma viagem seguida 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 seu 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 Driver. Por exemplo, quando o motorista está prestes a sair do restaurante ou dirigir até o local de retirada. |
| 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 exibir as informações da viagem, atualizando-as conforme o progresso. |
| 7 | A viagem foi cancelada ou concluída | Quando o motorista cancela ou conclui a viagem, o app desativa o rastreamento de local, 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 aparece como cancelada ou concluída. |
| 9 | O processo se repete na 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 seus aplicativos para o consumidor.
Android
| 1 | Configurar o SDK do Consumidor no Android | Para acompanhar viagens on demand no seu app, configure o SDK do Consumidor. Para mais informações, consulte Instalar o SDK do Consumidor para 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 | Siga uma viagem para compartilhar o local do veículo com o consumidor. Para mais informações, consulte Seguir uma viagem. |
| 5 | Atualizar o progresso da viagem e processar erros | Atualize detalhes das suas viagens, como distância e horário previsto de chegada, e lide com erros durante uma viagem. Para mais informações, consulte Atualizar o progresso da viagem e Tratar erros de viagem. |
| 5 | Quando uma viagem é concluída, parar de seguir | Pare de seguir uma viagem para interromper o compartilhamento da localização de um veículo com o consumidor. Para mais informações, consulte Parar de seguir uma viagem. |
iOS
| 1 | Configurar o SDK do Consumidor no iOS | Para acompanhar viagens on demand no seu app, configure o SDK do Consumidor. Para mais informações, consulte Instalar o SDK do Consumidor para iOS. |
| 2 | Configurar a interface visual | Inicialize a visualização do mapa e processe os eventos do mapa para configurar a experiência do consumidor. Para mais informações, consulte Configurar um mapa. |
| 3 | Acompanhar uma viagem | Siga uma viagem para compartilhar o local do veículo com o consumidor. Para mais informações, consulte Seguir uma viagem. |
| 5 | Atualizar o progresso da viagem e processar erros | Atualize detalhes das suas viagens, como distância e horário previsto de chegada, e lide com erros durante uma viagem. Para mais informações, consulte Atualizar o progresso da viagem e Tratar erros de viagem. |
| 5 | Quando uma viagem é concluída, parar de seguir | Pare de seguir uma viagem para interromper o compartilhamento da localização de um veículo com o consumidor. Para mais informações, consulte Parar de seguir uma viagem. |
JavaScript
| 1 | Configurar o SDK do Consumidor em JavaScript | Para acompanhar viagens on demand no seu app, configure o SDK do Consumidor. Para mais informações, consulte Configurar o SDK do Consumidor para JavaScript. |
| 2 | Carregar e personalizar um mapa | Ative a API Maps JavaScript e configure a autorização para definir sua experiência do consumidor. Para mais informações, consulte Configurar um mapa. |
| 3 | Acompanhar uma viagem | Siga uma viagem para compartilhar o local do veículo com o consumidor. Para mais informações, consulte Seguir uma viagem. |
| 5 | Atualizar o progresso da viagem e processar erros | Atualize detalhes das suas viagens, como distância e horário previsto de chegada, e resolva erros. Para mais informações, consulte Atualizar e acompanhar o progresso da viagem e Processar erros de viagem. |
| 5 | Quando uma viagem é concluída, parar de seguir | Pare de seguir uma viagem para interromper o compartilhamento da localização de um veículo com o consumidor. Para mais informações, consulte Parar de seguir uma viagem. |
Componentes
Esta seção resume dois componentes necessários para acompanhar uma viagem:
Se quiser, você também pode personalizar a experiência do consumidor com estes componentes:
Buscador de tokens de autenticação
Para controlar o acesso aos dados de local 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 buscador 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 tokens, consulte o guia de configuração para Android, iOS ou JavaScript.
Visualização de mapa e rastreadores de viagem
O acompanhamento de uma viagem inclui componentes para visualização de veículos e pontos de referência, além de 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 de 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 conforme a viagem avança. Se o trajeto de um veículo for conhecido, a visualização do mapa vai atualizar a polilinha do trajeto para indicar o progresso do veículo ao longo do percurso. |
| Provedor de localização de viagem em JavaScript | Para apps da Web em JavaScript, o provedor de localização de viagem alimenta as informações de localização dos objetos rastreados no mapa de viagem compartilhada. Para mais
informações, consulte
Instanciar um provedor de localização de viagem.
É possível usar o provedor de localização da viagem para acompanhar os seguintes detalhes de uma
viagem:
|
Objetos de local rastreados
O provedor de localização rastreia a localização de objetos, como pontos de referência e veículos, descritos na tabela a seguir.
| Local monitorado | Descrição |
|---|---|
| Local de retirada | O local de retirada é onde uma viagem começa. |
| Local de destino | O local de destino é 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 monitorada. Tecnicamente, os waypoints podem incluir locais de retirada e entrega, mas geralmente se referem a paradas intermediárias ao longo do trajeto. Por exemplo, as paradas entre os locais de retirada e destino em uma rota de entrega são locais de waypoints. Para mais informações, consulte Pontos de passagem da viagem 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 o estilo dos seus mapas
Os estilos de marcador e polilinha determinam a aparência dos objetos de local rastreados no mapa. Você pode usar opções de estilo personalizadas para combinar com o estilo do seu aplicativo da Web.
Controlar a visibilidade dos locais monitorados
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á alterar 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 local estão sempre visíveis: todos os outros marcadores de local para origem, destino e waypoints são sempre mostrados no mapa. Por exemplo, o local de desembarque de uma viagem ou de entrega de uma remessa é sempre mostrado no mapa, independentemente do estado da viagem ou da entrega.
A seguir
Consulte a documentação da plataforma em que você quer acompanhar as viagens: