Partilhar via


Citymapper (Editora Independente) (Pré-visualização)

O Citymapper permite-lhe adicionar planeamento de viagem e navegação passo a passo aos seus produtos. Nossos serviços são alimentados por nossos dados de transporte global líderes do setor e algoritmos de roteamento personalizados treinados em bilhões de viagens.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://citymapper.com/
Política de privacidade https://citymapper.com/api/1/resources?id=citymapper-privacy-policy
Categorias Estilo de vida e entretenimento

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API securestring A chave de API para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Contrate rotas de e-scooter entre dois pontos

Obtém uma rota de scooter elétrica alugada entre dois pontos, incluindo quaisquer caminhadas iniciais e finais. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Estes resultados são otimizados para pequenas scooters alimentadas por bateria em que o condutor se encontra. Esta chamada pode ser usada de várias maneiras diferentes: Use qualquer scooter da marca especificada Esta é a chamada mais simples, exigindo apenas 'start', 'end' e 'brand_id'. Citymapper assume que o usuário está no ponto 'inicial', e escolhe uma scooter da marca especificada, se possível. Use uma scooter em um local especificado Ao adicionar 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeia um percurso que assume que a scooter está no local indicado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclua o reencaminhamento da localização atual do utilizador se este tiver divergido da Rota planeada, o chamador pode adicionar as propriedades 'current_location' e 'ride_state', que indicam qual o trecho da rota resultante que deve ser reencaminhado em torno do 'current_location' do utilizador.

Faça um percurso pedestre entre dois pontos

Obtém uma rota a pé entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Espera-se que os percursos pedestres tenham uma única perna com um 'travel_mode' de 'caminhada'. Se o Citymapper não puder calcular as direções a pé para esses pontos (geralmente por motivos de cobertura), o serviço retornará um código de resposta '400'. A distância máxima ortodrómica entre o «início» e o «fim» está limitada a 100 km para este serviço.

Obtenha informações de partida e disponibilidade em tempo real para várias rotas

Isso recupera informações de partida atuais e em tempo real e cotações sob demanda em tempo real para várias rotas obtidas anteriormente dos pontos finais de 'direções'. Apenas rotas que tenham pelo menos um trecho com um Detalhe Atualizável de perna podem ser atualizadas usando este serviço. Observe que nem sempre é possível para o Citymapper fornecer horários atuais ou informações de partida e interrupção ao vivo para um trecho. As respostas bem-sucedidas (código HTTP '200') consumirão um crédito de 'Live Update' para cada resposta HTTP. As chamadas mal sucedidas não consumirão quaisquer créditos.

Obtenha tempos de viagem entre dois locais

Determina o tempo de viagem em vários modos de viagem entre os dois pontos indicados no momento em que o pedido é feito.

Obtenha uma ciclovia alugada entre dois pontos

Obtém uma ciclovia alugada entre dois pontos, incluindo quaisquer caminhadas iniciais e finais. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esta chamada pode ser usada de várias maneiras diferentes: Use qualquer bicicleta da marca especificada Esta é a chamada mais simples, exigindo apenas 'start', 'end' e 'brand_id'. Citymapper assume que o usuário está no ponto 'start', e escolhe uma bicicleta da marca especificada, se possível. Use uma bicicleta em um local especificado Ao adicionar 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeia um percurso que assume que a moto está no local indicado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclua o reencaminhamento da localização atual do utilizador se este tiver divergido da Rota planeada, o chamador pode adicionar as propriedades 'current_location' e 'ride_state', que indicam qual o trecho da rota resultante que deve ser reencaminhado em torno do 'current_location' do utilizador.

Obtenha uma rota de condução entre dois pontos

Obtém uma rota de carro entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esta chamada pressupõe que o motociclista tem um carro no ponto 'inicial' e fornece uma rota de carro de lá até o ponto 'final' se ambos estiverem dentro das áreas suportadas pelo Citymapper. A rota resultante deve conter uma única perna de carro. A distância máxima ortodrómica entre o início e o fim está limitada a 1000 km para este serviço.

Obtenha uma rota de scooter alugada entre dois pontos

Obtém uma rota de scooter alugada entre dois pontos, incluindo quaisquer caminhadas iniciais e finais. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Estes resultados são otimizados para scooters elétricas ou de combustão interna maiores onde o condutor está sentado.) OBSERVAÇÃO: O percurso resultante pressupõe atualmente que o utilizador pode deslocar-se diretamente para o local 'final' especificado, não tendo em conta quaisquer zonas de estacionamento ou cobertura. Assim, o percurso resultante conterá apenas uma etapa inicial de «travel_mode» «caminhada» e uma segunda etapa de «travel_mode» «self_piloted». Uma futura atualização incorporará zonas de estacionamento e cobertura e adicionará uma etapa final de "caminhada". Esta chamada pode ser usada de várias maneiras diferentes: Use qualquer scooter da marca especificada Esta é a chamada mais simples, exigindo apenas 'start', 'end' e 'brand_id'. Citymapper assume que o usuário está no ponto 'inicial', e escolhe uma scooter da marca especificada, se possível. Use uma scooter em um local especificado Ao adicionar 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeia um percurso que assume que a scooter está no local indicado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclua o reencaminhamento da localização atual do utilizador se este tiver divergido da Rota planeada, o chamador pode adicionar as propriedades 'current_location' e 'ride_state', que indicam qual o trecho da rota resultante que deve ser reencaminhado em torno do 'current_location' do utilizador.

Obtenha uma rota de scooter entre dois pontos

Obtém uma rota de scooter entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Estes resultados são otimizados para scooters elétricas ou de combustão interna maiores onde o condutor está sentado.) Esta chamada pressupõe que o condutor tem uma scooter no ponto 'inicial' e fornece uma rota de scooter elétrica de lá até o ponto 'final' se ambos estiverem dentro das áreas suportadas pelo Citymapper. O percurso resultante deve conter uma única perna de scooter, embora a propriedade 'path_annotations' da perna possa indicar secções durante as quais o utilizador deve caminhar ao lado da scooter. Esta chamada não incorpora nenhuma informação sobre a cobertura dos operadores de scooters ou áreas de estacionamento, mas outras chamadas de serviço podem estar disponíveis para fazê-lo.

Obtenha uma rota de trânsito entre dois pontos

Calcula várias rotas de transporte público entre dois pontos. Por padrão, os resultados conterão até 5 rotas. Cada um conterá várias pernas: geralmente uma no início e no final do percurso com 'travel_mode' de 'caminhada', com pelo menos uma com 'travel_mode' de 'trânsito' no meio.

Obtenha uma rota de táxi entre dois pontos

Obtém uma rota de táxi entre dois pontos. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. A rota pode conter trechos de caminhada iniciais e finais se os pontos de embarque ou desembarque não estiverem próximos das coordenadas de início e fim solicitadas. Os Serviços na resposta irão variar dependendo da disponibilidade local, hora do dia e, adicionalmente, quais integrações de serviço de Táxi foram configuradas para sua conta. Há duas maneiras recomendadas de usar esse serviço: você pode solicitar uma rota de táxi com estimativas de serviço sob demanda ao vivo incluídas antecipadamente ligando com '?fetch_on_demand_services=true'; Ou você pode fazer a solicitação inicial sem buscar estimativas que responderão com a rota não ativa, em seguida, ligue imediatamente para '1/live/routeupdates' para obter as estimativas adicionais ao vivo. A primeira abordagem é mais simples, mas a segunda pode se adequar melhor ao seu caso de uso.

Obter direções de scooter elétrica entre dois pontos

Obtém uma rota de scooter entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Estes resultados são otimizados para pequenas scooters alimentadas por bateria em que o condutor se encontra.) Esta chamada pressupõe que o condutor tem uma scooter no ponto 'inicial' e fornece uma rota de scooter elétrica de lá até o ponto 'final' se ambos estiverem dentro das áreas suportadas pelo Citymapper. O percurso resultante deve conter uma única perna de scooter, embora a propriedade 'path_annotations' da perna possa indicar secções durante as quais o utilizador deve caminhar ao lado da scooter. Esta chamada não incorpora nenhuma informação sobre a cobertura dos operadores de scooters ou áreas de estacionamento, mas outras chamadas de serviço podem estar disponíveis para fazê-lo. As respostas bem-sucedidas (código HTTP '200') consumirão um crédito de 'Rota de Scooter' (ou um crédito de 'Redirecionamento de Scooter' se 'reroute_signature' for usado) para cada resposta HTTP. As chamadas mal sucedidas não consumirão quaisquer créditos.

Obter uma rota de bicicleta entre dois pontos

Obtém uma rota de bicicleta entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esta chamada pressupõe que o ciclista tem uma bicicleta no ponto 'inicial', e fornece uma rota de bicicleta de lá até o ponto 'final' se ambos estiverem dentro das áreas apoiadas pelo Citymapper. O percurso resultante deve conter uma única perna de bicicleta, embora a propriedade 'path_annotations' da perna possa indicar secções durante as quais o utilizador deve caminhar ao lado da bicicleta. Esta chamada não incorpora nenhuma informação sobre a cobertura dos operadores de bicicletas ou áreas de estacionamento, mas outras chamadas de serviço podem estar disponíveis para fazê-lo. A distância máxima entre o início e o fim é limitada a 200 km para este serviço.

Obter uma rota entre dois pontos para um cenário

Calcula rotas entre dois pontos com base em um cenário fornecido. Um ou mais grupos de rotas podem ser fornecidos, dependendo de um cenário. Cada grupo conterá várias rotas. Cada percurso conterá um ou mais trechos.

Contrate rotas de e-scooter entre dois pontos

Obtém uma rota de scooter elétrica alugada entre dois pontos, incluindo quaisquer caminhadas iniciais e finais. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Estes resultados são otimizados para pequenas scooters alimentadas por bateria em que o condutor se encontra. Esta chamada pode ser usada de várias maneiras diferentes: Use qualquer scooter da marca especificada Esta é a chamada mais simples, exigindo apenas 'start', 'end' e 'brand_id'. Citymapper assume que o usuário está no ponto 'inicial', e escolhe uma scooter da marca especificada, se possível. Use uma scooter em um local especificado Ao adicionar 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeia um percurso que assume que a scooter está no local indicado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclua o reencaminhamento da localização atual do utilizador se este tiver divergido da Rota planeada, o chamador pode adicionar as propriedades 'current_location' e 'ride_state', que indicam qual o trecho da rota resultante que deve ser reencaminhado em torno do 'current_location' do utilizador.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

ID da marca
brand_id True string

O ID da Marca de e-scooters a utilizar para este percurso. Isto é necessário para determinar a localização das scooters disponíveis, juntamente com quaisquer restrições de cobertura e estacionamento associadas.

Estado
ride_state string

Indica onde o usuário está ao longo da rota. Se omitido, utiliza-se «walking_to_vehicle». Esta propriedade, juntamente com 'current_location', permite a recuperação de uma rota atualizada que reflete o progresso atual do usuário através dela. | valor | descrição | | ----- | ----------- | | walking_to_vehicle | Indica que o utilizador está a caminhar para recolher o veículo | | Equitação | Indica que o utilizador está a conduzir o veículo | | walking_to_end | Indica que o utilizador deixou o veículo e está a caminhar para o seu destino |

Localização Atual
current_location string

A localização atual do usuário, a fim de atualizar a rota com base na localização do usuário. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Este parâmetro é usado para obter uma rota atualizada que reflete a localização real do usuário se ele divergir do caminho fornecido na rota. Se isso for fornecido, a rota retornada conterá esse local. Qual trecho da rota conterá esse local é decidido pelo valor do parâmetro 'ride_state'.

Localização de início
ride_start_location string

A localização do veículo a ser utilizado, no início do passeio do veículo parte da viagem do usuário ao longo da Rota. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Isto deve ser fornecido quando «ride_state» é «conduzir» ou «walking_to_end». Se não for fornecido quando 'ride_state' é 'walking_to_vehicle' (ou não especificado), o Citymapper tentará encontrar o veículo mais apropriado que pertença ao 'brand_id' especificado. Para compatibilidade, 'original_vehicle_location' é um alias para este parâmetro

Localização Final
ride_end_location string

O local onde o veículo foi deixado no final do passeio de veículo faz parte da viagem do usuário ao longo da Rota. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Isto deve ser fornecido quando «ride_state» é «walking_to_end». Em todos os outros estados, esse parâmetro é ignorado.

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Redirecionar assinatura
reroute_signature string

Ao redirecionar (solicitando uma atualização para uma resposta anterior que contabilize o local atualizado do usuário), esse valor deve ser definido como a 'assinatura' fornecida na Rota original. Isso permite uma determinação mais eficiente da Rota atualizada. Esse valor deve ser codificado por URL. Ao fornecer este parâmetro, a localização «current_location» (quando aplicável) ou «início» deve ser definida para a localização mais recente do utilizador. Quando este parâmetro é incluído, o Citymapper pode não retornar resultados nos casos em que a solicitação difere significativamente do original, por exemplo, se o local 'final' for diferente, ou se mais de 1 hora tiver passado desde a solicitação original.

Comece a Rolamento
start_bearing integer

Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Este rolamento é usado para influenciar o texto de instrução inicial e/ou roteamento, mais comumente para evitar que o usuário seja solicitado a fazer um retorno em U, se continuar em seu rolamento atual dá uma rota comparável. Isso deve ser fornecido apenas se você quiser influenciar a direção inicial da viagem para a rota.

