Permitir que os consumidores acompanhem a viagem para fazer um pedido, uma viagem ou outro serviço que você oferece a eles para personalizar a experiência de viagens sob demanda.
O que é o SDK do consumidor?
O SDK do consumidor faz parte do Fleet Engine para viagens sob demanda. Ele fornece interfaces que modelam dados de viagens e seguem viagens no Motor de frota, além de classes que você usa para criar uma exibição rica baseada em mapas para compartilhar jornadas com seus usuários. Você integra o SDK do consumidor ao seu app e define os perfis de função apropriados no Fleet Engine para criar essa experiência do consumidor.
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 estas plataformas:
Por que usar o SDK do consumidor?
A integração do SDK do consumidor aos seus apps 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 aproximadas de vias. Seus consumidores podem ver o trajeto do veículo sobreposto em um mapa, incluindo detalhes do andamento que os ajudam a entender onde está o transporte ou a entrega.
O que você pode fazer com o SDK do consumidor?
É possível usar informações do SDK do Driver e do Fleet Engine para criar experiências personalizadas do consumidor, incluindo os seguintes recursos:
Personalize a interface do mapa para atender às suas necessidades de branding.
Siga a localização atual do veículo enquanto ele percorre o trajeto, com a posição atualizada periodicamente.
Mostre o horário previsto de chegada (HEC) para os locais de retirada e entrega.
Mostrar a distância restante.
Mostrar o trânsito em tempo real na rota.
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 seguir 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 viagem no app do consumidor.
O SDK para consumidor também fornece outras interfaces e classes para que você possa criar uma experiência avançada no app, com detalhes como trânsito, marcadores de mapa, HEC e dados de trajeto.
Esta tabela mostra o fluxo de uma viagem seguida por um app do consumidor.
| 1 | O app do 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 app do consumidor solicita acesso para acompanhar a viagem | O app do consumidor recebe o ID da viagem do back-end e solicita para começar a acompanhar a 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 retirada. |
| 5 | O Fleet Engine começa a enviar informações de viagens | O Fleet Engine começa a rastrear a viagem e compartilhar o progresso com o app do consumidor. |
| 6 | O app do consumidor mostra as informações da viagem | O app do consumidor notifica o consumidor e começa a mostrar as informações da viagem, atualizando-a à medida que ela avança. |
| 7 | A viagem foi cancelada ou concluída | Quando o motorista cancela ou conclui a viagem, o app do motorista 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 app do consumidor para de acompanhar a viagem | A viagem aparece 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 ver como começar a seguir viagens nos seus apps para o consumidor.
Android
| 1 | Configurar o SDK do consumidor no Android | Para acompanhar as viagens sob demanda no seu app, configure o SDK do consumidor. Para mais informações, consulte Instalar 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 | Seguir uma viagem | Acompanhe uma viagem para compartilhar o local do veículo apropriado com seu consumidor. Para mais informações, consulte Seguir uma viagem. |
| 5 | Atualizar o andamento da viagem e lidar com os erros | Atualize detalhes das viagens, como distância e horário estimado de chegada, e resolva erros durante uma viagem. Para mais informações, consulte Atualizar o andamento da viagem e Processar erros de viagem. |
| 5 | Quando uma viagem for concluída, pare de seguir | Parar de seguir uma viagem para parar de compartilhar a 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 as viagens sob demanda 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 | Inicializar a visualização do mapa e processar eventos para configurar a experiência do consumidor. Para mais informações, consulte Configurar um mapa. |
| 3 | Seguir uma viagem | Acompanhe uma viagem para compartilhar o local do veículo apropriado com seu consumidor. Para mais informações, consulte Seguir uma viagem. |
| 5 | Atualizar o andamento da viagem e lidar com os erros | Atualize detalhes das viagens, como distância e horário estimado de chegada, e resolva erros durante uma viagem. Para mais informações, consulte Atualizar o progresso da viagem e Lidar com erros de viagem. |
| 5 | Quando uma viagem for concluída, pare de seguir | Parar de seguir uma viagem para parar de compartilhar a 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 em JavaScript | Para acompanhar as viagens sob demanda no seu app, configure o SDK do consumidor. Para mais informações, consulte Configurar o SDK do consumidor JavaScript. |
| 2 | Carregar e personalizar um mapa | Ative a API Maps JavaScript e configure a autorização para definir a experiência do consumidor. Para mais informações, consulte Configurar um mapa. |
| 3 | Seguir uma viagem | Acompanhe uma viagem para compartilhar a localização do veículo adequado com o consumidor. Para mais informações, consulte Seguir uma viagem. |
| 5 | Atualizar o andamento da viagem e lidar com os erros | Atualize detalhes das viagens, como distância e horário estimado de chegada, e resolva erros. Para mais informações, consulte Atualizar e acompanhar o andamento da viagem e Gerenciar erros de viagem. |
| 5 | Quando uma viagem for concluída, pare de seguir | Parar de seguir uma viagem para não compartilhar a 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:
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 token da Web JSON (JWT) para o Fleet Engine no seu servidor. Para mais informações, consulte Emitir JWTs.
Implemente um coletor de tokens 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 coletor de tokens, consulte o guia de configuração para Android, iOS ou JavaScript.
Visualização do mapa e rastreadores de viagem
Acompanhar uma viagem inclui componentes para visualização de veículos e pontos de passagem, além de feeds de dados brutos para a hora prevista de chegada (ETA, na sigla em inglês) de um motorista ou a distância restante.
A tabela a seguir descreve esses componentes:
| Componente | Descrição |
|---|---|
| Visualização de mapa do consumidor | A visualização de mapa gerencia o ciclo de vida de uma viagem, mostrando waypoints para a localização dos veículos durante a viagem. Se a rota de um veículo for conhecida, a visualização do mapa vai atualizar a polilinha da rota do veículo para indicar o progresso do veículo ao longo da rota. |
| Provedor de localização de viagens em JavaScript | Para apps da Web JavaScript, o provedor de local da viagem envia informações de local para objetos rastreados no mapa de viagem compartilhado. Para mais
informações, consulte
Criar um provedor de local de viagem.
Você pode usar esse provedor para rastrear os seguintes detalhes de uma viagem:
|
Objetos de local rastreados
O provedor de local rastreia a localização de objetos, como pontos de passagem e veículos, conforme descrito na tabela a seguir.
| Local monitorado | Descrição |
|---|---|
| Local de retirada | O local de embarque é onde a viagem começa. |
| Local de destino | O local de destino é onde a viagem termina. Marca o local de desembarque. |
| Local do ponto de referência | Um local de waypoint é qualquer local intermediário ao longo do trajeto de uma viagem rastreada. Tecnicamente falando, os waypoints podem incluir locais de embarque e desembarque, mas 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 ponto de passagem. Para mais informações, consulte Pontos de referência da viagem na documentação do Fleet Engine. |
| Localização do veículo | A localização do veículo é o local informado. 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 local rastreado no mapa. Você pode usar opções de estilo personalizado para corresponder ao estilo do seu aplicativo da Web.
Controlar a visibilidade dos locais monitorados
Os provedores de localização predefinidos no Fleet Engine seguem essas regras de visibilidade para objetos de local rastreados no mapa. Se você criar um provedor de local personalizado ou derivado, poderá mudar as regras de visibilidade.
Os veículos só ficam visíveis 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 da entrega. Se a viagem for cancelada, o veículo não vai mais aparecer.
Todos os outros marcadores de local ficam sempre visíveis: todos os outros marcadores de local referentes a 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, independente do estado da viagem ou da entrega.
A seguir
Consulte a documentação da plataforma em que você quer seguir viagens: