Citymapper (Editor Independente) (versão prévia)
O Citymapper permite que você adicione o planejamento de percurso e a navegação turn-by-turn aos seus produtos. Nossos serviços são alimentados por nossos dados de transporte globais líderes do setor e algoritmos de roteamento personalizados treinados em bilhões de viagens.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://citymapper.com/ |
| Política de privacidade | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| Categorias | Estilo de vida e entretenimento |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Obter direções de patinete eletrônico contratados entre dois pontos |
Obtém uma rota de patinete eletrônico contratado entre dois pontos, incluindo qualquer caminhada inicial e final. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esses resultados são otimizados para patinetes pequenos movidos a bateria em que o piloto está. Essa 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'. O Citymapper pressupõe que o usuário esteja no ponto de "início" e escolha uma scooter da Marca especificada, se possível. Usar uma scooter em um local especificado Adicionando 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeja uma rota que pressupõe que a scooter esteja no local determinado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclui o redirecionamento do local atual do usuário se ele tiver divergido da Rota planejada, o chamador poderá adicionar as propriedades 'current_location' e 'ride_state', o que indica qual parte da rota resultante deve ser redirecionada em torno do 'current_location' do usuário. |
| Obter informações de disponibilidade e saída ao vivo para várias rotas |
Isso recupera informações de saída atuais e ao vivo e aspas ao vivo sob demanda para várias rotas obtidas anteriormente dos pontos de extremidade "directions". Somente as rotas que têm pelo menos uma perna com um detalhe atualizável de perna podem ser atualizadas usando esse serviço. Observe que nem sempre pode ser possível para o Citymapper fornecer horários atuais ou informações de partida ao vivo e interrupção para uma perna. Respostas bem-sucedidas (código HTTP '200') consumirão um crédito 'Live Update' para cada resposta HTTP. Chamadas malsucedidas não consumirão créditos. |
| Obter tempos de viagem entre dois locais |
Determina o tempo de viagem em vários modos de viagem entre os dois pontos determinados no momento em que a solicitação é feita. |
| Obter trajetos de patinete 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. (Esses resultados são otimizados para patinetes pequenos movidos a bateria em que o piloto está.) Essa chamada pressupõe que o piloto tenha uma scooter no ponto de "início" e forneça uma rota de e-scooter de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de scooter, embora a propriedade "path_annotations" da perna possa indicar seções durante as quais o usuário deve andar ao lado da scooter. Essa chamada não incorpora nenhuma informação sobre a cobertura ou áreas de estacionamento dos operadores de scooter, mas outras chamadas de serviço podem estar disponíveis para fazer isso. As respostas bem-sucedidas (código HTTP '200') consumirão um crédito 'Scooter Route' (ou um crédito 'Scooter Reroute' se 'reroute_signature' for usado) para cada resposta HTTP. Chamadas malsucedidas não consumirão créditos. |
| Obter uma rota de bicicleta contratada entre dois pontos |
Obtém uma rota de bicicleta contratada entre dois pontos, incluindo qualquer caminhada inicial e final. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Essa 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'. O Citymapper pressupõe que o usuário esteja no ponto de "início" e escolha uma bicicleta da Marca especificada, se possível. Usar uma bicicleta em um local especificado Adicionando 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeja uma rota que pressupõe que a bicicleta esteja no local determinado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclui o redirecionamento do local atual do usuário se ele tiver divergido da Rota planejada, o chamador poderá adicionar as propriedades 'current_location' e 'ride_state', o que indica qual parte da rota resultante deve ser redirecionada em torno do 'current_location' do usuário. |
| 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 piloto tenha uma bicicleta no ponto de "início" e forneça uma rota de bicicleta de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de bicicleta, embora a propriedade "path_annotations" da perna possa indicar seções durante as quais o usuário deve andar ao lado da bicicleta. Essa chamada não incorpora nenhuma informação sobre a cobertura ou áreas de estacionamento dos operadores de bicicleta, mas outras chamadas de serviço podem estar disponíveis para fazer isso. A distância máxima entre o início e o final é limitada a 200km para esse serviço. |
| Obter uma rota de caminhada entre dois pontos |
Obtém uma rota de caminhada entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Espera-se que as rotas a pé tenham uma única perna com uma "travel_mode" de "caminhada". Se o Citymapper não conseguir calcular as direções de caminhada para esses pontos (geralmente por motivos de cobertura), o serviço retornará uma resposta de código '400'. A distância máxima de círculo grande entre 'start' e 'end' é limitada a 100km para esse serviço. |
| Obter 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 piloto tem um carro no ponto de "início" e fornece uma rota de carro de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de carro. A distância máxima de grande círculo entre o início e o final é limitada a 1000km para este serviço. |
| Obter uma rota de scooter de motor contratado entre dois pontos |
Obtém uma rota de scooter de motor contratado entre dois pontos, incluindo qualquer caminhada inicial e final. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Esses resultados são otimizados para maiores patinetes elétricos ou de combustão interna em que o piloto está sentado.) NOTA: A rota resultante atualmente pressupõe que o usuário possa ir diretamente para o local "final" especificado, não levando em conta nenhuma zona de estacionamento ou cobertura. Assim, a rota resultante conterá apenas uma etapa inicial de 'travel_mode' 'walk' e uma segunda etapa de 'travel_mode' 'self_piloted'. Uma atualização futura incorporará zonas de estacionamento e cobertura e adicionará uma etapa final de "caminhada". Essa 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'. O Citymapper pressupõe que o usuário esteja no ponto de "início" e escolha uma scooter da Marca especificada, se possível. Usar uma scooter em um local especificado Adicionando 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeja uma rota que pressupõe que a scooter esteja no local determinado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclui o redirecionamento do local atual do usuário se ele tiver divergido da Rota planejada, o chamador poderá adicionar as propriedades 'current_location' e 'ride_state', o que indica qual parte da rota resultante deve ser redirecionada em torno do 'current_location' do usuário. |
| Obter uma rota de scooter motor 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. (Esses resultados são otimizados para maiores patinetes elétricos ou de combustão interna em que o piloto está sentado.) Essa chamada pressupõe que o piloto tenha uma scooter no ponto de "início" e forneça uma rota de e-scooter de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de scooter, embora a propriedade "path_annotations" da perna possa indicar seções durante as quais o usuário deve andar ao lado da scooter. Essa chamada não incorpora nenhuma informação sobre a cobertura ou áreas de estacionamento dos operadores de scooter, mas outras chamadas de serviço podem estar disponíveis para fazer isso. |
| Obter 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 uma conterá várias pernas: geralmente uma no início e no final da rota com "travel_mode" de "caminhada", com pelo menos uma com "travel_mode" de "trânsito" no meio. |
| Obter 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 poderá conter pernas de caminhada iniciais e finais se os pontos de retirada ou de entrega não estiverem perto das coordenadas de início e término solicitadas. Os serviços na resposta variarão dependendo da disponibilidade local, hora do dia e, além disso, 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 ao vivo sob demanda incluídas antecipadamente chamando 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 dinâmica e chamar imediatamente '1/live/routeupdates' para obter as estimativas dinâmicas adicionais. A primeira abordagem é mais simples, mas a segunda pode se ajustar melhor ao seu caso de uso. |
| 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 rota conterá uma ou mais pernas. |
Obter direções de patinete eletrônico contratados entre dois pontos
Obtém uma rota de patinete eletrônico contratado entre dois pontos, incluindo qualquer caminhada inicial e final. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Esses resultados são otimizados para patinetes pequenos movidos a bateria em que o piloto está. Essa 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'. O Citymapper pressupõe que o usuário esteja no ponto de "início" e escolha uma scooter da Marca especificada, se possível. Usar uma scooter em um local especificado Adicionando 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeja uma rota que pressupõe que a scooter esteja no local determinado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclui o redirecionamento do local atual do usuário se ele tiver divergido da Rota planejada, o chamador poderá adicionar as propriedades 'current_location' e 'ride_state', o que indica qual parte da rota resultante deve ser redirecionada em torno do 'current_location' do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
ID da marca
|
brand_id | True | string |
A ID da marca de patinetes eletrônicos a ser usada para essa rota. Isso é necessário para determinar a localização das patinetes disponíveis, juntamente com quaisquer restrições de cobertura e estacionamento associadas. |
|
Estado
|
ride_state | string |
Indica onde, ao longo da rota, o usuário está. Se omitido, 'walking_to_vehicle' será usado. Essa propriedade juntamente com "current_location" permite a recuperação de uma rota atualizada que reflete o progresso atual do usuário por meio dela. | value | description | | ----- | ----------- | | walking_to_vehicle | Indica que o usuário está caminhando para coletar o veículo | | cavalgando | Indica que o usuário está andando no veículo | | walking_to_end | Indica que o usuário deixou o veículo e está caminhando para seu destino | |
|
|
Local atual
|
current_location | string |
O local atual do usuário, a fim de atualizar a rota com base na localização do usuário. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Esse parâmetro é usado para obter uma rota atualizada que reflita 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 etapa da rota conterá esse local é decidida pelo valor do parâmetro 'ride_state'. |
|
|
Local de início
|
ride_start_location | string |
A localização do veículo a ser usado, no início do passeio do veículo, parte da viagem do usuário ao longo da Rota. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Isso deve ser fornecido quando 'ride_state' é 'riding' ou 'walking_to_end'. Se não for fornecido quando 'ride_state' for 'walking_to_vehicle' (ou não especificado), o Citymapper tentará encontrar o veículo mais apropriado que pertence ao 'brand_id' especificado. Para compatibilidade, 'original_vehicle_location' é um alias para esse parâmetro |
|
|
Local de término
|
ride_end_location | string |
O local em que o veículo foi deixado no final do passeio do veículo parte da viagem do usuário ao longo da Rota. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Isso 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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
|
|
Redirecionar Assinatura
|
reroute_signature | string |
Ao redirecionar (solicitando uma atualização para uma resposta anterior que conta para 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 em URL. Ao fornecer esse parâmetro, o local 'current_location' (quando aplicável) ou 'start' deve ser definido como o local mais recente do usuário. Quando esse parâmetro é incluído, o Citymapper pode não retornar resultados em casos em que a solicitação difere significativamente do original, por exemplo, se o local 'end' for diferente ou se mais de 1 hora tiver passado desde a solicitação original. |
|
|
Iniciar rolamento
|
start_bearing | integer |
Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Esse rolamento é usado para influenciar o texto de instrução inicial e/ou o roteamento, geralmente para evitar que o usuário seja solicitado a fazer um retorno, se continuar em seu rolamento atual fornecer uma rota comparável. Isso só deve ser fornecido se você quiser influenciar a direção inicial da viagem para a rota. |
|
|
Locais Passados
|
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írgulas. As coordenadas devem estar no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente os seis primeiros dígitos de precisão serão usados. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Idades de localização anteriores
|
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írgulas. As idades devem estar em segundos inteiros desde o local atual. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_coords' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Precisões de localização anteriores
|
past_loc_accuracies | string |
Parâmetro opcional para melhorar o comportamento de redirecionamento. As Precisões de GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgulas. As precisões devem estar em medidores inteiros. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_coords' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter informações de disponibilidade e saída ao vivo para várias rotas
Isso recupera informações de saída atuais e ao vivo e aspas ao vivo sob demanda para várias rotas obtidas anteriormente dos pontos de extremidade "directions". Somente as rotas que têm pelo menos uma perna com um detalhe atualizável de perna podem ser atualizadas usando esse serviço. Observe que nem sempre pode ser possível para o Citymapper fornecer horários atuais ou informações de partida ao vivo e interrupção para uma perna. Respostas bem-sucedidas (código HTTP '200') consumirão um crédito 'Live Update' para cada resposta HTTP. Chamadas malsucedidas não consumirão créditos.
Parâmetros
| Nome | Chave | Obrigató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 contêm pernas sob demanda com detalhes atualizáveis (por exemplo, do serviço Taxi Directions), se isso for definido como "true", informações adicionais serão solicitadas das intrgrações do serviço taxi para fornecer preços, duração e disponibilidade de 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. Lembre-se de que talvez seja necessário ter o consentimento informado explícito do usuário final para defini-lo como "true", dependendo das leis e regulamentos aplicáveis. Se definido como 'false' ou omitido, nenhuma solicitação será feita a nenhum serviço de terceiros. Se nenhuma atualização puder ser produzida para uma perna sem que esse parâmetro seja definido como 'true', a resposta indicará isso nos detalhes atualizáveis. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
Atualizações de pernas
|
route_updates.leg_updates | array of |
Esta é uma matriz paralela de objetos Updatable Detail de perna, um para cada etapa na rota original que está sendo atualizada. Os correspondentes às pernas a pé estarão vazios, mas os detalhes correspondentes às pernas de trânsito conterão informações de partida atualizadas. |
|
Hora de Partida
|
route_updates.route_departure_time | string |
A hora em que o Citymapper acha que o usuário definirá nesta 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 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 |
O momento em que o Citymapper acha que o usuário 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 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 estimado geral para percorrer toda a rota, em segundos. Esse valor substitui o valor 'duration_seconds' da Rota original, pois ele será recomputado para usar as informações de saída específicas contidas nesta resposta de atualização de rota. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada, 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 |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Solicitação de Assinatura
|
route_updates.request_signature | string |
Essa é uma "assinatura" de rota da solicitação de atualização, que deve ser usada para associar essa atualização à Rota correta. |
Obter tempos de viagem entre dois locais
Determina o tempo de viagem em vários modos de viagem entre os dois pontos determinados no momento em que a solicitação é feita.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | string |
O ponto de partida geográfico da viagem, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. |
|
participante
|
end | True | string |
O ponto de extremidade geográfico da viagem, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros 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). | value | propriedade response | description | | ----- | ----------------- | ------------| | caminhada | walk_travel_time_minutes | Caminhando | | trânsito | transit_time_minutes | Viagem de transporte público | | bicicleta | bike_time_minutes | Viagem de bicicleta (andar por todo o caminho) | | scooter | scooter_time_minutes | Viagem de patinete em pé (andando por todo o caminho) | | motorscooter | motorscooter_time_minutes | Viagem de motoneta sentada (andando por todo o caminho) | | carro | car_time_minutes | Viagem de carro (andando por todo o caminho). Disponível somente em planos empresariais | Quando esse campo for omitido ou vazio, um valor padrão de 'walk,transit' será usado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tempo de Caminhada
|
walk_travel_time_minutes | integer |
Tempo estimado de caminhada entre os dois pontos determinados em minutos. |
|
Tempo de Trânsito
|
transit_time_minutes | integer |
Tempo estimado de viagem de transporte público entre os dois pontos determinados em minutos. |
|
Tempo de Bicicleta
|
bike_time_minutes | integer |
Tempo estimado de viagem de bicicleta entre dois pontos em minutos. |
|
Hora da Scooter
|
scooter_time_minutes | integer |
Tempo estimado de viagem de patinete eletrônico entre dois pontos em minutos. |
|
Hora do Motorscooter
|
motorscooter_time_minutes | integer |
Tempo estimado de viagem de scooter entre dois pontos em minutos. |
|
Tempo de Unidade
|
car_time_minutes | integer |
Tempo estimado de viagem de carro entre dois pontos em minutos. |
Obter trajetos de patinete 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. (Esses resultados são otimizados para patinetes pequenos movidos a bateria em que o piloto está.) Essa chamada pressupõe que o piloto tenha uma scooter no ponto de "início" e forneça uma rota de e-scooter de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de scooter, embora a propriedade "path_annotations" da perna possa indicar seções durante as quais o usuário deve andar ao lado da scooter. Essa chamada não incorpora nenhuma informação sobre a cobertura ou áreas de estacionamento dos operadores de scooter, mas outras chamadas de serviço podem estar disponíveis para fazer isso. As respostas bem-sucedidas (código HTTP '200') consumirão um crédito 'Scooter Route' (ou um crédito 'Scooter Reroute' se 'reroute_signature' for usado) para cada resposta HTTP. Chamadas malsucedidas não consumirão créditos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras 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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
|
|
Redirecionar Assinatura
|
reroute_signature | string |
Ao redirecionar (solicitando uma atualização para uma resposta anterior que conta para 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 em URL. Ao fornecer esse parâmetro, o local 'current_location' (quando aplicável) ou 'start' deve ser definido como o local mais recente do usuário. Quando esse parâmetro é incluído, o Citymapper pode não retornar resultados em casos em que a solicitação difere significativamente do original, por exemplo, se o local 'end' for diferente ou se mais de 1 hora tiver passado desde a solicitação original. |
|
|
Iniciar rolamento
|
start_bearing | integer |
Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Esse rolamento é usado para influenciar o texto de instrução inicial e/ou o roteamento, geralmente para evitar que o usuário seja solicitado a fazer um retorno, se continuar em seu rolamento atual fornecer uma rota comparável. Isso só deve ser fornecido se você quiser influenciar a direção inicial da viagem para a rota. |
|
|
Locais Passados
|
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írgulas. As coordenadas devem estar no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente os seis primeiros dígitos de precisão serão usados. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Idades de localização anteriores
|
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írgulas. As idades devem estar em segundos inteiros desde o local atual. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_coords' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Precisões de localização anteriores
|
past_loc_accuracies | string |
Parâmetro opcional para melhorar o comportamento de redirecionamento. As Precisões de GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgulas. As precisões devem estar em medidores inteiros. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_coords' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter uma rota de bicicleta contratada entre dois pontos
Obtém uma rota de bicicleta contratada entre dois pontos, incluindo qualquer caminhada inicial e final. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Essa 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'. O Citymapper pressupõe que o usuário esteja no ponto de "início" e escolha uma bicicleta da Marca especificada, se possível. Usar uma bicicleta em um local especificado Adicionando 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeja uma rota que pressupõe que a bicicleta esteja no local determinado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclui o redirecionamento do local atual do usuário se ele tiver divergido da Rota planejada, o chamador poderá adicionar as propriedades 'current_location' e 'ride_state', o que indica qual parte da rota resultante deve ser redirecionada em torno do 'current_location' do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
ID da marca
|
brand_id | True | string |
A ID da marca de bicicleta a ser usada para essa rota. Isso é necessário para determinar o local das bicicletas disponíveis, juntamente com quaisquer restrições de cobertura e estacionamento associadas. |
|
Estado
|
ride_state | string |
Indica onde, ao longo da rota, o usuário está. Se omitido, 'walking_to_vehicle' será usado. Essa propriedade juntamente com "current_location" permite a recuperação de uma rota atualizada que reflete o progresso atual do usuário por meio dela. | value | description | | ----- | ----------- | | walking_to_vehicle | Indica que o usuário está caminhando para coletar o veículo | | cavalgando | Indica que o usuário está andando no veículo | | walking_to_end | Indica que o usuário deixou o veículo e está caminhando para seu destino | |
|
|
Local atual
|
current_location | string |
O local atual do usuário, a fim de atualizar a rota com base na localização do usuário. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Esse parâmetro é usado para obter uma rota atualizada que reflita 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 etapa da rota conterá esse local é decidida pelo valor do parâmetro 'ride_state'. |
|
|
Local de início
|
ride_start_location | string |
A localização do veículo a ser usado, no início do passeio do veículo, parte da viagem do usuário ao longo da Rota. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Isso deve ser fornecido quando 'ride_state' é 'riding' ou 'walking_to_end'. Se não for fornecido quando 'ride_state' for 'walking_to_vehicle' (ou não especificado), o Citymapper tentará encontrar o veículo mais apropriado que pertence ao 'brand_id' especificado. Para compatibilidade, 'original_vehicle_location' é um alias para esse parâmetro |
|
|
Local de término
|
ride_end_location | string |
O local em que o veículo foi deixado no final do passeio do veículo parte da viagem do usuário ao longo da Rota. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Isso deve ser fornecido quando 'ride_state' é 'walking_to_end'. Em todos os outros estados, esse parâmetro é ignorado. |
|
|
Profiles
|
profiles | string |
Indica quais "perfis" usar ao calcular as 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 ideal em mais de uma maneira), e um perfil pode nem sempre produzir uma Rota. | value | description | | ----- | ----------- | | quiet | Tentativas de usar estradas com menos tráfego | | regular | O perfil padrão equilibra o tráfego com a direção | | rápido | Tenta encontrar a rota sensata mais curta | Se nenhum perfil for especificado, "regular" será usado. |
|
|
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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
|
|
Redirecionar Assinatura
|
reroute_signature | string |
Ao redirecionar (solicitando uma atualização para uma resposta anterior que conta para 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 em URL. Ao fornecer esse parâmetro, o local 'current_location' (quando aplicável) ou 'start' deve ser definido como o local mais recente do usuário. Quando esse parâmetro é incluído, o Citymapper pode não retornar resultados em casos em que a solicitação difere significativamente do original, por exemplo, se o local 'end' for diferente ou se mais de 1 hora tiver passado desde a solicitação original. |
|
|
Iniciar rolamento
|
start_bearing | integer |
Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Esse rolamento é usado para influenciar o texto de instrução inicial e/ou o roteamento, geralmente para evitar que o usuário seja solicitado a fazer um retorno, se continuar em seu rolamento atual fornecer uma rota comparável. Isso só deve ser fornecido se você quiser influenciar a direção inicial da viagem para a rota. |
|
|
Locais Passados
|
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írgulas. As coordenadas devem estar no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente os seis primeiros dígitos de precisão serão usados. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Idades de localização anteriores
|
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írgulas. As idades devem estar em segundos inteiros desde o local atual. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_coords' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Precisões de localização anteriores
|
past_loc_accuracies | string |
Parâmetro opcional para melhorar o comportamento de redirecionamento. As Precisões de GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgulas. As precisões devem estar em medidores inteiros. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_coords' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' 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 piloto tenha uma bicicleta no ponto de "início" e forneça uma rota de bicicleta de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de bicicleta, embora a propriedade "path_annotations" da perna possa indicar seções durante as quais o usuário deve andar ao lado da bicicleta. Essa chamada não incorpora nenhuma informação sobre a cobertura ou áreas de estacionamento dos operadores de bicicleta, mas outras chamadas de serviço podem estar disponíveis para fazer isso. A distância máxima entre o início e o final é limitada a 200km para esse serviço.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
Profiles
|
profiles | string |
Indica quais "perfis" usar ao calcular as 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 ideal em mais de uma maneira), e um perfil pode nem sempre produzir uma Rota. | value | description | | ----- | ----------- | | quiet | Tentativas de usar estradas com menos tráfego | | regular | O perfil padrão equilibra o tráfego com a direção | | rápido | Tenta encontrar a rota sensata mais curta | Se nenhum perfil for especificado, "regular" será usado. |
|
|
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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
|
|
Redirecionar Assinatura
|
reroute_signature | string |
Ao redirecionar (solicitando uma atualização para uma resposta anterior que conta para 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 em URL. Ao fornecer esse parâmetro, o local 'current_location' (quando aplicável) ou 'start' deve ser definido como o local mais recente do usuário. Quando esse parâmetro é incluído, o Citymapper pode não retornar resultados em casos em que a solicitação difere significativamente do original, por exemplo, se o local 'end' for diferente ou se mais de 1 hora tiver passado desde a solicitação original. |
|
|
Iniciar rolamento
|
start_bearing | integer |
Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Esse rolamento é usado para influenciar o texto de instrução inicial e/ou o roteamento, geralmente para evitar que o usuário seja solicitado a fazer um retorno, se continuar em seu rolamento atual fornecer uma rota comparável. Isso só deve ser fornecido se você quiser influenciar a direção inicial da viagem para a rota. |
|
|
Locais Passados
|
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írgulas. As coordenadas devem estar no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente os seis primeiros dígitos de precisão serão usados. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Idades de localização anteriores
|
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írgulas. As idades devem estar em segundos inteiros desde o local atual. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_coords' e 'past_loc_accuracies' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
|
|
Precisões de localização anteriores
|
past_loc_accuracies | string |
Parâmetro opcional para melhorar o comportamento de redirecionamento. As Precisões de GPS de até 10 dos locais anteriores do usuário como uma lista separada por vírgulas. As precisões devem estar em medidores inteiros. Deve ser ordenado cronologicamente, o último mais recente. 'past_loc_ages' e 'past_loc_coords' devem ser fornecidos junto. O servidor considerará apenas 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 locais com mais de 30 segundos ou qualquer um com menos de 1 segundo de diferença. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter uma rota de caminhada entre dois pontos
Obtém uma rota de caminhada entre dois pontos, fornecendo informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. Espera-se que as rotas a pé tenham uma única perna com uma "travel_mode" de "caminhada". Se o Citymapper não conseguir calcular as direções de caminhada para esses pontos (geralmente por motivos de cobertura), o serviço retornará uma resposta de código '400'. A distância máxima de círculo grande entre 'start' e 'end' é limitada a 100km para esse serviço.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras 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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado 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 ideal 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 de início e término. Perfis indisponíveis serão omitidos da resposta. | value | description | | ----- | ----------- | | rápido | O perfil padrão tenta encontrar a rota sensata mais rápida | | main_roads | Tentativas de evitar backstreets e parques | Se nenhum perfil for especificado, "rápido" será usado. |
|
|
Redirecionar Assinatura
|
reroute_signature | string |
Ao redirecionar (solicitando uma atualização para uma resposta anterior que conta para 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 em URL. Ao fornecer esse parâmetro, o local 'current_location' (quando aplicável) ou 'start' deve ser definido como o local mais recente do usuário. Quando esse parâmetro é incluído, o Citymapper pode não retornar resultados em casos em que a solicitação difere significativamente do original, por exemplo, se o local 'end' for diferente ou se mais de 1 hora tiver passado desde a solicitação original. |
|
|
Iniciar rolamento
|
start_bearing | integer |
Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Esse rolamento é usado para influenciar o texto de instrução inicial e/ou o roteamento, geralmente para evitar que o usuário seja solicitado a fazer um retorno, se continuar em seu rolamento atual fornecer uma rota comparável. Isso só deve ser fornecido se você quiser influenciar a direção inicial da viagem para a rota. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter 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 piloto tem um carro no ponto de "início" e fornece uma rota de carro de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de carro. A distância máxima de grande círculo entre o início e o final é limitada a 1000km para este serviço.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras 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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter uma rota de scooter de motor contratado entre dois pontos
Obtém uma rota de scooter de motor contratado entre dois pontos, incluindo qualquer caminhada inicial e final. A rota resultante fornece informações suficientes para renderizá-la em um mapa, juntamente com uma estimativa de duração. (Esses resultados são otimizados para maiores patinetes elétricos ou de combustão interna em que o piloto está sentado.) NOTA: A rota resultante atualmente pressupõe que o usuário possa ir diretamente para o local "final" especificado, não levando em conta nenhuma zona de estacionamento ou cobertura. Assim, a rota resultante conterá apenas uma etapa inicial de 'travel_mode' 'walk' e uma segunda etapa de 'travel_mode' 'self_piloted'. Uma atualização futura incorporará zonas de estacionamento e cobertura e adicionará uma etapa final de "caminhada". Essa 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'. O Citymapper pressupõe que o usuário esteja no ponto de "início" e escolha uma scooter da Marca especificada, se possível. Usar uma scooter em um local especificado Adicionando 'original_vehicle_location' a 'start', 'end' e 'brand_id', o Citymapper planeja uma rota que pressupõe que a scooter esteja no local determinado. Atualizar uma rota em andamento Para recuperar uma rota atualizada que inclui o redirecionamento do local atual do usuário se ele tiver divergido da Rota planejada, o chamador poderá adicionar as propriedades 'current_location' e 'ride_state', o que indica qual parte da rota resultante deve ser redirecionada em torno do 'current_location' do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
ID da marca
|
brand_id | True | string |
A ID da marca de patinetes a ser usada para essa rota. Isso é necessário para determinar a localização das patinetes disponíveis, juntamente com quaisquer restrições de cobertura e estacionamento associadas. |
|
Estado
|
ride_state | string |
Indica onde, ao longo da rota, o usuário está. Se omitido, 'walking_to_vehicle' será usado. Essa propriedade juntamente com "current_location" permite a recuperação de uma rota atualizada que reflete o progresso atual do usuário por meio dela. | value | description | | ----- | ----------- | | walking_to_vehicle | Indica que o usuário está caminhando para coletar o veículo | | cavalgando | Indica que o usuário está andando no veículo | | walking_to_end | Indica que o usuário deixou o veículo e está caminhando para seu destino | |
|
|
Local atual
|
current_location | string |
O local atual do usuário, a fim de atualizar a rota com base na localização do usuário. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Esse parâmetro é usado para obter uma rota atualizada que reflita 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 etapa da rota conterá esse local é decidida pelo valor do parâmetro 'ride_state'. |
|
|
Local de início
|
ride_start_location | string |
A localização do veículo a ser usado, no início do passeio do veículo, parte da viagem do usuário ao longo da Rota. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Isso deve ser fornecido quando 'ride_state' é 'riding' ou 'walking_to_end'. Se não for fornecido quando 'ride_state' for 'walking_to_vehicle' (ou não especificado), o Citymapper tentará encontrar o veículo mais apropriado que pertence ao 'brand_id' especificado. Para compatibilidade, 'original_vehicle_location' é um alias para esse parâmetro |
|
|
Local de término
|
ride_end_location | string |
O local em que o veículo foi deixado no final do passeio do veículo parte da viagem do usuário ao longo da Rota. Fornecido no formato 'latitude,longitude' do WGS84. As coordenadas devem estar em decimal e somente os seis primeiros dígitos de precisão serão usados. Isso 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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
|
|
Redirecionar Assinatura
|
reroute_signature | string |
Ao redirecionar (solicitando uma atualização para uma resposta anterior que conta para 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 em URL. Ao fornecer esse parâmetro, o local 'current_location' (quando aplicável) ou 'start' deve ser definido como o local mais recente do usuário. Quando esse parâmetro é incluído, o Citymapper pode não retornar resultados em casos em que a solicitação difere significativamente do original, por exemplo, se o local 'end' for diferente ou se mais de 1 hora tiver passado desde a solicitação original. |
|
|
Iniciar rolamento
|
start_bearing | integer |
Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Esse rolamento é usado para influenciar o texto de instrução inicial e/ou o roteamento, geralmente para evitar que o usuário seja solicitado a fazer um retorno, se continuar em seu rolamento atual fornecer uma rota comparável. Isso só deve ser fornecido se você quiser influenciar a direção inicial da viagem para a rota. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter uma rota de scooter motor 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. (Esses resultados são otimizados para maiores patinetes elétricos ou de combustão interna em que o piloto está sentado.) Essa chamada pressupõe que o piloto tenha uma scooter no ponto de "início" e forneça uma rota de e-scooter de lá até o ponto "final" se ambos estiverem dentro das áreas com suporte da Citymapper. A rota resultante deve conter uma única perna de scooter, embora a propriedade "path_annotations" da perna possa indicar seções durante as quais o usuário deve andar ao lado da scooter. Essa chamada não incorpora nenhuma informação sobre a cobertura ou áreas de estacionamento dos operadores de scooter, mas outras chamadas de serviço podem estar disponíveis para fazer isso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras 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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
|
|
Redirecionar Assinatura
|
reroute_signature | string |
Ao redirecionar (solicitando uma atualização para uma resposta anterior que conta para 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 em URL. Ao fornecer esse parâmetro, o local 'current_location' (quando aplicável) ou 'start' deve ser definido como o local mais recente do usuário. Quando esse parâmetro é incluído, o Citymapper pode não retornar resultados em casos em que a solicitação difere significativamente do original, por exemplo, se o local 'end' for diferente ou se mais de 1 hora tiver passado desde a solicitação original. |
|
|
Iniciar rolamento
|
start_bearing | integer |
Um ângulo no sentido horário do Norte entre 0 e 359, onde Norte é 0 e Leste é 90. Esse rolamento é usado para influenciar o texto de instrução inicial e/ou o roteamento, geralmente para evitar que o usuário seja solicitado a fazer um retorno, se continuar em seu rolamento atual fornecer uma rota comparável. Isso só deve ser fornecido se você quiser influenciar a direção inicial da viagem para a rota. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter 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 uma conterá várias pernas: geralmente uma no início e no final da rota com "travel_mode" de "caminhada", com pelo menos uma com "travel_mode" de "trânsito" no meio.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
Hora
|
time | string |
O tempo a ser usado como uma restrição de hora de partida ou de chegada ao obter instruçõ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 hora
|
time_type | string |
Quando um valor "time" é fornecido, isso determina como o tempo será usado para restringir as direções retornadas. Quando isso não é especificado, 'depart_approximate' é usado. Se nenhum "tempo" for dado, isso não terá efeito. | value | description | | ----- | ----------- | | chegar | As instruções são escolhidas para levar o usuário ao seu destino em ou antes de 'time' | | depart | As instruções são escolhidas supondo que o usuário deixe sua origem assim que for possível após a 'hora' | | depart_approximate | Semelhante a "depart", mas permitindo saídas posteriores para retornar opções mais preferíveis, mesmo que saiam um pouco mais tarde. Essa é a maneira padrão do Citymapper de escolher as direções quando a hora não for especificada | |
|
|
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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
|
|
Limit
|
limit | integer |
Número máximo de rotas a serem retornadas. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |
Obter 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 poderá conter pernas de caminhada iniciais e finais se os pontos de retirada ou de entrega não estiverem perto das coordenadas de início e término solicitadas. Os serviços na resposta variarão dependendo da disponibilidade local, hora do dia e, além disso, 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 ao vivo sob demanda incluídas antecipadamente chamando 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 dinâmica e chamar imediatamente '1/live/routeupdates' para obter as estimativas dinâmicas adicionais. A primeira abordagem é mais simples, mas a segunda pode se ajustar melhor ao seu caso de uso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras 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 de suas integrações de serviço de táxi para fornecer preços mais precisos e completos, duração e disponibilidade de serviço, retornados nos detalhes atualizáveis da etapa 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. Lembre-se de que talvez seja necessário ter o consentimento informado explícito do usuário final para defini-lo como "true", dependendo das leis e regulamentos aplicáveis. Se definido como 'false' ou omitido, nenhuma solicitação será feita a nenhum serviço de terceiros. |
|
|
IDs de marca
|
brand_ids | array |
Lista separada por vírgulas de IDs de Marca para a qual limitar essa solicitação de direção. Se omitido (padrão), todas as marcas disponíveis para você terão uma rota taxi 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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' 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 rota conterá uma ou mais pernas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do cenário
|
scenario_id | True | string |
ID do cenário para instruções. |
|
Start
|
start | True | array |
O início geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
participante
|
end | True | array |
O final geográfico da rota, no formato "latitude, longitude" do WGS84. As coordenadas devem estar em decimais e somente as seis primeiras casas decimais serão usadas. |
|
Hora
|
time | string |
O tempo a ser usado como uma restrição de hora de partida ou de chegada ao obter instruçõ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 hora
|
time_type | string |
Quando um valor "time" é fornecido, isso determina como o tempo será usado para restringir as direções retornadas. Quando isso não é especificado, 'depart_approximate' é usado. Se nenhum "tempo" for dado, isso não terá efeito. | value | description | | ----- | ----------- | | chegar | As instruções são escolhidas para levar o usuário ao seu destino em ou antes de 'time' | | depart | As instruções são escolhidas supondo que o usuário deixe sua origem assim que for possível após a 'hora' | | depart_approximate | Semelhante a "depart", mas permitindo saídas posteriores para retornar opções mais preferíveis, mesmo que saiam um pouco mais tarde. Essa é a maneira padrão do Citymapper de escolher as direções quando a hora não for especificada | |
|
|
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 ativação). Essa linguagem será uma tentativa de melhor esforço para atender à 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 ativação. Conteúdo externo, como nomes de parada e descrições de status, geralmente será passado em seu idioma original. |
Retornos
| Nome | 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 medidores
|
routes.distance_meters | integer |
A distância geral de toda a Rota, em metros. |
|
Duração
|
routes.duration_seconds | integer |
O tempo estimado geral para percorrer toda a Rota, em segundos, com base no veículo selecionado ou na partida na resposta. |
|
Precisão de duração
|
routes.duration_accuracy | string |
A avaliação do Citymapper sobre como o nível de precisão de 'duration_seconds' deve ser exibido para o usuário. Isso é em grande parte baseado no "tipo" das Partidas usadas para horários, mas envolve heurística adicional desenvolvida ao longo do tempo para o aplicativo Citymapper. Quando esse campo não for fornecido, o valor 'agendado' deverá ser usado. | value | description | | ----- | ----------- | | estimado | Uma duração que deve ser considerada aproximada, pois seu cálculo envolveu mais incerteza do que o normal. Essa é a menor precisão. | | agendado | Uma duração normal, normalmente com base nas informações de cronograma publicadas. | | live | Uma duração em grande parte baseada em informações de partida em tempo real/ao vivo. Essa é a precisão mais alta. | |
|
Formatado
|
routes.price.formatted | string |
O preço especificado como uma cadeia de caracteres formatada. Por padrão, isso está no formato de moeda nativa da região onde a rota ocorre. |
|
Quantidade
|
routes.price.amount | string |
O preço como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Intervalo mínimo de quantidade
|
routes.price.amount_range_minimum | string |
Se esse 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 ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. |
|
Máximo do intervalo de quantidade
|
routes.price.amount_range_maximum | string |
Se esse Preço representar um intervalo de valores possíveis, o preço máximo como um valor decimal, codificado como uma cadeia de caracteres para evitar problemas de precisão de ponto flutuante. Ele não incluirá símbolos de moeda e o separador entre unidades principais e secundárias sempre será '.', independentemente da região. Isso pode não ser incluído se o intervalo for aberto |
|
Moeda
|
routes.price.currency | string |
A moeda na qual o preço é dado, na forma ISO 4217 de três letras. |
|
Multiplicador de Demanda
|
routes.price.demand_multipler | float |
Indica que os preços são mais altos do que o normal por causa da demanda, geralmente para pernas taxi (sob demanda). Em casos raros, pode ser menor que 1,0 |
|
Emissões de CO2e
|
routes.emissions_grams_co2e | float |
Uma estimativa das emissões de gases de efeito estufa da rota, expressa em gramas de CO2e (equivalente a dióxido de carbono). |
|
Perna
|
routes.legs | array of object |
Matriz de pernas que compreende a Rota, na ordem em que elas devem ser percorrida. 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 essa perna, excluindo qualquer tempo de espera ou de embarque no início. Pode ser omitido em circunstâncias raras quando a duração não pode ser computada. |
|
Caminho
|
routes.legs.path | string |
O caminho geográfico que a perna atravessa, 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 turno para orientar o usuário pelas pernas em que o usuário precisa navegar, como ao andar 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 no qual a instrução deve ser seguida, portanto, será o local da curva no caminho ou o início ou o final da perna. |
|
Distância
|
routes.legs.instructions.distance_meters | integer |
A distância em metros da seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Hora
|
routes.legs.instructions.time_seconds | integer |
O tempo em segundos que o usuário deve levar para percorrer a seção do "caminho" antes desta instrução. Essa propriedade será omitida para obter instruções iniciais do tipo 'depart'. |
|
Description
|
routes.legs.instructions.description_text | string |
Descrição de texto sem formatação da Instrução para o usuário. |
|
Formato de descrição
|
routes.legs.instructions.description_format | string |
Formato de texto para renderizar a Instrução com elementos enfatizados, em que '{key}' indica uma parte da cadeia de caracteres que deve ser substituída pelo 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 caracteres de chave 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 entre '' e '{}description_format'. |
|
Texto
|
routes.legs.instructions.description_format_replacements.text | string |
O texto a ser usado para substituir a subcadeia de caracteres '{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 identificado por essa substituição de formato. Isso permite que os clientes de serviço apliquem a formatação específica do aplicativo, se desejado. | value | description | | ----- | ----------- | | street_name | O nome de uma rua, estrada ou outro caminho | | exit_number | O número de uma saída, geralmente de uma rotatória | |
|
Linguagem
|
routes.legs.instructions.description_format_replacements.language | string |
Uma marca de idioma IETF BCP 47 que indica em qual idioma o "texto" associado está. Observe que isso pode ser diferente da linguagem da descrição ao redor - isso é mais comum quando a substituição é um nome de lugar 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. |
|
Direção do tipo
|
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 acha que o usuário definirá nesta rota, dadas as informações de partida disponíveis. Isso é calculado supondo que o usuário esteja 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 as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 |
O momento em que o Citymapper acha que o usuário 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. Os valores atualizados para 'route_departure_time' e 'route_arrival_time' são retornados por 'service/1/live/routeupdates' para refletir as informações de saída atualizadas. A hora é expressa no formato ISO 8601 , incluindo 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 em que 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 'profile'. |
|
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 dão suporte à seleção de perfis de roteamento específicos. Esse valor destina-se a ser somente legível por computador. Para que um nome de perfil seja mostrado a um usuário, use o 'profile_name' no objeto 'route_metadata'. |
|
Signature
|
routes.signature | string |
Um valor a ser passado de volta para o servidor em chamadas subsequentes para fazer referência a essa rota (por exemplo, ao solicitar informações de saída ao vivo por meio de 'service/1/live/routeupdates'). Ele deve ser tratado como um valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contém o parâmetro "time" usado como uma restrição de hora de partida ou de chegada ao obter instruções, se aplicável. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contém o parâmetro 'time_type' usado para determinar como a "hora" será usada para restringir as direções retornadas, se aplicável. Se nenhum parâmetro tiver sido dado 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 ativação, 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 'language' ou 'en-US' como padrão. |