Localizações Passadas
past_loc_coords string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As coordenadas de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As coordenadas devem estar no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Idades de Localização Passadas
past_loc_ages string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As idades de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As idades devem estar em segundos inteiros desde a localização atual. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_coords» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Correções de localização anteriores
past_loc_accuracies string

Parâmetro opcional para melhorar o comportamento de redirecionamento. A precisão GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As precisões devem ser em medidores inteiros. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_coords» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Faça um percurso pedestre entre dois pontos

Obtém uma rota a pé entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Espera-se que os percursos pedestres tenham uma única perna com um 'travel_mode' de 'caminhada'. Se o Citymapper não puder calcular as direções a pé para esses pontos (geralmente por motivos de cobertura), o serviço retornará um código de resposta '400'. A distância máxima ortodrómica entre o «início» e o «fim» está limitada a 100 km para este serviço.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Profiles
profiles string

Indica quais 'perfis' usar ao calcular as direções de caminhada. Cada perfil pode gerar uma opção de rota diferente, portanto, solicitar mais perfis geralmente dará mais opções. Observe que, às vezes, algumas das rotas resultantes serão idênticas (no caso de uma rota ser ótima em mais de uma maneira), e um perfil pode nem sempre produzir uma rota. Nem todos os perfis estarão disponíveis para todas as rotas iniciais e finais. Os perfis indisponíveis serão omitidos da resposta. | valor | descrição | | ----- | ----------- | | rápido | O perfil padrão, tenta encontrar a rota mais rápida e sensata | | main_roads | Tentativas de evitar ruelas e parques | Se não forem especificados perfis, será utilizado o termo «rápido».

Redirecionar assinatura
reroute_signature string

Ao redirecionar (solicitando uma atualização para uma resposta anterior que contabilize o local atualizado do usuário), esse valor deve ser definido como a 'assinatura' fornecida na Rota original. Isso permite uma determinação mais eficiente da Rota atualizada. Esse valor deve ser codificado por URL. Ao fornecer este parâmetro, a localização «current_location» (quando aplicável) ou «início» deve ser definida para a localização mais recente do utilizador. Quando este parâmetro é incluído, o Citymapper pode não retornar resultados nos casos em que a solicitação difere significativamente do original, por exemplo, se o local 'final' for diferente, ou se mais de 1 hora tiver passado desde a solicitação original.

Comece a Rolamento
start_bearing integer

Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Este rolamento é usado para influenciar o texto de instrução inicial e/ou roteamento, mais comumente para evitar que o usuário seja solicitado a fazer um retorno em U, se continuar em seu rolamento atual dá uma rota comparável. Isso deve ser fornecido apenas se você quiser influenciar a direção inicial da viagem para a rota.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obtenha informações de partida e disponibilidade em tempo real para várias rotas

Isso recupera informações de partida atuais e em tempo real e cotações sob demanda em tempo real para várias rotas obtidas anteriormente dos pontos finais de 'direções'. Apenas rotas que tenham pelo menos um trecho com um Detalhe Atualizável de perna podem ser atualizadas usando este serviço. Observe que nem sempre é possível para o Citymapper fornecer horários atuais ou informações de partida e interrupção ao vivo para um trecho. As respostas bem-sucedidas (código HTTP '200') consumirão um crédito de 'Live Update' para cada resposta HTTP. As chamadas mal sucedidas não consumirão quaisquer créditos.

Parâmetros

Name Chave Necessário Tipo Description
Assinaturas
signatures True array of string

Uma matriz de propriedades de 'assinatura' de rotas obtidas anteriormente

Buscar serviços sob demanda
fetch_on_demand_services boolean

Ao atualizar usando uma ou mais Assinaturas de rotas que contenham trechos sob demanda com detalhes atualizáveis (por exemplo, do serviço de Direções de Táxi), se isso estiver definido como 'verdadeiro', informações adicionais serão solicitadas às instruções do serviço de táxi para fornecer preços, duração e disponibilidade do serviço mais precisos e completos. Para fornecer isso, os locais de início e término da Rota original precisam ser transmitidos para esses serviços de Terceiros, inclusive no caso de um ou outro ser o local atual ou recente do usuário. Esteja ciente de que você pode precisar ter consentimento informado explícito do seu usuário final para definir isso como "verdadeiro", dependendo das leis e regulamentos aplicáveis. Se definido como 'falso' ou omitido, nenhuma solicitação será feita a quaisquer serviços de terceiros. Se nenhuma atualização puder ser produzida para uma etapa sem que esse parâmetro seja definido como 'true', a resposta indicará isso dentro do detalhe atualizável.

Devoluções

Name Caminho Tipo Description
route_updates
route_updates array of object
Atualizações Leg
route_updates.leg_updates array of

Esta é uma matriz paralela de objetos Detalhe atualizável da perna, um para cada perna na rota original que está sendo atualizada. Os correspondentes aos trechos de caminhada estarão vazios, mas os detalhes correspondentes aos trechos de trânsito conterão informações atualizadas de partida.

Hora de Partida
route_updates.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja no início da rota no momento da solicitação. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
route_updates.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado supondo que o usuário esteja no início da rota no momento da solicitação. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Duração
route_updates.route_duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos. Esse valor substitui o valor 'duration_seconds' da Rota original, pois ele será recalculado para usar as informações de partida específicas contidas nesta resposta de atualização de rota. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada, por exemplo, se a rota não puder ser concluída no momento determinado porque os Serviços envolvidos não estão em execução.

DurationAccuracy
route_updates.route_duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Solicitar Assinatura
route_updates.request_signature string

Esta é uma 'assinatura' de rota da solicitação de atualização, que deve ser usada para associar essa atualização à Rota correta.

Obtenha tempos de viagem entre dois locais

Determina o tempo de viagem em vários modos de viagem entre os dois pontos indicados no momento em que o pedido é feito.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True string

O ponto de partida geográfico da viagem, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados.

Fim
end True string

O ponto final geográfico da viagem, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados.

Tipos de viagem
traveltime_types array

Uma lista separada por vírgulas de diferentes tipos de tempo de viagem para tentar solicitar. Cada valor de solicitação corresponde a um campo específico na resposta (os campos de resposta só estarão presentes quando o Citymapper puder calcular um tempo para esse tipo de tempo de viagem). | valor | propriedade response | descrição | | ----- | ----------------- | ------------| | Caminhada | walk_travel_time_minutes | Caminhar | | trânsito | transit_time_minutes | Viagens de transporte público | | bicicleta | bike_time_minutes | Viagem de bicicleta (percorrer todo o percurso) | | scooter | scooter_time_minutes | Viagem de scooter elétrica em pé (todo o caminho) | | motoneta | motorscooter_time_minutes | Viagem de scooter sentada (andando todo o caminho) | | carro | car_time_minutes | Viagem de carro (andando todo o caminho). Disponível apenas em planos Enterprise | Quando este campo é omitido ou vazio, um valor padrão de 'walk,transit' será usado.

