Citymapper (Publicador independiente) (versión preliminar)
Citymapper le permite agregar planificación de recorridos y navegación turn-by-turn a sus productos. Nuestros servicios están impulsados por nuestros datos de transporte globales líderes en el sector y algoritmos de enrutamiento personalizados entrenados en miles de millones de viajes.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor |
| Sitio web | https://citymapper.com/ |
| Directiva de privacidad | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| Categorías | Estilo de vida y entretenimiento |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de API | securestring | La clave de API de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Obtención de información de disponibilidad y salida en directo para varias rutas |
Esto recupera la información actual y de salida en directo y las cotizaciones a petición de varias rutas obtenidas previamente de los puntos de conexión "directions". Solo se pueden actualizar las rutas que tengan al menos una pierna con un detalle actualizable de la pierna mediante este servicio. Tenga en cuenta que es posible que no siempre sea posible que Citymapper proporcione las horas actuales o la información de salida y interrupción de una pierna. Las respuestas correctas (código HTTP '200') consumirán un crédito de "Live Update" para cada respuesta HTTP. Las llamadas incorrectas no consumirán ningún crédito. |
| Obtener direcciones de e-scooter contratados entre dos puntos |
Obtiene una ruta de e-scooter alquilada entre dos puntos, incluyendo cualquier recorrido inicial y final. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. Estos resultados están optimizados para pequeños scooters con batería en los que se encuentra el piloto. Esta llamada se puede usar de varias maneras diferentes: use cualquier scooter de la marca especificada Esta es la llamada más sencilla, solo requiere "start", "end" y "brand_id". Citymapper asume que el usuario está en el punto de "inicio" y elige un scooter de la marca especificada, si es posible. Usar un scooter en una ubicación especificada Al agregar "original_vehicle_location" a "start", "end" y "brand_id", Citymapper planea una ruta que supone que el scooter está en la ubicación especificada. Actualización de una ruta en curso Para recuperar una ruta actualizada que incluye la redirección de la ubicación actual del usuario si se ha separado de la ruta planeada, el autor de la llamada puede agregar las propiedades "current_location" y "ride_state", que indica qué parte de la ruta resultante se debe redirigir alrededor de la "current_location" del usuario. |
| Obtener direcciones de e-scooter entre dos puntos |
Obtiene una ruta de scooter entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. (Estos resultados están optimizados para pequeños scooters con batería en los que se encuentra el piloto). En esta llamada se supone que el piloto tiene un scooter en el punto de inicio y proporciona una ruta de e-scooter desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de scooter, aunque la propiedad "path_annotations" de la pierna puede indicar secciones durante las cuales el usuario debe caminar junto al scooter. Esta llamada no incorpora información sobre la cobertura o las zonas de estacionamiento de los operadores de scooter, pero otras llamadas de servicio pueden estar disponibles para hacerlo. Las respuestas correctas (código HTTP '200') consumirán un crédito de "Ruta de scooter" (o un crédito "Scooter Reroute" si se usa "reroute_signature") para cada respuesta HTTP. Las llamadas incorrectas no consumirán ningún crédito. |
| Obtener tiempos de viaje entre dos ubicaciones |
Determina el tiempo de desplazamiento en varios modos de desplazamiento entre los dos puntos especificados en el momento en que se realiza la solicitud. |
| Obtener una ruta a pie entre dos puntos |
Obtiene una ruta a pie entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. Se espera que las rutas a pie tengan una sola pierna con un "travel_mode" de "caminar". Si Citymapper no puede calcular las indicaciones para esos puntos (generalmente por motivos de cobertura), el servicio devolverá una respuesta de código "400". La distancia máxima de gran círculo entre el "inicio" y el "final" se limita a 100km para este servicio. |
| Obtener una ruta de bicicleta alquilada entre dos puntos |
Obtiene una ruta de bicicleta alquilada entre dos puntos, incluidos los paseos iniciales y finales. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. Esta llamada se puede usar de varias maneras diferentes: use cualquier bicicleta de la marca especificada Esta es la llamada más sencilla, solo que requiere "start", "end" y "brand_id". Citymapper supone que el usuario está en el punto "inicio" y elige una bicicleta de la marca especificada, si es posible. Usar una bicicleta en una ubicación especificada Al agregar "original_vehicle_location" a "start", "end" y "brand_id", Citymapper planea una ruta que supone que la bicicleta está en la ubicación especificada. Actualización de una ruta en curso Para recuperar una ruta actualizada que incluye la redirección de la ubicación actual del usuario si se ha separado de la ruta planeada, el autor de la llamada puede agregar las propiedades "current_location" y "ride_state", que indica qué parte de la ruta resultante se debe redirigir alrededor de la "current_location" del usuario. |
| Obtener una ruta de bicicleta entre dos puntos |
Obtiene una ruta de bicicleta entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. Esta llamada supone que el piloto tiene una bicicleta en el punto de inicio y proporciona una ruta de ciclismo desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de bicicleta, aunque la propiedad "path_annotations" de la pierna puede indicar secciones durante las cuales el usuario debe caminar junto a la bicicleta. Esta llamada no incorpora ninguna información sobre la cobertura o las áreas de estacionamiento de los operadores de bicicletas, pero otras llamadas de servicio pueden estar disponibles para hacerlo. La distancia máxima de gran círculo entre el inicio y el final se limita a 200km para este servicio. |
| Obtener una ruta de conducción entre dos puntos |
Obtiene una ruta de coche entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. En esta llamada se supone que el piloto tiene un coche en el punto de inicio y proporciona una ruta de coche desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de coche. La distancia máxima de gran círculo entre el inicio y el final se limita a 1000km para este servicio. |
| Obtener una ruta de moto de motor entre dos puntos |
Obtiene una ruta de scooter motor entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. (Estos resultados están optimizados para una combustión interna mayor o scooters eléctricos donde el piloto está sentado). En esta llamada se supone que el piloto tiene un scooter en el punto de inicio y proporciona una ruta de e-scooter desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de scooter, aunque la propiedad "path_annotations" de la pierna puede indicar secciones durante las cuales el usuario debe caminar junto al scooter. Esta llamada no incorpora información sobre la cobertura o las zonas de estacionamiento de los operadores de scooter, pero otras llamadas de servicio pueden estar disponibles para hacerlo. |
| Obtener una ruta de motos de motor alquilada entre dos puntos |
Obtiene una ruta de motos de motor alquilada entre dos puntos, incluyendo cualquier recorrido inicial y final. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. (Estos resultados están optimizados para una combustión interna mayor o scooters eléctricos donde el piloto está sentado). NOTA: La ruta resultante supone actualmente que el usuario puede viajar directamente a la ubicación "end" especificada, no teniendo en cuenta ninguna zona de estacionamiento o cobertura. Por lo tanto, la ruta resultante contendrá solo una etapa inicial de "travel_mode" "walk" y una segunda etapa de "travel_mode" "self_piloted". Una futura actualización incorporará zonas de estacionamiento y cobertura y agregará una pierna final "caminar". Esta llamada se puede usar de varias maneras diferentes: use cualquier scooter de la marca especificada Esta es la llamada más sencilla, solo requiere "start", "end" y "brand_id". Citymapper asume que el usuario está en el punto de "inicio" y elige un scooter de la marca especificada, si es posible. Usar un scooter en una ubicación especificada Al agregar "original_vehicle_location" a "start", "end" y "brand_id", Citymapper planea una ruta que supone que el scooter está en la ubicación especificada. Actualización de una ruta en curso Para recuperar una ruta actualizada que incluye la redirección de la ubicación actual del usuario si se ha separado de la ruta planeada, el autor de la llamada puede agregar las propiedades "current_location" y "ride_state", que indica qué parte de la ruta resultante se debe redirigir alrededor de la "current_location" del usuario. |
| Obtener una ruta de taxi entre dos puntos |
Obtiene una ruta de taxi entre dos puntos. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. La ruta puede contener piernas de inicio y finalización si los puntos de recogida o de entrega no están cerca de las coordenadas de inicio y finalización solicitadas. Los servicios de la respuesta variarán en función de la disponibilidad local, la hora del día y, además, qué integraciones del servicio taxi se han configurado para su cuenta. Hay dos maneras recomendadas de usar este servicio: puede solicitar una ruta de taxi con estimaciones de servicio a petición activas incluidas por adelantado llamando a "?fetch_on_demand_services=true"; o bien, puede realizar la solicitud inicial sin capturar estimaciones que responderán con la ruta no activa y, a continuación, llamar inmediatamente a "1/live/routeupdates" para obtener las estimaciones dinámicas adicionales. El primer enfoque es más sencillo, pero el segundo puede ajustarse mejor a su caso de uso. |
| Obtener una ruta de tránsito entre dos puntos |
Calcula varias rutas de transporte público entre dos puntos. De forma predeterminada, los resultados contendrán hasta 5 rutas. Cada uno contendrá varias piernas: normalmente una al principio y al final de la ruta con "travel_mode" de "paseo", con al menos una con "travel_mode" de "tránsito" entre. |
| Obtener una ruta entre dos puntos para un escenario |
Calcula las rutas entre dos puntos en función de un escenario proporcionado. Se pueden proporcionar uno o varios grupos de rutas en función de un escenario. Cada grupo contendrá varias rutas. Cada ruta contendrá una o varias piernas. |
Obtención de información de disponibilidad y salida en directo para varias rutas
Esto recupera la información actual y de salida en directo y las cotizaciones a petición de varias rutas obtenidas previamente de los puntos de conexión "directions". Solo se pueden actualizar las rutas que tengan al menos una pierna con un detalle actualizable de la pierna mediante este servicio. Tenga en cuenta que es posible que no siempre sea posible que Citymapper proporcione las horas actuales o la información de salida y interrupción de una pierna. Las respuestas correctas (código HTTP '200') consumirán un crédito de "Live Update" para cada respuesta HTTP. Las llamadas incorrectas no consumirán ningún crédito.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Firmas
|
signatures | True | array of string |
Matriz de propiedades "signature" de rutas obtenidas previamente |
|
Capturar servicios a petición
|
fetch_on_demand_services | boolean |
Al actualizar mediante una o varias firmas de rutas que contienen tramos a petición con detalles actualizables (por ejemplo, desde el servicio Taxi Directions), si se establece en "true", se solicitará información adicional desde las intrgraciones del servicio taxi para proporcionar precios, duración y disponibilidad del servicio más precisos y completos. Para proporcionar esto, las ubicaciones iniciales y finales de la ruta original deben transmitirse a estos servicios de terceros, incluido en el caso de que una o la otra sea la ubicación actual o reciente del usuario. Tenga en cuenta que es posible que tenga que tener consentimiento informado explícito del usuario final para establecerlo en "true" en función de las leyes y reglamentos aplicables. Si se establece en "false" o se omite, no se realizará ninguna solicitud a ningún servicio de terceros. Si no se puede generar ninguna actualización para una pierna sin que este parámetro se establezca "true", la respuesta indicará esto dentro de los detalles actualizables. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
Actualizaciones de piernas
|
route_updates.leg_updates | array of |
Se trata de una matriz paralela de objetos Updatable Detail de leg, uno para cada pierna de la ruta original que se está actualizando. Los correspondientes a las piernas para caminar estarán vacíos, pero los detalles correspondientes a las piernas de tránsito contendrán información actualizada de salida. |
|
Hora de salida
|
route_updates.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta en el momento de la solicitud. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
route_updates.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta en el momento de la solicitud. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Duración
|
route_updates.route_duration_seconds | integer |
Tiempo estimado general para recorrer toda la ruta, en segundos. Este valor reemplaza el valor "duration_seconds" de la ruta original, ya que se volverá a calcular para usar la información de salida específica contenida en esta respuesta de actualización de ruta. Se puede omitir en raras circunstancias cuando no se puede calcular la duración, por ejemplo, si la ruta no se puede completar en el momento dado porque los servicios implicados no se están ejecutando. |
|
DurationAccuracy
|
route_updates.route_duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Firma de solicitud
|
route_updates.request_signature | string |
Se trata de una ruta "firma" de la solicitud de actualización, que se debe usar para asociar esta actualización a la ruta correcta. |
Obtener direcciones de e-scooter contratados entre dos puntos
Obtiene una ruta de e-scooter alquilada entre dos puntos, incluyendo cualquier recorrido inicial y final. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. Estos resultados están optimizados para pequeños scooters con batería en los que se encuentra el piloto. Esta llamada se puede usar de varias maneras diferentes: use cualquier scooter de la marca especificada Esta es la llamada más sencilla, solo requiere "start", "end" y "brand_id". Citymapper asume que el usuario está en el punto de "inicio" y elige un scooter de la marca especificada, si es posible. Usar un scooter en una ubicación especificada Al agregar "original_vehicle_location" a "start", "end" y "brand_id", Citymapper planea una ruta que supone que el scooter está en la ubicación especificada. Actualización de una ruta en curso Para recuperar una ruta actualizada que incluye la redirección de la ubicación actual del usuario si se ha separado de la ruta planeada, el autor de la llamada puede agregar las propiedades "current_location" y "ride_state", que indica qué parte de la ruta resultante se debe redirigir alrededor de la "current_location" del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Identificador de marca
|
brand_id | True | string |
El identificador de la marca de patinetes electrónicos que se va a utilizar para esta ruta. Esto es necesario para determinar la ubicación de los scooters disponibles, junto con cualquier cobertura asociada y restricciones de estacionamiento. |
|
Estado
|
ride_state | string |
Indica dónde está el usuario a lo largo de la ruta. Si se omite, se usa "walking_to_vehicle". Esta propiedad junto con "current_location" permite la recuperación de una ruta actualizada que refleja el progreso actual del usuario a través de ella. | value | description | | ----- | ----------- | | walking_to_vehicle | Indica que el usuario está caminando para recoger el vehículo | | equitación | Indica que el usuario está montando el vehículo | | walking_to_end | Indica que el usuario ha dejado el vehículo y está caminando a su destino | |
|
|
Ubicación actual
|
current_location | string |
La ubicación actual del usuario, con el fin de actualizar la ruta en función de la ubicación del usuario. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Este parámetro se usa para obtener una ruta actualizada que refleje la ubicación real del usuario si se separa de la ruta de acceso proporcionada en la ruta de acceso. Si se proporciona esto, la ruta devuelta contendrá esta ubicación. El valor del parámetro "ride_state" decide qué tramo de la ruta contendrá esta ubicación. |
|
|
Ubicación de inicio
|
ride_start_location | string |
La ubicación del vehículo que se va a utilizar, al principio del recorrido del vehículo a lo largo de la Ruta. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe proporcionarse cuando "ride_state" es "montar" o "walking_to_end". Si no se proporciona cuando "ride_state" es "walking_to_vehicle" (o no se especifica), Citymapper intentará encontrar el vehículo más adecuado que pertenezca al "brand_id" especificado. Por compatibilidad, "original_vehicle_location" es un alias para este parámetro. |
|
|
Ubicación final
|
ride_end_location | string |
La ubicación en la que se dejó el vehículo al final del recorrido del vehículo a lo largo de la ruta. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe proporcionarse cuando "ride_state" es "walking_to_end". En todos los demás estados, este parámetro se omite. |
|
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Volver a enrutar la firma
|
reroute_signature | string |
Al redirigir (solicitando una actualización a una respuesta anterior que tenga en cuenta la ubicación actualizada del usuario), este valor debe establecerse en la "firma" proporcionada en la ruta original. Esto permite determinar de forma más eficaz la ruta actualizada. Este valor debe estar codificado en dirección URL. Al proporcionar este parámetro, la ubicación "current_location" (cuando procede) o "start" debe establecerse en la ubicación más reciente del usuario. Cuando se incluye este parámetro, Citymapper puede no devolver resultados en los casos en los que la solicitud difiere significativamente del original, por ejemplo, si la ubicación "end" es diferente, o si ha transcurrido más de 1 hora desde la solicitud original. |
|
|
Inicio del rodamiento
|
start_bearing | integer |
Ángulo en sentido contrario desde el norte entre 0 y 359, donde Norte es 0 y Este es 90. Este rodamiento se usa para influir en el texto de instrucción inicial o en el enrutamiento, normalmente para evitar que se le pida al usuario que realice un giro u, si continúa en su rodamiento actual da una ruta comparable. Esto solo debe proporcionarse si desea influir en la dirección inicial del viaje para la ruta. |
|
|
Ubicaciones anteriores
|
past_loc_coords | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Coordenadas de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las coordenadas deben tener el formato WGS84 "latitud, longitud". Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Edades anteriores de la ubicación
|
past_loc_ages | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Edades de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las edades deben estar en segundos enteros desde la ubicación actual. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_coords" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Past Location Accuracies
|
past_loc_accuracies | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. El GPS Accuracies de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las accuracies deben estar en medidores enteros. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_coords" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener direcciones de e-scooter entre dos puntos
Obtiene una ruta de scooter entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. (Estos resultados están optimizados para pequeños scooters con batería en los que se encuentra el piloto). En esta llamada se supone que el piloto tiene un scooter en el punto de inicio y proporciona una ruta de e-scooter desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de scooter, aunque la propiedad "path_annotations" de la pierna puede indicar secciones durante las cuales el usuario debe caminar junto al scooter. Esta llamada no incorpora información sobre la cobertura o las zonas de estacionamiento de los operadores de scooter, pero otras llamadas de servicio pueden estar disponibles para hacerlo. Las respuestas correctas (código HTTP '200') consumirán un crédito de "Ruta de scooter" (o un crédito "Scooter Reroute" si se usa "reroute_signature") para cada respuesta HTTP. Las llamadas incorrectas no consumirán ningún crédito.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Volver a enrutar la firma
|
reroute_signature | string |
Al redirigir (solicitando una actualización a una respuesta anterior que tenga en cuenta la ubicación actualizada del usuario), este valor debe establecerse en la "firma" proporcionada en la ruta original. Esto permite determinar de forma más eficaz la ruta actualizada. Este valor debe estar codificado en dirección URL. Al proporcionar este parámetro, la ubicación "current_location" (cuando procede) o "start" debe establecerse en la ubicación más reciente del usuario. Cuando se incluye este parámetro, Citymapper puede no devolver resultados en los casos en los que la solicitud difiere significativamente del original, por ejemplo, si la ubicación "end" es diferente, o si ha transcurrido más de 1 hora desde la solicitud original. |
|
|
Inicio del rodamiento
|
start_bearing | integer |
Ángulo en sentido contrario desde el norte entre 0 y 359, donde Norte es 0 y Este es 90. Este rodamiento se usa para influir en el texto de instrucción inicial o en el enrutamiento, normalmente para evitar que se le pida al usuario que realice un giro u, si continúa en su rodamiento actual da una ruta comparable. Esto solo debe proporcionarse si desea influir en la dirección inicial del viaje para la ruta. |
|
|
Ubicaciones anteriores
|
past_loc_coords | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Coordenadas de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las coordenadas deben tener el formato WGS84 "latitud, longitud". Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Edades anteriores de la ubicación
|
past_loc_ages | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Edades de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las edades deben estar en segundos enteros desde la ubicación actual. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_coords" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Past Location Accuracies
|
past_loc_accuracies | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. El GPS Accuracies de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las accuracies deben estar en medidores enteros. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_coords" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener tiempos de viaje entre dos ubicaciones
Determina el tiempo de desplazamiento en varios modos de desplazamiento entre los dos puntos especificados en el momento en que se realiza la solicitud.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | string |
El punto de inicio geográfico del viaje, en formato "latitud,longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. |
|
Fin
|
end | True | string |
Punto final geográfico del viaje, en formato WGS84 'latitud,longitud'. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. |
|
Tipos de viaje
|
traveltime_types | array |
Una lista separada por comas de diferentes tipos de tiempo de viaje para intentar solicitar. Cada valor de solicitud corresponde a un campo determinado de la respuesta (los campos de respuesta solo estarán presentes cuando Citymapper pudiera calcular un tiempo para ese tipo de tiempo de desplazamiento). | value | propiedad response | description | | ----- | ----------------- | ------------| | walk | walk_travel_time_minutes | Caminar | | transit | transit_time_minutes | Viaje en transporte público | | bike | bike_time_minutes | Viaje en bicicleta (montar en todo el camino) | | scooter | scooter_time_minutes | Viaje de e-scooter de pie (montando todo el camino) | | motorscooter | motorscooter_time_minutes | Desplazamiento en moto motor sentado (montar todo el camino) | | coche | car_time_minutes | Viaje en coche (montando todo el camino). Disponible solo en planes Enterprise | Cuando este campo se omite o está vacío, se usará un valor predeterminado de "walk,transit". |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tiempo de paseo
|
walk_travel_time_minutes | integer |
Tiempo estimado de caminata entre los dos puntos dados en minutos. |
|
Tiempo de tránsito
|
transit_time_minutes | integer |
Tiempo estimado de viaje de transporte público entre los dos puntos dados en minutos. |
|
Tiempo de bicicleta
|
bike_time_minutes | integer |
Tiempo estimado de viaje de bicicletas entre dos puntos en minutos. |
|
Tiempo de scooter
|
scooter_time_minutes | integer |
Tiempo estimado de viaje de e-scooter entre dos puntos en minutos. |
|
Tiempo de motores
|
motorscooter_time_minutes | integer |
Tiempo estimado de viaje de scooter motor entre dos puntos en minutos. |
|
Tiempo de conducción
|
car_time_minutes | integer |
Tiempo estimado de viaje del coche entre dos puntos en minutos. |
Obtener una ruta a pie entre dos puntos
Obtiene una ruta a pie entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. Se espera que las rutas a pie tengan una sola pierna con un "travel_mode" de "caminar". Si Citymapper no puede calcular las indicaciones para esos puntos (generalmente por motivos de cobertura), el servicio devolverá una respuesta de código "400". La distancia máxima de gran círculo entre el "inicio" y el "final" se limita a 100km para este servicio.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Profiles
|
profiles | string |
Indica qué "perfiles" se usarán al calcular las indicaciones para caminar. Cada perfil puede generar una opción de ruta diferente, por lo que la solicitud de más perfiles generalmente proporcionará más opciones. Tenga en cuenta que a veces algunas de las rutas resultantes serán idénticas (en el caso de que una ruta sea óptima en más de una manera) y es posible que un perfil no siempre produzca una ruta. No todos los perfiles estarán disponibles para todas las rutas de inicio y finalización. Los perfiles no disponibles se omitirán de la respuesta. | value | description | | ----- | ----------- | | fast | El perfil predeterminado, intenta encontrar la ruta sensible más rápida | | main_roads | Intentos de evitar calles y parques | Si no se especifica ningún perfil, se usará "fast". |
|
|
Volver a enrutar la firma
|
reroute_signature | string |
Al redirigir (solicitando una actualización a una respuesta anterior que tenga en cuenta la ubicación actualizada del usuario), este valor debe establecerse en la "firma" proporcionada en la ruta original. Esto permite determinar de forma más eficaz la ruta actualizada. Este valor debe estar codificado en dirección URL. Al proporcionar este parámetro, la ubicación "current_location" (cuando procede) o "start" debe establecerse en la ubicación más reciente del usuario. Cuando se incluye este parámetro, Citymapper puede no devolver resultados en los casos en los que la solicitud difiere significativamente del original, por ejemplo, si la ubicación "end" es diferente, o si ha transcurrido más de 1 hora desde la solicitud original. |
|
|
Inicio del rodamiento
|
start_bearing | integer |
Ángulo en sentido contrario desde el norte entre 0 y 359, donde Norte es 0 y Este es 90. Este rodamiento se usa para influir en el texto de instrucción inicial o en el enrutamiento, normalmente para evitar que se le pida al usuario que realice un giro u, si continúa en su rodamiento actual da una ruta comparable. Esto solo debe proporcionarse si desea influir en la dirección inicial del viaje para la ruta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta de bicicleta alquilada entre dos puntos
Obtiene una ruta de bicicleta alquilada entre dos puntos, incluidos los paseos iniciales y finales. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. Esta llamada se puede usar de varias maneras diferentes: use cualquier bicicleta de la marca especificada Esta es la llamada más sencilla, solo que requiere "start", "end" y "brand_id". Citymapper supone que el usuario está en el punto "inicio" y elige una bicicleta de la marca especificada, si es posible. Usar una bicicleta en una ubicación especificada Al agregar "original_vehicle_location" a "start", "end" y "brand_id", Citymapper planea una ruta que supone que la bicicleta está en la ubicación especificada. Actualización de una ruta en curso Para recuperar una ruta actualizada que incluye la redirección de la ubicación actual del usuario si se ha separado de la ruta planeada, el autor de la llamada puede agregar las propiedades "current_location" y "ride_state", que indica qué parte de la ruta resultante se debe redirigir alrededor de la "current_location" del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Identificador de marca
|
brand_id | True | string |
Identificador de la marca de bicicleta que se va a usar para esta ruta. Esto es necesario para determinar la ubicación de las bicicletas disponibles, junto con cualquier cobertura asociada y restricciones de estacionamiento. |
|
Estado
|
ride_state | string |
Indica dónde está el usuario a lo largo de la ruta. Si se omite, se usa "walking_to_vehicle". Esta propiedad junto con "current_location" permite la recuperación de una ruta actualizada que refleja el progreso actual del usuario a través de ella. | value | description | | ----- | ----------- | | walking_to_vehicle | Indica que el usuario está caminando para recoger el vehículo | | equitación | Indica que el usuario está montando el vehículo | | walking_to_end | Indica que el usuario ha dejado el vehículo y está caminando a su destino | |
|
|
Ubicación actual
|
current_location | string |
La ubicación actual del usuario, con el fin de actualizar la ruta en función de la ubicación del usuario. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Este parámetro se usa para obtener una ruta actualizada que refleje la ubicación real del usuario si se separa de la ruta de acceso proporcionada en la ruta de acceso. Si se proporciona esto, la ruta devuelta contendrá esta ubicación. El valor del parámetro "ride_state" decide qué tramo de la ruta contendrá esta ubicación. |
|
|
Ubicación de inicio
|
ride_start_location | string |
La ubicación del vehículo que se va a utilizar, al principio del recorrido del vehículo a lo largo de la Ruta. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe proporcionarse cuando "ride_state" es "montar" o "walking_to_end". Si no se proporciona cuando "ride_state" es "walking_to_vehicle" (o no se especifica), Citymapper intentará encontrar el vehículo más adecuado que pertenezca al "brand_id" especificado. Por compatibilidad, "original_vehicle_location" es un alias para este parámetro. |
|
|
Ubicación final
|
ride_end_location | string |
La ubicación en la que se dejó el vehículo al final del recorrido del vehículo a lo largo de la ruta. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe proporcionarse cuando "ride_state" es "walking_to_end". En todos los demás estados, este parámetro se omite. |
|
|
Profiles
|
profiles | string |
Indica qué "perfiles" se usarán al calcular las direcciones de la bicicleta. Cada perfil puede generar una opción de ruta diferente, por lo que la solicitud de más perfiles generalmente proporcionará más opciones. Tenga en cuenta que a veces algunas de las rutas resultantes serán idénticas (en el caso de que una ruta sea óptima en más de una manera) y es posible que un perfil no siempre produzca una ruta. | value | description | | ----- | ----------- | | quiet | Intentos de usar carreteras con menos tráfico | | regular | El perfil predeterminado equilibra el tráfico con la directa | | fast | Intentos de encontrar la ruta sensible más corta | Si no se especifica ningún perfil, se usará "regular". |
|
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Volver a enrutar la firma
|
reroute_signature | string |
Al redirigir (solicitando una actualización a una respuesta anterior que tenga en cuenta la ubicación actualizada del usuario), este valor debe establecerse en la "firma" proporcionada en la ruta original. Esto permite determinar de forma más eficaz la ruta actualizada. Este valor debe estar codificado en dirección URL. Al proporcionar este parámetro, la ubicación "current_location" (cuando procede) o "start" debe establecerse en la ubicación más reciente del usuario. Cuando se incluye este parámetro, Citymapper puede no devolver resultados en los casos en los que la solicitud difiere significativamente del original, por ejemplo, si la ubicación "end" es diferente, o si ha transcurrido más de 1 hora desde la solicitud original. |
|
|
Inicio del rodamiento
|
start_bearing | integer |
Ángulo en sentido contrario desde el norte entre 0 y 359, donde Norte es 0 y Este es 90. Este rodamiento se usa para influir en el texto de instrucción inicial o en el enrutamiento, normalmente para evitar que se le pida al usuario que realice un giro u, si continúa en su rodamiento actual da una ruta comparable. Esto solo debe proporcionarse si desea influir en la dirección inicial del viaje para la ruta. |
|
|
Ubicaciones anteriores
|
past_loc_coords | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Coordenadas de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las coordenadas deben tener el formato WGS84 "latitud, longitud". Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Edades anteriores de la ubicación
|
past_loc_ages | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Edades de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las edades deben estar en segundos enteros desde la ubicación actual. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_coords" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Past Location Accuracies
|
past_loc_accuracies | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. El GPS Accuracies de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las accuracies deben estar en medidores enteros. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_coords" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta de bicicleta entre dos puntos
Obtiene una ruta de bicicleta entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. Esta llamada supone que el piloto tiene una bicicleta en el punto de inicio y proporciona una ruta de ciclismo desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de bicicleta, aunque la propiedad "path_annotations" de la pierna puede indicar secciones durante las cuales el usuario debe caminar junto a la bicicleta. Esta llamada no incorpora ninguna información sobre la cobertura o las áreas de estacionamiento de los operadores de bicicletas, pero otras llamadas de servicio pueden estar disponibles para hacerlo. La distancia máxima de gran círculo entre el inicio y el final se limita a 200km para este servicio.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Profiles
|
profiles | string |
Indica qué "perfiles" se usarán al calcular las direcciones de la bicicleta. Cada perfil puede generar una opción de ruta diferente, por lo que la solicitud de más perfiles generalmente proporcionará más opciones. Tenga en cuenta que a veces algunas de las rutas resultantes serán idénticas (en el caso de que una ruta sea óptima en más de una manera) y es posible que un perfil no siempre produzca una ruta. | value | description | | ----- | ----------- | | quiet | Intentos de usar carreteras con menos tráfico | | regular | El perfil predeterminado equilibra el tráfico con la directa | | fast | Intentos de encontrar la ruta sensible más corta | Si no se especifica ningún perfil, se usará "regular". |
|
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Volver a enrutar la firma
|
reroute_signature | string |
Al redirigir (solicitando una actualización a una respuesta anterior que tenga en cuenta la ubicación actualizada del usuario), este valor debe establecerse en la "firma" proporcionada en la ruta original. Esto permite determinar de forma más eficaz la ruta actualizada. Este valor debe estar codificado en dirección URL. Al proporcionar este parámetro, la ubicación "current_location" (cuando procede) o "start" debe establecerse en la ubicación más reciente del usuario. Cuando se incluye este parámetro, Citymapper puede no devolver resultados en los casos en los que la solicitud difiere significativamente del original, por ejemplo, si la ubicación "end" es diferente, o si ha transcurrido más de 1 hora desde la solicitud original. |
|
|
Inicio del rodamiento
|
start_bearing | integer |
Ángulo en sentido contrario desde el norte entre 0 y 359, donde Norte es 0 y Este es 90. Este rodamiento se usa para influir en el texto de instrucción inicial o en el enrutamiento, normalmente para evitar que se le pida al usuario que realice un giro u, si continúa en su rodamiento actual da una ruta comparable. Esto solo debe proporcionarse si desea influir en la dirección inicial del viaje para la ruta. |
|
|
Ubicaciones anteriores
|
past_loc_coords | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Coordenadas de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las coordenadas deben tener el formato WGS84 "latitud, longitud". Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Edades anteriores de la ubicación
|
past_loc_ages | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. Edades de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las edades deben estar en segundos enteros desde la ubicación actual. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_coords" y "past_loc_accuracies" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
|
|
Past Location Accuracies
|
past_loc_accuracies | string |
Parámetro opcional para mejorar el comportamiento de reenrutamiento. El GPS Accuracies de hasta 10 de las ubicaciones anteriores del usuario como una lista separada por comas. Las accuracies deben estar en medidores enteros. Debe estar ordenado cronológicamente, el último más reciente. "past_loc_ages" y "past_loc_coords" deben proporcionarse junto a . El servidor solo tendrá en cuenta un máximo de 10 ubicaciones, si se proporcionan más de 10 ubicaciones, se omitirán las ubicaciones menos recientes. Es probable que el servidor omita las ubicaciones anteriores a 30 segundos o que tengan menos de 1 segundo de diferencia. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta de conducción entre dos puntos
Obtiene una ruta de coche entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. En esta llamada se supone que el piloto tiene un coche en el punto de inicio y proporciona una ruta de coche desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de coche. La distancia máxima de gran círculo entre el inicio y el final se limita a 1000km para este servicio.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta de moto de motor entre dos puntos
Obtiene una ruta de scooter motor entre dos puntos, proporcionando suficiente información para representarla en un mapa, junto con una estimación de duración. (Estos resultados están optimizados para una combustión interna mayor o scooters eléctricos donde el piloto está sentado). En esta llamada se supone que el piloto tiene un scooter en el punto de inicio y proporciona una ruta de e-scooter desde allí hasta el punto "final" si ambos están dentro de las áreas admitidas de Citymapper. La ruta resultante debe contener una sola pierna de scooter, aunque la propiedad "path_annotations" de la pierna puede indicar secciones durante las cuales el usuario debe caminar junto al scooter. Esta llamada no incorpora información sobre la cobertura o las zonas de estacionamiento de los operadores de scooter, pero otras llamadas de servicio pueden estar disponibles para hacerlo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Volver a enrutar la firma
|
reroute_signature | string |
Al redirigir (solicitando una actualización a una respuesta anterior que tenga en cuenta la ubicación actualizada del usuario), este valor debe establecerse en la "firma" proporcionada en la ruta original. Esto permite determinar de forma más eficaz la ruta actualizada. Este valor debe estar codificado en dirección URL. Al proporcionar este parámetro, la ubicación "current_location" (cuando procede) o "start" debe establecerse en la ubicación más reciente del usuario. Cuando se incluye este parámetro, Citymapper puede no devolver resultados en los casos en los que la solicitud difiere significativamente del original, por ejemplo, si la ubicación "end" es diferente, o si ha transcurrido más de 1 hora desde la solicitud original. |
|
|
Inicio del rodamiento
|
start_bearing | integer |
Ángulo en sentido contrario desde el norte entre 0 y 359, donde Norte es 0 y Este es 90. Este rodamiento se usa para influir en el texto de instrucción inicial o en el enrutamiento, normalmente para evitar que se le pida al usuario que realice un giro u, si continúa en su rodamiento actual da una ruta comparable. Esto solo debe proporcionarse si desea influir en la dirección inicial del viaje para la ruta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta de motos de motor alquilada entre dos puntos
Obtiene una ruta de motos de motor alquilada entre dos puntos, incluyendo cualquier recorrido inicial y final. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. (Estos resultados están optimizados para una combustión interna mayor o scooters eléctricos donde el piloto está sentado). NOTA: La ruta resultante supone actualmente que el usuario puede viajar directamente a la ubicación "end" especificada, no teniendo en cuenta ninguna zona de estacionamiento o cobertura. Por lo tanto, la ruta resultante contendrá solo una etapa inicial de "travel_mode" "walk" y una segunda etapa de "travel_mode" "self_piloted". Una futura actualización incorporará zonas de estacionamiento y cobertura y agregará una pierna final "caminar". Esta llamada se puede usar de varias maneras diferentes: use cualquier scooter de la marca especificada Esta es la llamada más sencilla, solo requiere "start", "end" y "brand_id". Citymapper asume que el usuario está en el punto de "inicio" y elige un scooter de la marca especificada, si es posible. Usar un scooter en una ubicación especificada Al agregar "original_vehicle_location" a "start", "end" y "brand_id", Citymapper planea una ruta que supone que el scooter está en la ubicación especificada. Actualización de una ruta en curso Para recuperar una ruta actualizada que incluye la redirección de la ubicación actual del usuario si se ha separado de la ruta planeada, el autor de la llamada puede agregar las propiedades "current_location" y "ride_state", que indica qué parte de la ruta resultante se debe redirigir alrededor de la "current_location" del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Identificador de marca
|
brand_id | True | string |
El identificador de la marca de patinetes que se va a utilizar para esta ruta. Esto es necesario para determinar la ubicación de los scooters disponibles, junto con cualquier cobertura asociada y restricciones de estacionamiento. |
|
Estado
|
ride_state | string |
Indica dónde está el usuario a lo largo de la ruta. Si se omite, se usa "walking_to_vehicle". Esta propiedad junto con "current_location" permite la recuperación de una ruta actualizada que refleja el progreso actual del usuario a través de ella. | value | description | | ----- | ----------- | | walking_to_vehicle | Indica que el usuario está caminando para recoger el vehículo | | equitación | Indica que el usuario está montando el vehículo | | walking_to_end | Indica que el usuario ha dejado el vehículo y está caminando a su destino | |
|
|
Ubicación actual
|
current_location | string |
La ubicación actual del usuario, con el fin de actualizar la ruta en función de la ubicación del usuario. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Este parámetro se usa para obtener una ruta actualizada que refleje la ubicación real del usuario si se separa de la ruta de acceso proporcionada en la ruta de acceso. Si se proporciona esto, la ruta devuelta contendrá esta ubicación. El valor del parámetro "ride_state" decide qué tramo de la ruta contendrá esta ubicación. |
|
|
Ubicación de inicio
|
ride_start_location | string |
La ubicación del vehículo que se va a utilizar, al principio del recorrido del vehículo a lo largo de la Ruta. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe proporcionarse cuando "ride_state" es "montar" o "walking_to_end". Si no se proporciona cuando "ride_state" es "walking_to_vehicle" (o no se especifica), Citymapper intentará encontrar el vehículo más adecuado que pertenezca al "brand_id" especificado. Por compatibilidad, "original_vehicle_location" es un alias para este parámetro. |
|
|
Ubicación final
|
ride_end_location | string |
La ubicación en la que se dejó el vehículo al final del recorrido del vehículo a lo largo de la ruta. Se proporciona en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán los primeros 6 dígitos de precisión. Debe proporcionarse cuando "ride_state" es "walking_to_end". En todos los demás estados, este parámetro se omite. |
|
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Volver a enrutar la firma
|
reroute_signature | string |
Al redirigir (solicitando una actualización a una respuesta anterior que tenga en cuenta la ubicación actualizada del usuario), este valor debe establecerse en la "firma" proporcionada en la ruta original. Esto permite determinar de forma más eficaz la ruta actualizada. Este valor debe estar codificado en dirección URL. Al proporcionar este parámetro, la ubicación "current_location" (cuando procede) o "start" debe establecerse en la ubicación más reciente del usuario. Cuando se incluye este parámetro, Citymapper puede no devolver resultados en los casos en los que la solicitud difiere significativamente del original, por ejemplo, si la ubicación "end" es diferente, o si ha transcurrido más de 1 hora desde la solicitud original. |
|
|
Inicio del rodamiento
|
start_bearing | integer |
Ángulo en sentido contrario desde el norte entre 0 y 359, donde Norte es 0 y Este es 90. Este rodamiento se usa para influir en el texto de instrucción inicial o en el enrutamiento, normalmente para evitar que se le pida al usuario que realice un giro u, si continúa en su rodamiento actual da una ruta comparable. Esto solo debe proporcionarse si desea influir en la dirección inicial del viaje para la ruta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta de taxi entre dos puntos
Obtiene una ruta de taxi entre dos puntos. La ruta resultante proporciona suficiente información para representarla en un mapa, junto con una estimación de duración. La ruta puede contener piernas de inicio y finalización si los puntos de recogida o de entrega no están cerca de las coordenadas de inicio y finalización solicitadas. Los servicios de la respuesta variarán en función de la disponibilidad local, la hora del día y, además, qué integraciones del servicio taxi se han configurado para su cuenta. Hay dos maneras recomendadas de usar este servicio: puede solicitar una ruta de taxi con estimaciones de servicio a petición activas incluidas por adelantado llamando a "?fetch_on_demand_services=true"; o bien, puede realizar la solicitud inicial sin capturar estimaciones que responderán con la ruta no activa y, a continuación, llamar inmediatamente a "1/live/routeupdates" para obtener las estimaciones dinámicas adicionales. El primer enfoque es más sencillo, pero el segundo puede ajustarse mejor a su caso de uso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Capturar servicios en dominio
|
fetch_on_demand_services | string |
Si se establece en "true", se solicitará información adicional de las integraciones del servicio taxi para proporcionar precios, duración y disponibilidad de servicio más precisos y completos, devueltos en los detalles actualizables del segmento a petición. Para proporcionar esto, las ubicaciones de inicio y finalización de la ruta deben transmitirse a estos servicios de terceros, incluido en el caso de que una o la otra sea la ubicación actual o reciente del usuario. Tenga en cuenta que es posible que tenga que tener consentimiento informado explícito del usuario final para establecerlo en "true" en función de las leyes y reglamentos aplicables. Si se establece en "false" o se omite, no se realizará ninguna solicitud a ningún servicio de terceros. |
|
|
Identificadores de marca
|
brand_ids | array |
Lista separada por comas de identificadores de marca para limitar esta solicitud de direcciones. Si se omite (valor predeterminado), todas las marcas disponibles para usted tendrán una ruta taxi devuelta. |
|
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta de tránsito entre dos puntos
Calcula varias rutas de transporte público entre dos puntos. De forma predeterminada, los resultados contendrán hasta 5 rutas. Cada uno contendrá varias piernas: normalmente una al principio y al final de la ruta con "travel_mode" de "paseo", con al menos una con "travel_mode" de "tránsito" entre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Time
|
time | string |
Hora de uso como restricción de hora de salida o llegada al obtener indicaciones. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
|
Tipo de hora
|
time_type | string |
Cuando se da un valor de "hora", esto determina cómo se usará la hora para restringir las direcciones que se devuelven. Cuando no se especifica , se usa "depart_approximate". Si no se da "tiempo", esto no tiene ningún efecto. | value | description | | ----- | ----------- | | llegar | Las direcciones se eligen para que el usuario llegue a su destino en o antes de "hora" | | salir | Las direcciones se eligen suponiendo que el usuario abandone su origen tan pronto como sea posible | | depart_approximate | De forma similar a "salir", pero permitiendo salidas posteriores con el fin de devolver opciones más preferibles incluso si salen un poco más tarde. Esta es la forma predeterminada de Elegir direcciones cuando no se especifica el tiempo | |
|
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
|
|
Limit
|
limit | integer |
Número máximo de rutas que se van a devolver. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |
Obtener una ruta entre dos puntos para un escenario
Calcula las rutas entre dos puntos en función de un escenario proporcionado. Se pueden proporcionar uno o varios grupos de rutas en función de un escenario. Cada grupo contendrá varias rutas. Cada ruta contendrá una o varias piernas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de escenario
|
scenario_id | True | string |
Id. de escenario para obtener instrucciones. |
|
Comenzar
|
start | True | array |
Inicio geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Fin
|
end | True | array |
Extremo geográfico de la ruta, en formato "latitud, longitud" de WGS84. Las coordenadas deben estar en decimal y solo se usarán las primeras 6 posiciones decimales. |
|
Time
|
time | string |
Hora de uso como restricción de hora de salida o llegada al obtener indicaciones. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
|
Tipo de hora
|
time_type | string |
Cuando se da un valor de "hora", esto determina cómo se usará la hora para restringir las direcciones que se devuelven. Cuando no se especifica , se usa "depart_approximate". Si no se da "tiempo", esto no tiene ningún efecto. | value | description | | ----- | ----------- | | llegar | Las direcciones se eligen para que el usuario llegue a su destino en o antes de "hora" | | salir | Las direcciones se eligen suponiendo que el usuario abandone su origen tan pronto como sea posible | | depart_approximate | De forma similar a "salir", pero permitiendo salidas posteriores con el fin de devolver opciones más preferibles incluso si salen un poco más tarde. Esta es la forma predeterminada de Elegir direcciones cuando no se especifica el tiempo | |
|
|
Language
|
language | string |
Una etiqueta de idioma IETF BCP 47 que indica la preferencia de idioma del usuario final. Cuando se proporciona, la respuesta contendrá una propiedad "language" que indica el idioma usado para los elementos localizables de la respuesta (como las instrucciones de giro). Este idioma será un intento de mejor esfuerzo para cumplir la preferencia expresada, pero puede contener un valor que no se expresó en la solicitud (esto generalmente será "en-US" como reserva). Tenga en cuenta que las preferencias de idioma generalmente solo afectarán al contenido generado por Citymapper, como las instrucciones de giro. Por lo general, el contenido externo, como los nombres de detención y las descripciones de estado, se pasarán en su idioma original. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
routes
|
routes | array of object | |
|
Latitude
|
routes.start.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.start.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Latitude
|
routes.end.coordinates.lat | float |
Latitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Longitude
|
routes.end.coordinates.lon | float |
Longitud en codificación WGS84, con 6 dígitos de precisión decimal. |
|
Distancia en metros
|
routes.distance_meters | integer |
Distancia total de toda la ruta, en metros. |
|
Duración
|
routes.duration_seconds | integer |
Tiempo estimado total para recorrer toda la ruta, en segundos, en función del vehículo seleccionado o la salida en la respuesta. |
|
Precisión de la duración
|
routes.duration_accuracy | string |
La evaluación de Citymapper de cómo se debe mostrar el nivel de precisión de "duration_seconds" al usuario. Esto se basa en gran medida en el "tipo" de las salidas usadas durante los tiempos, pero implica heurística adicional desarrollada con el tiempo para la aplicación Citymapper. Cuando no se proporciona este campo, se debe usar el valor "scheduled". | value | description | | ----- | ----------- | | estimado | Una duración que se debe considerar aproximada, ya que su cálculo implica más incertidumbre de lo habitual. Esta es la precisión más baja. | | scheduled | Una duración normal, normalmente basada en la información de calendario publicada. | | live | Una duración basada en gran medida en información de salida en tiempo real o en vivo. Esta es la precisión más alta. | |
|
Formato
|
routes.price.formatted | string |
El precio especificado como una cadena con formato. De forma predeterminada, se encuentra en el formato de moneda nativa de la región donde se produce la ruta. |
|
Importe
|
routes.price.amount | string |
El precio como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo mínimo de cantidad
|
routes.price.amount_range_minimum | string |
Si este Precio representa un intervalo de valores posibles, el precio mínimo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. |
|
Intervalo de cantidad máximo
|
routes.price.amount_range_maximum | string |
Si este Precio representa un intervalo de valores posibles, el precio máximo como valor decimal, codificado como una cadena para evitar problemas de precisión de punto flotante. No incluirá símbolos de moneda y el separador entre unidades principales y secundarias siempre será '.', independientemente de la región. Esto puede no incluirse si el intervalo está abierto |
|
Moneda
|
routes.price.currency | string |
Moneda en la que se da el precio, en forma ISO 4217 de tres letras. |
|
Multiplicador de demanda
|
routes.price.demand_multipler | float |
Indica que los precios son más altos de lo habitual debido a la demanda, normalmente para las piernas taxi (a petición). Puede que en raras ocasiones sea menor que 1,0 |
|
Emisiones de CO2e
|
routes.emissions_grams_co2e | float |
Estimación de las emisiones de gases de efecto invernadero de la ruta, expresadas en gramos de equivalente de dióxido de carbono (CO2e). |
|
Piernas
|
routes.legs | array of object |
Matriz de piernas que componen la ruta, en el orden en que deben atravesarse. Cada ruta válida tendrá al menos una. |
|
Modo de viaje
|
routes.legs.travel_mode | string |
Modo de desplazamiento. |
|
Duración
|
routes.legs.duration_seconds | integer |
El tiempo necesario para atravesar esta pierna, excluyendo cualquier tiempo de espera o embarque al principio. Puede omitirse en circunstancias poco frecuentes cuando no se puede calcular la duración. |
|
Ruta
|
routes.legs.path | string |
La ruta geográfica que atraviesa la pierna, como una serie de coordenadas WGS84 codificadas en Formato de polilínea de Google, con una precisión decimal de 5 dígitos. Por ejemplo, el valor "_flyHbjPDZBTBNDJ" codifica la siguiente serie de coordenadas (latitud, longitud): '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
Instrucciones
|
routes.legs.instructions | array of object |
Esto proporciona la lista de instrucciones de turno para guiar al usuario a través de las piernas donde el usuario necesita navegar, como cuando camina o usa un scooter o bicicleta. |
|
Índice de ruta de acceso
|
routes.legs.instructions.path_index | integer |
Índice basado en 0 en la lista de coordenadas proporcionadas por la propiedad "path" de la pierna. Esto indica la ubicación en la que se va a seguir la instrucción, por lo que será la ubicación del turno en la ruta de acceso, o el inicio o el final de la pierna. |
|
Distancia
|
routes.legs.instructions.distance_meters | integer |
Distancia en metros de la sección del 'trazado' antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Time
|
routes.legs.instructions.time_seconds | integer |
Tiempo en segundos que se espera que el usuario tarde en recorrer la sección de la "ruta" antes de esta instrucción. Esta propiedad se omitirá para obtener instrucciones iniciales del tipo "depart". |
|
Description
|
routes.legs.instructions.description_text | string |
Descripción de texto sin formato de la instrucción al usuario. |
|
Formato de descripción
|
routes.legs.instructions.description_format | string |
Formato de texto para representar la instrucción con elementos resaltados, donde '{key}' indica una parte de la cadena que debe reemplazarse por el contenido definido por la entrada correspondiente a 'key' en 'description_format_replacements'. Esto permite que el cliente dé formato a los elementos descritos por los reemplazos de forma diferente, si lo desea. Las cadenas de clave solo contendrán los caracteres "[a-zA-Z0-9]". '{ }' no se anidará y los caracteres literales '{' y '}' están codificados por las secuencias de escape '{' y '}', respectivamente. |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
Clave correspondiente a una cadena incluida en "{}" en "description_format". |
|
Mensaje de texto
|
routes.legs.instructions.description_format_replacements.text | string |
Texto que se va a usar para reemplazar la subcadena '{key}' en el "description_format". |
|
Tipo
|
routes.legs.instructions.description_format_replacements.type | string |
Valor que indica qué tipo de cosa real se identifica mediante este reemplazo de formato. Esto permite a los clientes de servicio aplicar formato específico de la aplicación si lo desea. | value | description | | ----- | ----------- | | street_name | Nombre de una calle, carretera u otra manera | | exit_number | Número de salida, generalmente desde una rotonda | |
|
Language
|
routes.legs.instructions.description_format_replacements.language | string |
Etiqueta de idioma BCP 47 de IETF que indica en qué idioma se encuentra el "texto" asociado. Tenga en cuenta que esto puede ser diferente del idioma de la descripción circundante: esto es más común cuando el reemplazo es un nombre de lugar en un idioma local, mientras que la descripción está en un idioma diferente. |
|
Tipo
|
routes.legs.instructions.type | string |
Indica el tipo de Instrucción. |
|
Dirección del tipo
|
routes.legs.instructions.type_direction | string |
Indica una dirección que modifica esta instrucción. |
|
Hora de salida
|
routes.route_departure_time | string |
La hora en la que Citymapper cree que el usuario se establecerá en esta ruta, dada la información de salida disponible. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
Hora de llegada
|
routes.route_arrival_time | string |
La hora a la que Citymapper cree que el usuario llegará al final de esta ruta, dada la información de salida disponible y la velocidad de viaje esperada. Esto se calcula suponiendo que el usuario está al principio de la ruta. Los valores actualizados de "route_departure_time" y "route_arrival_time" se devuelven mediante "service/1/live/routeupdates" para reflejar cualquier información de salida actualizada. La hora se expresa en formato ISO 8601 , incluida una fecha, hora y zona horaria en la que se produce el evento. Por ejemplo, "2020-08-19T08:10:42-04:00" expresa el 19 de agosto de 2020 a las 8:10 am en horario de verano del Este. |
|
groups
|
routes.route_metadata.groups | array of object | |
|
Identificador de grupo
|
routes.route_metadata.groups.group_id | string |
Identificador de un grupo en el que se encuentra una ruta. |
|
Grupo
|
routes.route_metadata.groups.group_name | string |
Nombre localizado de un grupo de rutas, por ejemplo, "Tránsito" o "Le metro". |
|
Posición de ruta
|
routes.route_metadata.groups.route_position | integer |
Posición de base cero de una ruta dentro de un grupo específico. |
|
Nombre del perfil
|
routes.route_metadata.profile_name | string |
Nombre localizado legible del identificador 'profile'. |
|
Profile
|
routes.profile | string |
Indica qué enrutamiento "perfil" se usó para calcular esta ruta. Por ejemplo, una respuesta de un punto de conexión de enrutamiento de bicicletas puede devolver varias rutas, una con un perfil "silencioso" y otra con un perfil "rápido". Tenga en cuenta que los nuevos valores se pueden agregar en cualquier momento, por lo que cualquier análisis de código de este campo debe poder controlar valores inesperados. Este valor coincidirá con el parámetro de solicitud "profiles" en los puntos de conexión que admiten la selección de perfiles de enrutamiento específicos. Este valor está pensado para que solo se pueda leer la máquina. Para que un nombre de perfil se muestre a un usuario, use el "profile_name" en el objeto "route_metadata" en su lugar. |
|
Signature
|
routes.signature | string |
Valor que se va a devolver al servidor en llamadas posteriores para hacer referencia a esta ruta (por ejemplo, al solicitar información de salida activa a través de "service/1/live/routeupdates"). Debe tratarse como un valor opaco. |
|
Hora solicitada
|
routes.requested_time | string |
Contiene el parámetro "time" usado como restricción de hora de salida o llegada al obtener indicaciones, si procede. |
|
Tipo de hora solicitado
|
routes.requested_time_type | string |
Contiene el parámetro "time_type" usado para determinar cómo se usará el "tiempo" para restringir las direcciones que se devuelven, si procede. Si no se ha proporcionado ningún parámetro en la solicitud, devolverá el "time_type" usado de forma predeterminada para planear la ruta. |
|
Language
|
language | string |
Etiqueta de idioma BCP 47 de IETF que indica el idioma usado para codificar contenido localizable, como activar instrucciones, en esta respuesta. Esto reflejará un intento de mejor esfuerzo para cumplir cualquier preferencia de idioma expresada por el parámetro de solicitud "language" o "en-US" como valor predeterminado. |