Devoluções

Name Caminho Tipo Description
Tempo de caminhada
walk_travel_time_minutes integer

Tempo de caminhada estimado entre os dois pontos dados em minutos.

Tempo de Trânsito
transit_time_minutes integer

Tempo estimado de viagem de transporte público entre os dois pontos dados em minutos.

Tempo de bicicleta
bike_time_minutes integer

Tempo estimado de viagem de bicicleta entre dois pontos em minutos.

Tempo de Scooter
scooter_time_minutes integer

Tempo de viagem estimado da scooter elétrica entre dois pontos em minutos.

Tempo de Scooter
motorscooter_time_minutes integer

Tempo de viagem estimado da scooter entre dois pontos em minutos.

Tempo de condução
car_time_minutes integer

Tempo de viagem estimado entre dois pontos em minutos.

Obtenha uma ciclovia alugada entre dois pontos

Obtém uma ciclovia alugada entre dois pontos, incluindo quaisquer caminhadas iniciais e finais. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esta chamada pode ser usada de várias maneiras diferentes: Use qualquer bicicleta da marca especificada Esta é a chamada mais simples, exigindo apenas 'start', 'end' e 'brand_id'. Citymapper assume que o usuário está no ponto 'start', e escolhe uma bicicleta da marca especificada, se possível. Use uma bicicleta em um local especificado Ao adicionar 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeia um percurso que assume que a moto está no local indicado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclua o reencaminhamento da localização atual do utilizador se este tiver divergido da Rota planeada, o chamador pode adicionar as propriedades 'current_location' e 'ride_state', que indicam qual o trecho da rota resultante que deve ser reencaminhado em torno do 'current_location' do utilizador.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

ID da marca
brand_id True string

O ID da Marca da bicicleta a utilizar neste percurso. Isto é necessário para determinar a localização das bicicletas disponíveis, juntamente com quaisquer coberturas associadas e restrições de estacionamento.

Estado
ride_state string

Indica onde o usuário está ao longo da rota. Se omitido, utiliza-se «walking_to_vehicle». Esta propriedade, juntamente com 'current_location', permite a recuperação de uma rota atualizada que reflete o progresso atual do usuário através dela. | valor | descrição | | ----- | ----------- | | walking_to_vehicle | Indica que o utilizador está a caminhar para recolher o veículo | | Equitação | Indica que o utilizador está a conduzir o veículo | | walking_to_end | Indica que o utilizador deixou o veículo e está a caminhar para o seu destino |

Localização Atual
current_location string

A localização atual do usuário, a fim de atualizar a rota com base na localização do usuário. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Este parâmetro é usado para obter uma rota atualizada que reflete a localização real do usuário se ele divergir do caminho fornecido na rota. Se isso for fornecido, a rota retornada conterá esse local. Qual trecho da rota conterá esse local é decidido pelo valor do parâmetro 'ride_state'.

Localização de início
ride_start_location string

A localização do veículo a ser utilizado, no início do passeio do veículo parte da viagem do usuário ao longo da Rota. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Isto deve ser fornecido quando «ride_state» é «conduzir» ou «walking_to_end». Se não for fornecido quando 'ride_state' é 'walking_to_vehicle' (ou não especificado), o Citymapper tentará encontrar o veículo mais apropriado que pertença ao 'brand_id' especificado. Para compatibilidade, 'original_vehicle_location' é um alias para este parâmetro

Localização Final
ride_end_location string

O local onde o veículo foi deixado no final do passeio de veículo faz parte da viagem do usuário ao longo da Rota. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Isto deve ser fornecido quando «ride_state» é «walking_to_end». Em todos os outros estados, esse parâmetro é ignorado.

Profiles
profiles string

Indica quais os 'perfis' a utilizar no cálculo das direções da bicicleta. Cada perfil pode gerar uma opção de rota diferente, portanto, solicitar mais perfis geralmente dará mais opções. Observe que, às vezes, algumas das rotas resultantes serão idênticas (no caso de uma rota ser ótima em mais de uma maneira), e um perfil pode nem sempre produzir uma rota. | valor | descrição | | ----- | ----------- | | sossego | Tentativas de utilização de estradas com menos tráfego | | regular | O perfil padrão, equilibra o tráfego com a franqueza | | rápido | Tentativas de encontrar o caminho mais curto e sensato | Se não forem especificados perfis, será utilizado o termo «regular».

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Redirecionar assinatura
reroute_signature string

Ao redirecionar (solicitando uma atualização para uma resposta anterior que contabilize o local atualizado do usuário), esse valor deve ser definido como a 'assinatura' fornecida na Rota original. Isso permite uma determinação mais eficiente da Rota atualizada. Esse valor deve ser codificado por URL. Ao fornecer este parâmetro, a localização «current_location» (quando aplicável) ou «início» deve ser definida para a localização mais recente do utilizador. Quando este parâmetro é incluído, o Citymapper pode não retornar resultados nos casos em que a solicitação difere significativamente do original, por exemplo, se o local 'final' for diferente, ou se mais de 1 hora tiver passado desde a solicitação original.

Comece a Rolamento
start_bearing integer

Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Este rolamento é usado para influenciar o texto de instrução inicial e/ou roteamento, mais comumente para evitar que o usuário seja solicitado a fazer um retorno em U, se continuar em seu rolamento atual dá uma rota comparável. Isso deve ser fornecido apenas se você quiser influenciar a direção inicial da viagem para a rota.

Localizações Passadas
past_loc_coords string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As coordenadas de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As coordenadas devem estar no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Idades de Localização Passadas
past_loc_ages string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As idades de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As idades devem estar em segundos inteiros desde a localização atual. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_coords» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Correções de localização anteriores
past_loc_accuracies string

Parâmetro opcional para melhorar o comportamento de redirecionamento. A precisão GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As precisões devem ser em medidores inteiros. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_coords» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obtenha uma rota de condução entre dois pontos

Obtém uma rota de carro entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esta chamada pressupõe que o motociclista tem um carro no ponto 'inicial' e fornece uma rota de carro de lá até o ponto 'final' se ambos estiverem dentro das áreas suportadas pelo Citymapper. A rota resultante deve conter uma única perna de carro. A distância máxima ortodrómica entre o início e o fim está limitada a 1000 km para este serviço.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obtenha uma rota de scooter alugada entre dois pontos

Obtém uma rota de scooter alugada entre dois pontos, incluindo quaisquer caminhadas iniciais e finais. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Estes resultados são otimizados para scooters elétricas ou de combustão interna maiores onde o condutor está sentado.) OBSERVAÇÃO: O percurso resultante pressupõe atualmente que o utilizador pode deslocar-se diretamente para o local 'final' especificado, não tendo em conta quaisquer zonas de estacionamento ou cobertura. Assim, o percurso resultante conterá apenas uma etapa inicial de «travel_mode» «caminhada» e uma segunda etapa de «travel_mode» «self_piloted». Uma futura atualização incorporará zonas de estacionamento e cobertura e adicionará uma etapa final de "caminhada". Esta chamada pode ser usada de várias maneiras diferentes: Use qualquer scooter da marca especificada Esta é a chamada mais simples, exigindo apenas 'start', 'end' e 'brand_id'. Citymapper assume que o usuário está no ponto 'inicial', e escolhe uma scooter da marca especificada, se possível. Use uma scooter em um local especificado Ao adicionar 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeia um percurso que assume que a scooter está no local indicado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclua o reencaminhamento da localização atual do utilizador se este tiver divergido da Rota planeada, o chamador pode adicionar as propriedades 'current_location' e 'ride_state', que indicam qual o trecho da rota resultante que deve ser reencaminhado em torno do 'current_location' do utilizador.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

ID da marca
brand_id True string

O ID da Marca de scooters a utilizar para este percurso. Isto é necessário para determinar a localização das scooters disponíveis, juntamente com quaisquer restrições de cobertura e estacionamento associadas.

Estado
ride_state string

Indica onde o usuário está ao longo da rota. Se omitido, utiliza-se «walking_to_vehicle». Esta propriedade, juntamente com 'current_location', permite a recuperação de uma rota atualizada que reflete o progresso atual do usuário através dela. | valor | descrição | | ----- | ----------- | | walking_to_vehicle | Indica que o utilizador está a caminhar para recolher o veículo | | Equitação | Indica que o utilizador está a conduzir o veículo | | walking_to_end | Indica que o utilizador deixou o veículo e está a caminhar para o seu destino |

Localização Atual
current_location string

A localização atual do usuário, a fim de atualizar a rota com base na localização do usuário. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Este parâmetro é usado para obter uma rota atualizada que reflete a localização real do usuário se ele divergir do caminho fornecido na rota. Se isso for fornecido, a rota retornada conterá esse local. Qual trecho da rota conterá esse local é decidido pelo valor do parâmetro 'ride_state'.

Localização de início
ride_start_location string

A localização do veículo a ser utilizado, no início do passeio do veículo parte da viagem do usuário ao longo da Rota. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Isto deve ser fornecido quando «ride_state» é «conduzir» ou «walking_to_end». Se não for fornecido quando 'ride_state' é 'walking_to_vehicle' (ou não especificado), o Citymapper tentará encontrar o veículo mais apropriado que pertença ao 'brand_id' especificado. Para compatibilidade, 'original_vehicle_location' é um alias para este parâmetro

Localização Final
ride_end_location string

O local onde o veículo foi deixado no final do passeio de veículo faz parte da viagem do usuário ao longo da Rota. Fornecido no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Isto deve ser fornecido quando «ride_state» é «walking_to_end». Em todos os outros estados, esse parâmetro é ignorado.

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Redirecionar assinatura
reroute_signature string

Ao redirecionar (solicitando uma atualização para uma resposta anterior que contabilize o local atualizado do usuário), esse valor deve ser definido como a 'assinatura' fornecida na Rota original. Isso permite uma determinação mais eficiente da Rota atualizada. Esse valor deve ser codificado por URL. Ao fornecer este parâmetro, a localização «current_location» (quando aplicável) ou «início» deve ser definida para a localização mais recente do utilizador. Quando este parâmetro é incluído, o Citymapper pode não retornar resultados nos casos em que a solicitação difere significativamente do original, por exemplo, se o local 'final' for diferente, ou se mais de 1 hora tiver passado desde a solicitação original.

Comece a Rolamento
start_bearing integer

Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Este rolamento é usado para influenciar o texto de instrução inicial e/ou roteamento, mais comumente para evitar que o usuário seja solicitado a fazer um retorno em U, se continuar em seu rolamento atual dá uma rota comparável. Isso deve ser fornecido apenas se você quiser influenciar a direção inicial da viagem para a rota.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obtenha uma rota de scooter entre dois pontos

Obtém uma rota de scooter entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Estes resultados são otimizados para scooters elétricas ou de combustão interna maiores onde o condutor está sentado.) Esta chamada pressupõe que o condutor tem uma scooter no ponto 'inicial' e fornece uma rota de scooter elétrica de lá até o ponto 'final' se ambos estiverem dentro das áreas suportadas pelo Citymapper. O percurso resultante deve conter uma única perna de scooter, embora a propriedade 'path_annotations' da perna possa indicar secções durante as quais o utilizador deve caminhar ao lado da scooter. Esta chamada não incorpora nenhuma informação sobre a cobertura dos operadores de scooters ou áreas de estacionamento, mas outras chamadas de serviço podem estar disponíveis para fazê-lo.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Redirecionar assinatura
reroute_signature string

Ao redirecionar (solicitando uma atualização para uma resposta anterior que contabilize o local atualizado do usuário), esse valor deve ser definido como a 'assinatura' fornecida na Rota original. Isso permite uma determinação mais eficiente da Rota atualizada. Esse valor deve ser codificado por URL. Ao fornecer este parâmetro, a localização «current_location» (quando aplicável) ou «início» deve ser definida para a localização mais recente do utilizador. Quando este parâmetro é incluído, o Citymapper pode não retornar resultados nos casos em que a solicitação difere significativamente do original, por exemplo, se o local 'final' for diferente, ou se mais de 1 hora tiver passado desde a solicitação original.

Comece a Rolamento
start_bearing integer

Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Este rolamento é usado para influenciar o texto de instrução inicial e/ou roteamento, mais comumente para evitar que o usuário seja solicitado a fazer um retorno em U, se continuar em seu rolamento atual dá uma rota comparável. Isso deve ser fornecido apenas se você quiser influenciar a direção inicial da viagem para a rota.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obtenha uma rota de trânsito entre dois pontos

Calcula várias rotas de transporte público entre dois pontos. Por padrão, os resultados conterão até 5 rotas. Cada um conterá várias pernas: geralmente uma no início e no final do percurso com 'travel_mode' de 'caminhada', com pelo menos uma com 'travel_mode' de 'trânsito' no meio.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Time
time string

O tempo a ser usado como uma restrição de tempo de partida ou chegada ao obter direções. A hora é expressa no formato ISO 8601 , incluindo data, hora e fuso horário. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Tipo de Tempo
time_type string

Quando um valor de 'tempo' é dado, isso determina como o tempo será usado para restringir as direções que são retornadas. Quando isso não é especificado, 'depart_approximate' é usado. Se não for dado «tempo», tal não produz efeitos. | valor | descrição | | ----- | ----------- | | chegar | São escolhidas direções que levam o utilizador ao seu destino no ou antes do 'tempo' | | Partida | As direções são escolhidas assumindo que o utilizador deixa a sua origem logo após o 'tempo' possível | | depart_approximate | Semelhante a "partir", mas permitindo partidas posteriores, a fim de retornar opções mais preferíveis, mesmo que saiam um pouco mais tarde. Esta é a maneira padrão do Citymapper de escolher direções quando o horário não é especificado |

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Limite
limit integer

Número máximo de rotas a retornar.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obtenha uma rota de táxi entre dois pontos

Obtém uma rota de táxi entre dois pontos. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. A rota pode conter trechos de caminhada iniciais e finais se os pontos de embarque ou desembarque não estiverem próximos das coordenadas de início e fim solicitadas. Os Serviços na resposta irão variar dependendo da disponibilidade local, hora do dia e, adicionalmente, quais integrações de serviço de Táxi foram configuradas para sua conta. Há duas maneiras recomendadas de usar esse serviço: você pode solicitar uma rota de táxi com estimativas de serviço sob demanda ao vivo incluídas antecipadamente ligando com '?fetch_on_demand_services=true'; Ou você pode fazer a solicitação inicial sem buscar estimativas que responderão com a rota não ativa, em seguida, ligue imediatamente para '1/live/routeupdates' para obter as estimativas adicionais ao vivo. A primeira abordagem é mais simples, mas a segunda pode se adequar melhor ao seu caso de uso.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Buscar serviços no domínio
fetch_on_demand_services string

Se definido como 'true', informações adicionais serão solicitadas às suas integrações de serviço de táxi para fornecer preços, duração e disponibilidade de serviço mais precisos e completos, retornados nos detalhes atualizáveis do trecho sob demanda. Para fornecer isso, os locais de início e término da Rota precisam ser transmitidos para esses serviços de Terceiros, inclusive no caso de um ou outro ser o local atual ou recente do usuário. Esteja ciente de que você pode precisar ter consentimento informado explícito do seu usuário final para definir isso como "verdadeiro", dependendo das leis e regulamentos aplicáveis. Se definido como 'falso' ou omitido, nenhuma solicitação será feita a quaisquer serviços de terceiros.

IDs de marca
brand_ids array

Lista de IDs de marca separada por vírgulas para limitar esta solicitação de instruções. Se omitida (padrão), todas as marcas disponíveis para você terão uma rota de táxi retornada.

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obter direções de scooter elétrica entre dois pontos

Obtém uma rota de scooter entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Estes resultados são otimizados para pequenas scooters alimentadas por bateria em que o condutor se encontra.) Esta chamada pressupõe que o condutor tem uma scooter no ponto 'inicial' e fornece uma rota de scooter elétrica de lá até o ponto 'final' se ambos estiverem dentro das áreas suportadas pelo Citymapper. O percurso resultante deve conter uma única perna de scooter, embora a propriedade 'path_annotations' da perna possa indicar secções durante as quais o utilizador deve caminhar ao lado da scooter. Esta chamada não incorpora nenhuma informação sobre a cobertura dos operadores de scooters ou áreas de estacionamento, mas outras chamadas de serviço podem estar disponíveis para fazê-lo. As respostas bem-sucedidas (código HTTP '200') consumirão um crédito de 'Rota de Scooter' (ou um crédito de 'Redirecionamento de Scooter' se 'reroute_signature' for usado) para cada resposta HTTP. As chamadas mal sucedidas não consumirão quaisquer créditos.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Redirecionar assinatura
reroute_signature string

Ao redirecionar (solicitando uma atualização para uma resposta anterior que contabilize o local atualizado do usuário), esse valor deve ser definido como a 'assinatura' fornecida na Rota original. Isso permite uma determinação mais eficiente da Rota atualizada. Esse valor deve ser codificado por URL. Ao fornecer este parâmetro, a localização «current_location» (quando aplicável) ou «início» deve ser definida para a localização mais recente do utilizador. Quando este parâmetro é incluído, o Citymapper pode não retornar resultados nos casos em que a solicitação difere significativamente do original, por exemplo, se o local 'final' for diferente, ou se mais de 1 hora tiver passado desde a solicitação original.

Comece a Rolamento
start_bearing integer

Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Este rolamento é usado para influenciar o texto de instrução inicial e/ou roteamento, mais comumente para evitar que o usuário seja solicitado a fazer um retorno em U, se continuar em seu rolamento atual dá uma rota comparável. Isso deve ser fornecido apenas se você quiser influenciar a direção inicial da viagem para a rota.

Localizações Passadas
past_loc_coords string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As coordenadas de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As coordenadas devem estar no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Idades de Localização Passadas
past_loc_ages string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As idades de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As idades devem estar em segundos inteiros desde a localização atual. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_coords» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Correções de localização anteriores
past_loc_accuracies string

Parâmetro opcional para melhorar o comportamento de redirecionamento. A precisão GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As precisões devem ser em medidores inteiros. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_coords» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obter uma rota de bicicleta entre dois pontos

Obtém uma rota de bicicleta entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esta chamada pressupõe que o ciclista tem uma bicicleta no ponto 'inicial', e fornece uma rota de bicicleta de lá até o ponto 'final' se ambos estiverem dentro das áreas apoiadas pelo Citymapper. O percurso resultante deve conter uma única perna de bicicleta, embora a propriedade 'path_annotations' da perna possa indicar secções durante as quais o utilizador deve caminhar ao lado da bicicleta. Esta chamada não incorpora nenhuma informação sobre a cobertura dos operadores de bicicletas ou áreas de estacionamento, mas outras chamadas de serviço podem estar disponíveis para fazê-lo. A distância máxima entre o início e o fim é limitada a 200 km para este serviço.

Parâmetros

Name Chave Necessário Tipo Description
Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Profiles
profiles string

Indica quais os 'perfis' a utilizar no cálculo das direções da bicicleta. Cada perfil pode gerar uma opção de rota diferente, portanto, solicitar mais perfis geralmente dará mais opções. Observe que, às vezes, algumas das rotas resultantes serão idênticas (no caso de uma rota ser ótima em mais de uma maneira), e um perfil pode nem sempre produzir uma rota. | valor | descrição | | ----- | ----------- | | sossego | Tentativas de utilização de estradas com menos tráfego | | regular | O perfil padrão, equilibra o tráfego com a franqueza | | rápido | Tentativas de encontrar o caminho mais curto e sensato | Se não forem especificados perfis, será utilizado o termo «regular».

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Redirecionar assinatura
reroute_signature string

Ao redirecionar (solicitando uma atualização para uma resposta anterior que contabilize o local atualizado do usuário), esse valor deve ser definido como a 'assinatura' fornecida na Rota original. Isso permite uma determinação mais eficiente da Rota atualizada. Esse valor deve ser codificado por URL. Ao fornecer este parâmetro, a localização «current_location» (quando aplicável) ou «início» deve ser definida para a localização mais recente do utilizador. Quando este parâmetro é incluído, o Citymapper pode não retornar resultados nos casos em que a solicitação difere significativamente do original, por exemplo, se o local 'final' for diferente, ou se mais de 1 hora tiver passado desde a solicitação original.

Comece a Rolamento
start_bearing integer

Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Este rolamento é usado para influenciar o texto de instrução inicial e/ou roteamento, mais comumente para evitar que o usuário seja solicitado a fazer um retorno em U, se continuar em seu rolamento atual dá uma rota comparável. Isso deve ser fornecido apenas se você quiser influenciar a direção inicial da viagem para a rota.

Localizações Passadas
past_loc_coords string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As coordenadas de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As coordenadas devem estar no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas os primeiros 6 dígitos de precisão serão usados. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Idades de Localização Passadas
past_loc_ages string

Parâmetro opcional para melhorar o comportamento de redirecionamento. As idades de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As idades devem estar em segundos inteiros desde a localização atual. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_coords» e «past_loc_accuracies» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Correções de localização anteriores
past_loc_accuracies string

Parâmetro opcional para melhorar o comportamento de redirecionamento. A precisão GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgula. As precisões devem ser em medidores inteiros. Deve ser ordenado cronologicamente, último mais recente. As expressões «past_loc_ages» e «past_loc_coords» devem ser colocadas lado a lado. O servidor só considerará um máximo de 10 locais, se mais de 10 locais forem fornecidos, os locais menos recentes serão ignorados. É provável que o servidor ignore quaisquer locais com mais de 30 segundos ou qualquer local com menos de 1 segundo de diferença.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.

Obter uma rota entre dois pontos para um cenário

Calcula rotas entre dois pontos com base em um cenário fornecido. Um ou mais grupos de rotas podem ser fornecidos, dependendo de um cenário. Cada grupo conterá várias rotas. Cada percurso conterá um ou mais trechos.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenario_id True string

ID do cenário para direções.

Start
start True array

O início geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Fim
end True array

O fim geográfico da rota, no formato WGS84 'latitude,longitude'. As coordenadas devem estar em decimais, e apenas as primeiras 6 casas decimais serão usadas.

Time
time string

O tempo a ser usado como uma restrição de tempo de partida ou chegada ao obter direções. A hora é expressa no formato ISO 8601 , incluindo data, hora e fuso horário. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Tipo de Tempo
time_type string

Quando um valor de 'tempo' é dado, isso determina como o tempo será usado para restringir as direções que são retornadas. Quando isso não é especificado, 'depart_approximate' é usado. Se não for dado «tempo», tal não produz efeitos. | valor | descrição | | ----- | ----------- | | chegar | São escolhidas direções que levam o utilizador ao seu destino no ou antes do 'tempo' | | Partida | As direções são escolhidas assumindo que o utilizador deixa a sua origem logo após o 'tempo' possível | | depart_approximate | Semelhante a "partir", mas permitindo partidas posteriores, a fim de retornar opções mais preferíveis, mesmo que saiam um pouco mais tarde. Esta é a maneira padrão do Citymapper de escolher direções quando o horário não é especificado |

Linguagem
language string

Uma marca de idioma IETF BCP 47 que indica a preferência de idioma do usuário final. Quando fornecida, a resposta conterá uma propriedade 'language' que indica o idioma usado para quaisquer elementos localizáveis da resposta (como instruções de viragem). Esta linguagem será uma tentativa de melhor esforço para cumprir a preferência expressa, mas pode conter um valor que não foi expresso na solicitação (isso geralmente será 'en-US' como um fallback). Observe que a preferência de idioma geralmente afetará apenas o conteúdo gerado pelo Citymapper, como instruções de viragem. O conteúdo externo, como nomes de parada e descrições de status, geralmente é transmitido em seu idioma original.

Devoluções

Name Caminho Tipo Description
routes
routes array of object
Latitude
routes.start.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.start.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Latitude
routes.end.coordinates.lat float

Uma latitude na codificação WGS84, com 6 dígitos de precisão decimal.

Longitude
routes.end.coordinates.lon float

Uma longitude na codificação WGS84, com 6 dígitos de precisão decimal.

Distância em metros
routes.distance_meters integer

A distância total de todo o Percurso, em metros.

Duração
routes.duration_seconds integer

O tempo total estimado para percorrer todo o percurso, em segundos, com base no veículo selecionado ou partida na resposta.

Precisão da duração
routes.duration_accuracy string

Avaliação do Citymapper de como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é amplamente baseado no 'tipo' de partidas usado para os tempos, mas envolve heurísticas adicionais desenvolvidas ao longo do tempo para o aplicativo Citymapper. Quando este campo não é fornecido, deve ser utilizado o valor «programado». | valor | descrição | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, uma vez que o seu cálculo envolveu mais incerteza do que o habitual. Esta é a precisão mais baixa. | | agendado | Uma duração normal, normalmente baseada em informações de horário publicadas. | | ao vivo | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Esta é a mais alta precisão. |

Formatado
routes.price.formatted string

O preço dado como uma cadeia de caracteres formatada. Por padrão, isso ocorre no formato de moeda nativa da região onde a rota ocorre.

Montante
routes.price.amount string

O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de Quantidade Mínima
routes.price.amount_range_minimum string

Se este Preço representar um intervalo de valores possíveis, o preço mínimo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região.

Intervalo de quantidade Máximo
routes.price.amount_range_maximum string

Se este Preço representar um intervalo de valores possíveis, o preço máximo será um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de vírgula flutuante. Não incluirá símbolos monetários e o separador entre as unidades principais e secundárias será sempre «.», independentemente da região. Isso pode não ser incluído se o intervalo for aberto

Moeda
routes.price.currency string

A moeda em que o preço é dado, na forma ISO 4217 de três letras.

Multiplicador de Procura
routes.price.demand_multipler float

Indica que os preços são mais altos do que o habitual por causa da demanda, geralmente para trechos de táxi (sob demanda). Pode, em casos raros, ser inferior a 1,0

Emissões de CO2e
routes.emissions_grams_co2e float

Uma estimativa das emissões de gases com efeito de estufa da rota, expressas em gramas de equivalente dióxido de carbono (CO2e).

Pernas
routes.legs array of object

Conjunto de pernas que compõem o Percurso, pela ordem em que devem ser percorridos. Cada rota válida terá pelo menos uma.

Modo de viagem
routes.legs.travel_mode string

O modo de viagem.

Duração
routes.legs.duration_seconds integer

O tempo necessário para percorrer este trecho, excluindo qualquer tempo de espera ou embarque no início. Pode ser omitida em circunstâncias raras em que a duração não pode ser calculada.

Caminho
routes.legs.path string

O caminho geográfico que a perna percorre, como uma série de coordenadas WGS84 codificadas no Google Polyline Format, com uma precisão decimal de 5 dígitos. Por exemplo, o valor '_flyHbjPDZBTBNDJ' codifica a seguinte série de coordenadas (latitude, longitude): '' [(51,51344, -0,08882), (51,51341, -0,08896), (51,51339, -0,08907), (51,51337, -0,08915), (51,51334, -0,08921)] ''

Instruções
routes.legs.instructions array of object

Isso fornece a lista de instruções de volta para guiar o usuário através de pernas onde o usuário precisa navegar, como ao caminhar ou usar uma scooter ou bicicleta.

Índice de caminho
routes.legs.instructions.path_index integer

índice baseado em 0 na lista de coordenadas fornecidas pela propriedade 'path' da perna. Isso indica o local em que a instrução deve ser seguida, então será o local da curva no caminho, ou o início ou fim da perna.

Distância
routes.legs.instructions.distance_meters integer

A distância em metros da seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Time
routes.legs.instructions.time_seconds integer

O tempo, em segundos, que se espera que o usuário leve para percorrer a seção do 'caminho' antes desta instrução. Esta propriedade será omitida para instruções iniciais do tipo 'partir'.

Description
routes.legs.instructions.description_text string

Descrição em texto simples da Instrução para o usuário.

Formato da descrição
routes.legs.instructions.description_format string

Formato de texto para renderizar a instrução com elementos enfatizados, onde '{key}' indica uma parte da cadeia de caracteres que deve ser substituída por conteúdo definido pela entrada correspondente a 'key' em 'description_format_replacements'. Isso permite que os elementos descritos pelas substituições sejam formatados de forma diferente pelo cliente, se desejado. As cadeias de teclas conterão apenas os caracteres '[a-zA-Z0-9]'. '{ }' não será aninhado, e os caracteres literais '{' e '}' são codificados pelas sequências de escape '{' e '}', respectivamente.

description_format_replacements
routes.legs.instructions.description_format_replacements array of object
Key
routes.legs.instructions.description_format_replacements.key string

Uma chave correspondente a uma cadeia de caracteres incluída em '{}' em 'description_format'.

Texto
routes.legs.instructions.description_format_replacements.text string

O texto a ser usado para substituir a substring '{key}' no 'description_format'.

Tipo
routes.legs.instructions.description_format_replacements.type string

Um valor que indica que tipo de coisa do mundo real está sendo identificada por essa substituição de formato. Isso permite que os clientes de serviço apliquem formatação específica do aplicativo, se desejado. | valor | descrição | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outra via | | exit_number | O número de uma saída, geralmente de uma rotunda |

Linguagem
routes.legs.instructions.description_format_replacements.language string

Uma marca de idioma IETF BCP 47 que indica em que idioma o 'texto' associado está. Observe que isso pode ser diferente do idioma da descrição ao redor - isso é mais comum quando a substituição é um topônimo em um idioma local, enquanto a descrição está em um idioma diferente.

Tipo
routes.legs.instructions.type string

Indica o tipo de instrução.

Tipo Direção
routes.legs.instructions.type_direction string

Indica uma direção que modifica esta Instrução.

Hora de Partida
routes.route_departure_time string

A hora em que o Citymapper pensa que o utilizador irá partir para esta rota, dadas as informações de partida disponíveis. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

Hora de Chegada
routes.route_arrival_time string

A hora em que o Citymapper pensa que o utilizador chegará ao final desta rota, dadas as informações de partida disponíveis e a velocidade de viagem esperada. Isso é calculado assumindo que o usuário está no início da rota. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir qualquer informação de partida atualizada. A hora é expressa no formato ISO 8601 , incluindo uma data, hora e fuso horário em que o evento ocorre. Por exemplo, '2020-08-19T08:10:42-04:00' expressa 19 de agosto de 2020 às 8h10 no horário de verão do leste.

groups
routes.route_metadata.groups array of object
ID do grupo
routes.route_metadata.groups.group_id string

ID de um grupo no qual uma rota contém.

Grupo
routes.route_metadata.groups.group_name string

Nome localizado de um grupo de rotas, por exemplo, 'Trânsito' ou 'Le metro'.

Posição da rota
routes.route_metadata.groups.route_position integer

Uma posição baseada em zero de uma rota dentro de um grupo específico.

Nome do perfil
routes.route_metadata.profile_name string

Nome localizado legível por humanos do identificador 'perfil'.

Profile
routes.profile string

Indica qual 'perfil' de roteamento foi usado para calcular essa rota. Por exemplo, uma resposta de um ponto de extremidade de roteamento de bicicleta pode retornar várias rotas, uma com um perfil "silencioso" e outra com um perfil "rápido". Observe que novos valores podem ser adicionados a qualquer momento, portanto, qualquer código que analise esse campo deve ser capaz de lidar com valores inesperados. Esse valor corresponderá ao parâmetro de solicitação 'perfis' em pontos de extremidade que suportam a seleção de perfis de roteamento específicos. Este valor destina-se a ser legível apenas por máquina. Para que um nome de perfil seja exibido a um usuário, use o 'profile_name' no objeto 'route_metadata'.

Signature
routes.signature string

Um valor a ser passado de volta ao servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de partida ao vivo via 'service/1/live/routeupdates'). Deve ser tratado como um valor opaco.

Hora Solicitada
routes.requested_time string

Contém o parâmetro 'tempo' usado como uma restrição de tempo de partida ou chegada ao obter direções, se aplicável.

Tipo de Hora Solicitada
routes.requested_time_type string

Contém o parâmetro 'time_type' usado para determinar como o 'tempo' será usado para restringir as direções que são retornadas, se aplicável. Se nenhum parâmetro foi fornecido na solicitação, retornará o 'time_type' usado por padrão para planejar a rota.

Linguagem
language string

UMA MARCA DE IDIOMA IETF BCP 47 que indica o idioma usado para codificar conteúdo localizável, como instruções de viragem, nesta resposta. Isso refletirá uma tentativa de melhor esforço para atender a qualquer preferência de idioma expressa pelo parâmetro de solicitação 'idioma', ou 'en-US' como padrão.