Citymapper(獨立發行商)(預覽版)
Citymapper 允許您為您的產品添加旅程規劃和路線導航。 我們的服務由我們行業領先的全球運輸數據和經過數十億次旅行訓練的自定義路線算法提供支持。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 特洛伊·泰勒 |
| 網站 | https://citymapper.com/ |
| 隱私策略 | https://citymapper.com/api/1/resources?id=citymapper-privacy-policy |
| 類別 | 生活方式和娛樂 |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此 API 的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 取得兩個地點之間的旅行時間 |
決定提出請求時給定兩點之間各種旅行模式的旅行時間。 |
| 取得兩點之間的交通路線 |
計算兩點之間的多條公共交通路線。 預設情況下,結果最多包含 5 個路由。 每個路段都包含幾條路段:通常一條位於路線的起點和終點,中間有“travel_mode”的“步行”,中間至少有一條“travel_mode”的“過境”。 |
| 取得兩點之間的摩托車路線 |
取得兩點之間的摩托車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計值。 (這些結果針對騎手所在的大型內燃機或電動滑板車進行了優化。此呼叫假設騎手在“起點”有一輛踏板車,如果兩者都在 Citymapper 支持的區域內,則提供從那裡到“終點”的電動滑板車路線。 產生的路線應該包含單一踏板車腿,但腿的「path_annotations」屬性可能表示使用者應該在踏板車旁邊行走的路段。 此電話不包含有關踏板車運營商的覆蓋範圍或停車區域的任何信息,但可以使用其他服務電話來這樣做。 |
| 取得兩點之間的步行路線 |
取得兩點之間的步行路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計值。 步行路線應有一條腿,“travel_mode”為“步行”。 如果 Citymapper 無法計算這些點的步行路線(通常是出於覆蓋原因),該服務將返回代碼“400”響應。 此服務「起點」和「終點」之間的最大大圓距離限制為 100 公里。 |
| 取得兩點之間的自行車路線 |
取得兩點之間的自行車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計值。 此呼叫假設騎手在「起點」有一輛自行車,如果兩者都在 Citymapper 支援的區域內,則提供從那裡到「終點」的自行車路線。 產生的路線應該包含單一自行車腿,不過腿的 'path_annotations' 屬性可能會指出使用者應該在自行車旁邊行走的區段。 此電話不包含有關自行車運營商覆蓋範圍或停車區域的任何信息,但可以使用其他服務電話來這樣做。 此服務起點和終點之間的最大大圓距離限制為 200 公里。 |
| 取得兩點之間的行車路線 |
取得兩點之間的汽車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計。 此呼叫假設騎手在「起點」有一輛汽車,如果兩者都在 Citymapper 支援的區域內,則提供從那裡到「終點」的汽車路線。 產生的路線應包含單一車段。 此服務起點和終點之間的最大大圓距離限制為 1000 公里。 |
| 取得兩點之間的計程車路線 |
獲得兩點之間的出租車路線。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 如果上車或下車點不靠近要求的起點和終點座標,則路線可能包含起點和終點步行路段。 回應中的服務將根據當地可用性、一天中的時間以及為您的帳戶配置的計程車服務整合而有所不同。 有兩種建議使用此服務的方式:您可以透過呼叫「?fetch_on_demand_services=true」來請求預先包含即時隨選服務估算的計程車路線;或者,您可以在不獲取將使用非實時路由響應的估計值的情況下提出初始請求,然後立即調用“1/live/routeupdates”以獲取額外的實時估計值。 第一種方法更簡單,但第二種方法可能更適合您的用例。 |
| 取得多條航線的即時出發和可用性資訊 |
這會檢索先前從「方向」端點取得的多條路線的目前和即時出發資訊以及即時隨選報價。 只有至少有一個腿具有可更新詳細資訊的路線才能使用此服務進行更新。 請注意,Citymapper 可能並不總是能夠提供航段的當前時間或實時出發和中斷信息。 成功的回應 (HTTP 代碼 '200') 將為每個 HTTP 回應消耗一個「即時更新」點數。 不成功的通話將不會消耗任何積分。 |
| 取得案例的兩點之間的路由 |
根據提供的案例計算兩點之間的路由。 根據案例,可以提供一或多組路由。 每個組將包含多條路線。 每條路線將包含一條或多條路段。 |
| 在兩點之間獲取租用的自行車路線 |
在兩點之間獲得一條租用的自行車路線,包括任何初始和最後的步行。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 此呼叫可以以多種不同的方式使用: 使用指定品牌的任何自行車 這是最簡單的呼叫,只需要“開始”、“結束”和“brand_id”。 Citymapper 假設用戶處於“起點”,並在可能的情況下選擇指定品牌的自行車。 在指定地點使用自行車透過在「開始」、「結束」和「brand_id」中新增「original_vehicle_location」,Citymapper 會規劃一條假設自行車位於給定位置的路線。 更新進行中的路線 為了檢索更新的路由,其中包括從使用者目前位置重新路由(如果使用者已偏離計劃的路由),呼叫者可以新增「current_location」和「ride_state」屬性,這指示應圍繞使用者的「current_location」重新路由產生路由的哪一條。 |
| 在兩點之間獲得租用的摩托車路線 |
在兩點之間獲得租用的摩托車路線,包括任何初始和最後步行。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 (這些結果針對騎手所在的大型內燃機或電動滑板車進行了優化。 便條: 生成的路線目前假設用戶可以直接騎行到指定的“終點”位置,而不考慮任何停車或覆蓋區域。 因此,生成的路線將僅包含“travel_mode”“步行”的初始航段和“travel_mode”“self_piloted”的第二條航段。 未來的更新將納入停車和覆蓋區域,並增加最後一條“步行”路段。 此呼叫可以以多種不同的方式使用: 使用指定品牌的任何踏板車 這是最簡單的呼叫,只需要“開始”、“結束”和“brand_id”。 Citymapper 假設用戶處於“起點”,並在可能的情況下選擇指定品牌的踏板車。 在指定地點使用滑板車 透過在「開始」、「結束」和「brand_id」中新增「original_vehicle_location」,Citymapper 規劃了一條假設踏板車位於給定位置的路線。 更新進行中的路線 為了檢索更新的路由,其中包括從使用者目前位置重新路由(如果使用者已偏離計劃的路由),呼叫者可以新增「current_location」和「ride_state」屬性,這指示應圍繞使用者的「current_location」重新路由產生路由的哪一條。 |
| 獲取兩點之間的電動滑板車路線 |
取得兩點之間的滑板車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計。 (這些結果針對騎手站立的小型電池供電踏板車進行了優化。此呼叫假設騎手在“起點”有一輛踏板車,如果兩者都在 Citymapper 支持的區域內,則提供從那裡到“終點”的電動滑板車路線。 產生的路線應該包含單一踏板車腿,但腿的「path_annotations」屬性可能表示使用者應該在踏板車旁邊行走的路段。 此電話不包含有關踏板車運營商的覆蓋範圍或停車區域的任何信息,但可以使用其他服務電話來這樣做。 成功的回應 (HTTP 代碼 '200') 會針對每個 HTTP 回應消耗一個「Scooter Route」點數 (如果使用「reroute_signature」,則會消耗一個「Scooter Reroute」點數)。 不成功的通話將不會消耗任何積分。 |
| 獲取兩點之間租用的電動滑板車路線 |
在兩點之間獲得租用的電動滑板車路線,包括任何初始和最後步行。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 這些結果針對騎手所站立的小型電池供電踏板車進行了優化。 此呼叫可以以多種不同的方式使用: 使用指定品牌的任何踏板車 這是最簡單的呼叫,只需要“開始”、“結束”和“brand_id”。 Citymapper 假設用戶處於“起點”,並在可能的情況下選擇指定品牌的踏板車。 在指定地點使用滑板車 透過在「開始」、「結束」和「brand_id」中新增「original_vehicle_location」,Citymapper 規劃了一條假設踏板車位於給定位置的路線。 更新進行中的路線 為了檢索更新的路由,其中包括從使用者目前位置重新路由(如果使用者已偏離計劃的路由),呼叫者可以新增「current_location」和「ride_state」屬性,這指示應圍繞使用者的「current_location」重新路由產生路由的哪一條。 |
取得兩個地點之間的旅行時間
決定提出請求時給定兩點之間各種旅行模式的旅行時間。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | string |
行程的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應為十進位,且只會使用前 6 位精確度。 |
|
結束
|
end | True | string |
行程的地理終點,採用 WGS84 “緯度,經度” 格式。 座標應為十進位,且只會使用前 6 位精確度。 |
|
旅行類型
|
traveltime_types | array |
嘗試要求的不同旅行時間類型的逗號分隔清單。 每個請求值對應於響應中的特定字段(只有當 Citymapper 能夠計算該旅行時間類型的時間時,才會出現響應字段)。 |價值 |回應屬性 |產品描述 | |----- |----------------- |------------| |步行 |walk_travel_time_minutes |步行 | |過境 |transit_time_minutes |公共交通出行 | |自行車 |bike_time_minutes |自行車旅行(全程騎行) | |滑板車 |scooter_time_minutes |站立式電動滑板車旅行(全程騎行) | |摩托車 |motorscooter_time_minutes |坐式摩托車旅行(全程騎行) | |汽車 |car_time_minutes |汽車旅行(全程騎行)。 僅適用於企業計劃 |當此欄位省略或空白時,將使用預設值「步行,交通」。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
步行時間
|
walk_travel_time_minutes | integer |
兩個給定點之間的估計步行時間(以分鐘為單位)。 |
|
運輸時間
|
transit_time_minutes | integer |
兩個給定點之間的估計公共交通旅行時間(以分鐘為單位)。 |
|
騎自行車時間
|
bike_time_minutes | integer |
兩點之間的預計自行車行駛時間(以分鐘為單位)。 |
|
滑板車時間
|
scooter_time_minutes | integer |
電動滑板車在兩點之間的估計旅行時間(以分鐘為單位)。 |
|
摩托車時間
|
motorscooter_time_minutes | integer |
兩點之間的估計摩托車行駛時間(以分鐘為單位)。 |
|
行車時間
|
car_time_minutes | integer |
兩點之間的估計汽車旅行時間(以分鐘為單位)。 |
取得兩點之間的交通路線
計算兩點之間的多條公共交通路線。 預設情況下,結果最多包含 5 個路由。 每個路段都包含幾條路段:通常一條位於路線的起點和終點,中間有“travel_mode”的“步行”,中間至少有一條“travel_mode”的“過境”。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
Time
|
time | string |
獲取路線時用作出發或到達時間限制的時間。 時間以 ISO 8601 格式表示,包括日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
|
時間類型
|
time_type | string |
當給出「時間」值時,這決定了如何使用時間來約束傳回的方向。 如果未指定,則會使用 'depart_approximate'。 如果沒有給出“時間”,這就沒有效果。 |價值 |產品描述 | |----- |----------- | |抵達 |選擇的路線可讓使用者在「時間」或之前到達目的地 | |出發 |選擇方向時假設用戶在“時間”之後儘快離開其原點 | |depart_approximate |與“出發”類似,但允許較晚的出發,以便返回更可取的選擇,即使他們離開晚一點。 這是 Citymapper 在未指定時間時選擇路線的默認方式 | |
|
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
限制
|
limit | integer |
要返回的路由數目上限。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
取得兩點之間的摩托車路線
取得兩點之間的摩托車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計值。 (這些結果針對騎手所在的大型內燃機或電動滑板車進行了優化。此呼叫假設騎手在“起點”有一輛踏板車,如果兩者都在 Citymapper 支持的區域內,則提供從那裡到“終點”的電動滑板車路線。 產生的路線應該包含單一踏板車腿,但腿的「path_annotations」屬性可能表示使用者應該在踏板車旁邊行走的路段。 此電話不包含有關踏板車運營商的覆蓋範圍或停車區域的任何信息,但可以使用其他服務電話來這樣做。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
重新路由簽章
|
reroute_signature | string |
重新路由 (要求更新使用者更新位置的先前回應) 時,此值應設定為原始路由中提供的「簽章」。 這樣可以更有效地確定更新的路線。 此值必須以 URL 編碼。 提供此參數時,「current_location」(如果適用)或「開始」位置應設定為使用者的最新位置。 當包含此參數時,Citymapper 可能不會在請求與原始請求顯著不同時返回結果,例如,如果“結束”位置不同,或者距離原始請求已經過去了 1 小時以上。 |
|
|
開始軸承
|
start_bearing | integer |
從北順時針方向的角度介於 0 到 359 之間,其中北為 0,東為 90。 此方位用於影響初始指令文本和/或路由,最常見的是避免用戶被要求掉頭,如果繼續使用當前方位給出類似的路線。 只有在您希望影響路線的初始行進方向時,才應提供此選項。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
取得兩點之間的步行路線
取得兩點之間的步行路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計值。 步行路線應有一條腿,“travel_mode”為“步行”。 如果 Citymapper 無法計算這些點的步行路線(通常是出於覆蓋原因),該服務將返回代碼“400”響應。 此服務「起點」和「終點」之間的最大大圓距離限制為 100 公里。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
Profiles
|
profiles | string |
指示在計算步行路線時要使用的「設定檔」。 每個設定檔都可以產生不同的路由選項,因此請求更多設定檔通常會提供更多選項。 請注意,有時某些產生的佈線會相同(在一條佈線在多種方式上是最佳的),並且設定檔可能並不總是產生佈線。 並非所有設定檔都可用於所有起點和終點路線。 無法使用的設定檔將從回應中省略。 |價值 |產品描述 | |----- |----------- | |快速 |預設設定檔,嘗試尋找最快的合理路線 | |main_roads |試圖避開後街和公園 |如果未指定設定檔,則會使用「快速」。 |
|
|
重新路由簽章
|
reroute_signature | string |
重新路由 (要求更新使用者更新位置的先前回應) 時,此值應設定為原始路由中提供的「簽章」。 這樣可以更有效地確定更新的路線。 此值必須以 URL 編碼。 提供此參數時,「current_location」(如果適用)或「開始」位置應設定為使用者的最新位置。 當包含此參數時,Citymapper 可能不會在請求與原始請求顯著不同時返回結果,例如,如果“結束”位置不同,或者距離原始請求已經過去了 1 小時以上。 |
|
|
開始軸承
|
start_bearing | integer |
從北順時針方向的角度介於 0 到 359 之間,其中北為 0,東為 90。 此方位用於影響初始指令文本和/或路由,最常見的是避免用戶被要求掉頭,如果繼續使用當前方位給出類似的路線。 只有在您希望影響路線的初始行進方向時,才應提供此選項。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
取得兩點之間的自行車路線
取得兩點之間的自行車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計值。 此呼叫假設騎手在「起點」有一輛自行車,如果兩者都在 Citymapper 支援的區域內,則提供從那裡到「終點」的自行車路線。 產生的路線應該包含單一自行車腿,不過腿的 'path_annotations' 屬性可能會指出使用者應該在自行車旁邊行走的區段。 此電話不包含有關自行車運營商覆蓋範圍或停車區域的任何信息,但可以使用其他服務電話來這樣做。 此服務起點和終點之間的最大大圓距離限制為 200 公里。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
Profiles
|
profiles | string |
指示在計算自行車方向時要使用的「設定檔」。 每個設定檔都可以產生不同的路由選項,因此請求更多設定檔通常會提供更多選項。 請注意,有時某些產生的佈線會相同(在一條佈線在多種方式上是最佳的),並且設定檔可能並不總是產生佈線。 |價值 |產品描述 | |----- |----------- | |安靜 |嘗試使用交通較少的道路 | |常規 |預設設定檔會平衡流量與直接性 | |快速 |嘗試找到最短的合理路線 |如果未指定設定檔,則會使用「一般」。 |
|
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
重新路由簽章
|
reroute_signature | string |
重新路由 (要求更新使用者更新位置的先前回應) 時,此值應設定為原始路由中提供的「簽章」。 這樣可以更有效地確定更新的路線。 此值必須以 URL 編碼。 提供此參數時,「current_location」(如果適用)或「開始」位置應設定為使用者的最新位置。 當包含此參數時,Citymapper 可能不會在請求與原始請求顯著不同時返回結果,例如,如果“結束”位置不同,或者距離原始請求已經過去了 1 小時以上。 |
|
|
開始軸承
|
start_bearing | integer |
從北順時針方向的角度介於 0 到 359 之間,其中北為 0,東為 90。 此方位用於影響初始指令文本和/或路由,最常見的是避免用戶被要求掉頭,如果繼續使用當前方位給出類似的路線。 只有在您希望影響路線的初始行進方向時,才應提供此選項。 |
|
|
過去的地點
|
past_loc_coords | string |
可選參數,以改善重新路由行為。 最多 10 個使用者過去位置的座標以逗號分隔的清單。 座標必須採用 WGS84 'latitude,longitude' 格式。 座標必須為十進位,且只會使用前 6 位精確度。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置年齡
|
past_loc_ages | string |
可選參數,以改善重新路由行為。 用戶過去位置中最多 10 個的年齡以逗號分隔的列表形式。 年齡必須以整數秒為單位,自目前位置以來。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_coords」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置準確度
|
past_loc_accuracies | string |
可選參數,以改善重新路由行為。 最多 10 個用戶過去位置的 GPS 精度以逗號分隔的列表形式。 準確度必須以整數公尺為單位。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_coords」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
取得兩點之間的行車路線
取得兩點之間的汽車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計。 此呼叫假設騎手在「起點」有一輛汽車,如果兩者都在 Citymapper 支援的區域內,則提供從那裡到「終點」的汽車路線。 產生的路線應包含單一車段。 此服務起點和終點之間的最大大圓距離限制為 1000 公里。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
取得兩點之間的計程車路線
獲得兩點之間的出租車路線。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 如果上車或下車點不靠近要求的起點和終點座標,則路線可能包含起點和終點步行路段。 回應中的服務將根據當地可用性、一天中的時間以及為您的帳戶配置的計程車服務整合而有所不同。 有兩種建議使用此服務的方式:您可以透過呼叫「?fetch_on_demand_services=true」來請求預先包含即時隨選服務估算的計程車路線;或者,您可以在不獲取將使用非實時路由響應的估計值的情況下提出初始請求,然後立即調用“1/live/routeupdates”以獲取額外的實時估計值。 第一種方法更簡單,但第二種方法可能更適合您的用例。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
擷取網域服務
|
fetch_on_demand_services | string |
如果設為「true」,系統會要求您的計程車服務整合工具提供額外資訊,以提供更準確、更完整的定價、持續時間和服務供應情況,並以隨選階段的可更新詳細資料傳回。 為了提供這一點,路線的起點和終點位置需要傳輸到這些第三方服務,包括其中一個是用戶當前或最近的位置。 請注意,您可能需要獲得最終用戶的明確知情同意,才能根據適用的法律和法規將此設定為「true」。 如果設定為「false」或省略,則不會向任何第三方服務提出任何請求。 |
|
|
品牌 ID
|
brand_ids | array |
以逗號分隔的品牌 ID 清單,以限制此路線請求。 如果省略(預設),則所有可用的品牌都會傳回計程車路線。 |
|
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
取得多條航線的即時出發和可用性資訊
這會檢索先前從「方向」端點取得的多條路線的目前和即時出發資訊以及即時隨選報價。 只有至少有一個腿具有可更新詳細資訊的路線才能使用此服務進行更新。 請注意,Citymapper 可能並不總是能夠提供航段的當前時間或實時出發和中斷信息。 成功的回應 (HTTP 代碼 '200') 將為每個 HTTP 回應消耗一個「即時更新」點數。 不成功的通話將不會消耗任何積分。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
簽名
|
signatures | True | array of string |
先前取得路由的「簽章」屬性陣列 |
|
擷取隨選服務
|
fetch_on_demand_services | boolean |
使用包含隨選路段和可更新詳細資訊的路線(例如來自計程車路線服務)的一或多個簽名進行更新時,如果將其設定為「true」,則將要求計程車服務整合提供其他資訊,以提供更準確、更完整的定價、持續時間和服務可用性。 為了提供這一點,原始路線的起點和終點位置需要傳輸到這些第三方服務,包括其中一個是用戶當前或最近的位置。 請注意,您可能需要獲得最終用戶的明確知情同意,才能根據適用的法律和法規將此設定為「true」。 如果設定為「false」或省略,則不會向任何第三方服務提出任何請求。 如果無法為未將此參數設定為 'true' 的支路產生任何更新,則回應會在可更新的詳細資料中指出這一點。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
route_updates
|
route_updates | array of object | |
|
腿部更新
|
route_updates.leg_updates | array of |
這是支路可更新詳細資料物件的平行陣列,一個用於要更新的原始佈線中的每個支路。 與步行段相對應的將為空,但與過境段相對應的詳細信息將包含更新的出發信息。 |
|
出發時間
|
route_updates.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者在請求時位於路由的開頭進行計算的。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
route_updates.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者在請求時位於路由的開頭進行計算的。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
持續時間
|
route_updates.route_duration_seconds | integer |
遍歷整個路線的整體預估時間(以秒為單位)。 此值會取代原始路線中的「duration_seconds」值,因為會重新計算以使用此路線更新回應中包含的特定出發資訊。 在極少數情況下,當無法計算持續時間時,可能會省略,例如,如果路由無法在指定時間完成,因為涉及的服務未執行。 |
|
持續時間準確性
|
route_updates.route_duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
請求簽名
|
route_updates.request_signature | string |
這是更新請求中的路由「簽章」,應該用來將此更新與正確的路由建立關聯。 |
取得案例的兩點之間的路由
根據提供的案例計算兩點之間的路由。 根據案例,可以提供一或多組路由。 每個組將包含多條路線。 每條路線將包含一條或多條路段。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
案例識別碼
|
scenario_id | True | string |
路線的案例 ID。 |
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
Time
|
time | string |
獲取路線時用作出發或到達時間限制的時間。 時間以 ISO 8601 格式表示,包括日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
|
時間類型
|
time_type | string |
當給出「時間」值時,這決定了如何使用時間來約束傳回的方向。 如果未指定,則會使用 'depart_approximate'。 如果沒有給出“時間”,這就沒有效果。 |價值 |產品描述 | |----- |----------- | |抵達 |選擇的路線可讓使用者在「時間」或之前到達目的地 | |出發 |選擇方向時假設用戶在“時間”之後儘快離開其原點 | |depart_approximate |與“出發”類似,但允許較晚的出發,以便返回更可取的選擇,即使他們離開晚一點。 這是 Citymapper 在未指定時間時選擇路線的默認方式 | |
|
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
在兩點之間獲取租用的自行車路線
在兩點之間獲得一條租用的自行車路線,包括任何初始和最後的步行。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 此呼叫可以以多種不同的方式使用: 使用指定品牌的任何自行車 這是最簡單的呼叫,只需要“開始”、“結束”和“brand_id”。 Citymapper 假設用戶處於“起點”,並在可能的情況下選擇指定品牌的自行車。 在指定地點使用自行車透過在「開始」、「結束」和「brand_id」中新增「original_vehicle_location」,Citymapper 會規劃一條假設自行車位於給定位置的路線。 更新進行中的路線 為了檢索更新的路由,其中包括從使用者目前位置重新路由(如果使用者已偏離計劃的路由),呼叫者可以新增「current_location」和「ride_state」屬性,這指示應圍繞使用者的「current_location」重新路由產生路由的哪一條。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
品牌 ID
|
brand_id | True | string |
要用於此路線的自行車品牌 ID。 這是必要的,以確定可用自行車的位置以及任何相關的覆蓋範圍和停車限制。 |
|
State
|
ride_state | string |
指出使用者在路線上的位置。 如果省略,則使用「walking_to_vehicle」。 此屬性與「current_location」一起允許擷取反映使用者目前進度的更新路由。 |價值 |產品描述 | |----- |----------- | |walking_to_vehicle |表示使用者正在步行取車 | |騎術 |表示使用者正在乘車 | |walking_to_end |表示使用者已離開車輛並正在步行前往目的地 | |
|
|
目前位置
|
current_location | string |
使用者目前的位置,以便根據使用者的位置更新路線。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 此參數用於獲取更新的路由,如果用戶偏離路由中給出的路徑,則反映用戶的實際位置。 如果提供此位置,則傳回的路由將包含此位置。 路線的哪個路段將包含此位置由「ride_state」參數的值決定。 |
|
|
開始位置
|
ride_start_location | string |
要使用的車輛的位置,在車輛開始時,用戶沿著路線行駛的一部分。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 當「ride_state」為「騎乘」或「walking_to_end」時,必須提供此資訊。 如果在「ride_state」為「walking_to_vehicle」(或未指定)時未提供,Citymapper 將嘗試尋找屬於指定「brand_id」的最合適車輛。 為了相容性,「original_vehicle_location」是此參數的別名 |
|
|
結束位置
|
ride_end_location | string |
車輛在車輛騎行結束時下車的位置,是使用者沿路線行程的一部分。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 當「ride_state」為「walking_to_end」時,必須提供此資訊。 在所有其他狀態下,都會忽略此參數。 |
|
|
Profiles
|
profiles | string |
指示在計算自行車方向時要使用的「設定檔」。 每個設定檔都可以產生不同的路由選項,因此請求更多設定檔通常會提供更多選項。 請注意,有時某些產生的佈線會相同(在一條佈線在多種方式上是最佳的),並且設定檔可能並不總是產生佈線。 |價值 |產品描述 | |----- |----------- | |安靜 |嘗試使用交通較少的道路 | |常規 |預設設定檔會平衡流量與直接性 | |快速 |嘗試找到最短的合理路線 |如果未指定設定檔,則會使用「一般」。 |
|
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
重新路由簽章
|
reroute_signature | string |
重新路由 (要求更新使用者更新位置的先前回應) 時,此值應設定為原始路由中提供的「簽章」。 這樣可以更有效地確定更新的路線。 此值必須以 URL 編碼。 提供此參數時,「current_location」(如果適用)或「開始」位置應設定為使用者的最新位置。 當包含此參數時,Citymapper 可能不會在請求與原始請求顯著不同時返回結果,例如,如果“結束”位置不同,或者距離原始請求已經過去了 1 小時以上。 |
|
|
開始軸承
|
start_bearing | integer |
從北順時針方向的角度介於 0 到 359 之間,其中北為 0,東為 90。 此方位用於影響初始指令文本和/或路由,最常見的是避免用戶被要求掉頭,如果繼續使用當前方位給出類似的路線。 只有在您希望影響路線的初始行進方向時,才應提供此選項。 |
|
|
過去的地點
|
past_loc_coords | string |
可選參數,以改善重新路由行為。 最多 10 個使用者過去位置的座標以逗號分隔的清單。 座標必須採用 WGS84 'latitude,longitude' 格式。 座標必須為十進位,且只會使用前 6 位精確度。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置年齡
|
past_loc_ages | string |
可選參數,以改善重新路由行為。 用戶過去位置中最多 10 個的年齡以逗號分隔的列表形式。 年齡必須以整數秒為單位,自目前位置以來。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_coords」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置準確度
|
past_loc_accuracies | string |
可選參數,以改善重新路由行為。 最多 10 個用戶過去位置的 GPS 精度以逗號分隔的列表形式。 準確度必須以整數公尺為單位。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_coords」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
在兩點之間獲得租用的摩托車路線
在兩點之間獲得租用的摩托車路線,包括任何初始和最後步行。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 (這些結果針對騎手所在的大型內燃機或電動滑板車進行了優化。 便條: 生成的路線目前假設用戶可以直接騎行到指定的“終點”位置,而不考慮任何停車或覆蓋區域。 因此,生成的路線將僅包含“travel_mode”“步行”的初始航段和“travel_mode”“self_piloted”的第二條航段。 未來的更新將納入停車和覆蓋區域,並增加最後一條“步行”路段。 此呼叫可以以多種不同的方式使用: 使用指定品牌的任何踏板車 這是最簡單的呼叫,只需要“開始”、“結束”和“brand_id”。 Citymapper 假設用戶處於“起點”,並在可能的情況下選擇指定品牌的踏板車。 在指定地點使用滑板車 透過在「開始」、「結束」和「brand_id」中新增「original_vehicle_location」,Citymapper 規劃了一條假設踏板車位於給定位置的路線。 更新進行中的路線 為了檢索更新的路由,其中包括從使用者目前位置重新路由(如果使用者已偏離計劃的路由),呼叫者可以新增「current_location」和「ride_state」屬性,這指示應圍繞使用者的「current_location」重新路由產生路由的哪一條。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
品牌 ID
|
brand_id | True | string |
要用於此路線的踏板車品牌的 ID。 這是必要的,以確定可用踏板車的位置以及任何相關的覆蓋範圍和停車限制。 |
|
State
|
ride_state | string |
指出使用者在路線上的位置。 如果省略,則使用「walking_to_vehicle」。 此屬性與「current_location」一起允許擷取反映使用者目前進度的更新路由。 |價值 |產品描述 | |----- |----------- | |walking_to_vehicle |表示使用者正在步行取車 | |騎術 |表示使用者正在乘車 | |walking_to_end |表示使用者已離開車輛並正在步行前往目的地 | |
|
|
目前位置
|
current_location | string |
使用者目前的位置,以便根據使用者的位置更新路線。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 此參數用於獲取更新的路由,如果用戶偏離路由中給出的路徑,則反映用戶的實際位置。 如果提供此位置,則傳回的路由將包含此位置。 路線的哪個路段將包含此位置由「ride_state」參數的值決定。 |
|
|
開始位置
|
ride_start_location | string |
要使用的車輛的位置,在車輛開始時,用戶沿著路線行駛的一部分。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 當「ride_state」為「騎乘」或「walking_to_end」時,必須提供此資訊。 如果在「ride_state」為「walking_to_vehicle」(或未指定)時未提供,Citymapper 將嘗試尋找屬於指定「brand_id」的最合適車輛。 為了相容性,「original_vehicle_location」是此參數的別名 |
|
|
結束位置
|
ride_end_location | string |
車輛在車輛騎行結束時下車的位置,是使用者沿路線行程的一部分。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 當「ride_state」為「walking_to_end」時,必須提供此資訊。 在所有其他狀態下,都會忽略此參數。 |
|
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
重新路由簽章
|
reroute_signature | string |
重新路由 (要求更新使用者更新位置的先前回應) 時,此值應設定為原始路由中提供的「簽章」。 這樣可以更有效地確定更新的路線。 此值必須以 URL 編碼。 提供此參數時,「current_location」(如果適用)或「開始」位置應設定為使用者的最新位置。 當包含此參數時,Citymapper 可能不會在請求與原始請求顯著不同時返回結果,例如,如果“結束”位置不同,或者距離原始請求已經過去了 1 小時以上。 |
|
|
開始軸承
|
start_bearing | integer |
從北順時針方向的角度介於 0 到 359 之間,其中北為 0,東為 90。 此方位用於影響初始指令文本和/或路由,最常見的是避免用戶被要求掉頭,如果繼續使用當前方位給出類似的路線。 只有在您希望影響路線的初始行進方向時,才應提供此選項。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
獲取兩點之間的電動滑板車路線
取得兩點之間的滑板車路線,提供足夠的資訊以將其呈現在地圖上,以及持續時間估計。 (這些結果針對騎手站立的小型電池供電踏板車進行了優化。此呼叫假設騎手在“起點”有一輛踏板車,如果兩者都在 Citymapper 支持的區域內,則提供從那裡到“終點”的電動滑板車路線。 產生的路線應該包含單一踏板車腿,但腿的「path_annotations」屬性可能表示使用者應該在踏板車旁邊行走的路段。 此電話不包含有關踏板車運營商的覆蓋範圍或停車區域的任何信息,但可以使用其他服務電話來這樣做。 成功的回應 (HTTP 代碼 '200') 會針對每個 HTTP 回應消耗一個「Scooter Route」點數 (如果使用「reroute_signature」,則會消耗一個「Scooter Reroute」點數)。 不成功的通話將不會消耗任何積分。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
重新路由簽章
|
reroute_signature | string |
重新路由 (要求更新使用者更新位置的先前回應) 時,此值應設定為原始路由中提供的「簽章」。 這樣可以更有效地確定更新的路線。 此值必須以 URL 編碼。 提供此參數時,「current_location」(如果適用)或「開始」位置應設定為使用者的最新位置。 當包含此參數時,Citymapper 可能不會在請求與原始請求顯著不同時返回結果,例如,如果“結束”位置不同,或者距離原始請求已經過去了 1 小時以上。 |
|
|
開始軸承
|
start_bearing | integer |
從北順時針方向的角度介於 0 到 359 之間,其中北為 0,東為 90。 此方位用於影響初始指令文本和/或路由,最常見的是避免用戶被要求掉頭,如果繼續使用當前方位給出類似的路線。 只有在您希望影響路線的初始行進方向時,才應提供此選項。 |
|
|
過去的地點
|
past_loc_coords | string |
可選參數,以改善重新路由行為。 最多 10 個使用者過去位置的座標以逗號分隔的清單。 座標必須採用 WGS84 'latitude,longitude' 格式。 座標必須為十進位,且只會使用前 6 位精確度。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置年齡
|
past_loc_ages | string |
可選參數,以改善重新路由行為。 用戶過去位置中最多 10 個的年齡以逗號分隔的列表形式。 年齡必須以整數秒為單位,自目前位置以來。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_coords」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置準確度
|
past_loc_accuracies | string |
可選參數,以改善重新路由行為。 最多 10 個用戶過去位置的 GPS 精度以逗號分隔的列表形式。 準確度必須以整數公尺為單位。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_coords」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |
獲取兩點之間租用的電動滑板車路線
在兩點之間獲得租用的電動滑板車路線,包括任何初始和最後步行。 產生的路線提供了足夠的資訊來將其呈現在地圖上,以及持續時間估計值。 這些結果針對騎手所站立的小型電池供電踏板車進行了優化。 此呼叫可以以多種不同的方式使用: 使用指定品牌的任何踏板車 這是最簡單的呼叫,只需要“開始”、“結束”和“brand_id”。 Citymapper 假設用戶處於“起點”,並在可能的情況下選擇指定品牌的踏板車。 在指定地點使用滑板車 透過在「開始」、「結束」和「brand_id」中新增「original_vehicle_location」,Citymapper 規劃了一條假設踏板車位於給定位置的路線。 更新進行中的路線 為了檢索更新的路由,其中包括從使用者目前位置重新路由(如果使用者已偏離計劃的路由),呼叫者可以新增「current_location」和「ride_state」屬性,這指示應圍繞使用者的「current_location」重新路由產生路由的哪一條。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
開始
|
start | True | array |
路線的地理起點,採用 WGS84 “緯度,經度” 格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
結束
|
end | True | array |
路線的地理末端,採用 WGS84 “緯度,經度”格式。 座標應以小數點為單位,並且僅使用小數點後的前 6 位。 |
|
品牌 ID
|
brand_id | True | string |
用於此路線的電動滑板車品牌的 ID。 這是必要的,以確定可用踏板車的位置以及任何相關的覆蓋範圍和停車限制。 |
|
State
|
ride_state | string |
指出使用者在路線上的位置。 如果省略,則使用「walking_to_vehicle」。 此屬性與「current_location」一起允許擷取反映使用者目前進度的更新路由。 |價值 |產品描述 | |----- |----------- | |walking_to_vehicle |表示使用者正在步行取車 | |騎術 |表示使用者正在乘車 | |walking_to_end |表示使用者已離開車輛並正在步行前往目的地 | |
|
|
目前位置
|
current_location | string |
使用者目前的位置,以便根據使用者的位置更新路線。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 此參數用於獲取更新的路由,如果用戶偏離路由中給出的路徑,則反映用戶的實際位置。 如果提供此位置,則傳回的路由將包含此位置。 路線的哪個路段將包含此位置由「ride_state」參數的值決定。 |
|
|
開始位置
|
ride_start_location | string |
要使用的車輛的位置,在車輛開始時,用戶沿著路線行駛的一部分。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 當「ride_state」為「騎乘」或「walking_to_end」時,必須提供此資訊。 如果在「ride_state」為「walking_to_vehicle」(或未指定)時未提供,Citymapper 將嘗試尋找屬於指定「brand_id」的最合適車輛。 為了相容性,「original_vehicle_location」是此參數的別名 |
|
|
結束位置
|
ride_end_location | string |
車輛在車輛騎行結束時下車的位置,是使用者沿路線行程的一部分。 以 WGS84 '緯度,經度' 格式提供。 座標應為十進位,且只會使用前 6 位精確度。 當「ride_state」為「walking_to_end」時,必須提供此資訊。 在所有其他狀態下,都會忽略此參數。 |
|
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出使用者的語言喜好設定。 提供時,回應將包含「language」屬性,指出回應中任何可本地化元素 (例如轉動指示) 所使用的語言。 此語言將盡最大努力滿足表達的偏好設定,但它可能包含請求中未表達的值(這通常是「en-US」作為後援)。 請注意,語言偏好通常只會影響 Citymapper 生成的內容,例如轉彎說明。 外部內容(例如站點名稱和狀態描述)通常會以其原始語言傳遞。 |
|
|
重新路由簽章
|
reroute_signature | string |
重新路由 (要求更新使用者更新位置的先前回應) 時,此值應設定為原始路由中提供的「簽章」。 這樣可以更有效地確定更新的路線。 此值必須以 URL 編碼。 提供此參數時,「current_location」(如果適用)或「開始」位置應設定為使用者的最新位置。 當包含此參數時,Citymapper 可能不會在請求與原始請求顯著不同時返回結果,例如,如果“結束”位置不同,或者距離原始請求已經過去了 1 小時以上。 |
|
|
開始軸承
|
start_bearing | integer |
從北順時針方向的角度介於 0 到 359 之間,其中北為 0,東為 90。 此方位用於影響初始指令文本和/或路由,最常見的是避免用戶被要求掉頭,如果繼續使用當前方位給出類似的路線。 只有在您希望影響路線的初始行進方向時,才應提供此選項。 |
|
|
過去的地點
|
past_loc_coords | string |
可選參數,以改善重新路由行為。 最多 10 個使用者過去位置的座標以逗號分隔的清單。 座標必須採用 WGS84 'latitude,longitude' 格式。 座標必須為十進位,且只會使用前 6 位精確度。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置年齡
|
past_loc_ages | string |
可選參數,以改善重新路由行為。 用戶過去位置中最多 10 個的年齡以逗號分隔的列表形式。 年齡必須以整數秒為單位,自目前位置以來。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_coords」和「past_loc_accuracies」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
|
|
過去的位置準確度
|
past_loc_accuracies | string |
可選參數,以改善重新路由行為。 最多 10 個用戶過去位置的 GPS 精度以逗號分隔的列表形式。 準確度必須以整數公尺為單位。 必須按時間順序排序,最近的最後一次。 必須同時提供「past_loc_ages」和「past_loc_coords」。 伺服器最多只會考慮 10 個位置,如果提供超過 10 個位置,則會忽略最近的位置。 伺服器可能會忽略任何超過 30 秒或相距少於 1 秒的位置。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
路線
|
routes | array of object | |
|
緯度
|
routes.start.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.start.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
緯度
|
routes.end.coordinates.lat | float |
WGS84 編碼中的緯度,十進位精度為 6 位。 |
|
經度
|
routes.end.coordinates.lon | float |
WGS84 編碼的經度,十進制精度為 6 位。 |
|
距離(以公尺為單位)
|
routes.distance_meters | integer |
整條路線的總距離,以米為單位。 |
|
持續時間
|
routes.duration_seconds | integer |
根據回應中選取的車輛或出發,遍歷整個路線的整體預估時間(以秒為單位)。 |
|
持續時間精度
|
routes.duration_accuracy | string |
Citymapper 對如何向用戶顯示“duration_seconds”的準確性級別的評估。 這主要基於用於時間的出發“類型”,但它涉及隨著時間的推移為 Citymapper 應用程序開發的額外啟發式方法。 如果未提供此欄位,則應使用值 'scheduled'。 |價值 |產品描述 | |----- |----------- | |預估 |應被視為近似的持續時間,因為它的計算比平時涉及更多的不確定性。 這是最低的準確度。 | |預定 |正常持續時間,通常基於已發布的時間表資訊。 | |直播 |持續時間主要基於實時/實時出發信息。 這是最高的準確度。 | |
|
格式化
|
routes.price.formatted | string |
指定價格為格式化字串。 依預設,這是路由發生區域的本機貨幣格式。 |
|
總數
|
routes.price.amount | string |
價格為十進位值,編碼為字串以避免浮點精度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍最小值
|
routes.price.amount_range_minimum | string |
如果此 Price 代表可能值的範圍,則最低價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 |
|
金額範圍 最大值
|
routes.price.amount_range_maximum | string |
如果此 Price 代表可能值的範圍,則最高價格會以十進位值的形式,編碼為字串,以避免浮點精確度問題。 它不會包含貨幣符號,並且無論地區如何,主要單位和次要單位之間的分隔符將始終為“.”。 如果範圍是開放式的,則可能不包括在內 |
|
貨幣
|
routes.price.currency | string |
給出價格的貨幣,採用三個字母的 ISO 4217 形式。 |
|
需求乘數
|
routes.price.demand_multipler | float |
表示由於需求,價格高於平常,通常是計程車(隨選)路段。 在極少數情況下可能小於 1.0 |
|
二氧化碳當量排放
|
routes.emissions_grams_co2e | float |
該路線溫室氣體排放量的估計值,以二氧化碳當量 (CO2e) 克數表示。 |
|
腿
|
routes.legs | array of object |
構成路線的路段陣列,按照它們應穿越的順序排列。 每條有效路線都至少有一個。 |
|
出行模式
|
routes.legs.travel_mode | string |
旅行模式。 |
|
持續時間
|
routes.legs.duration_seconds | integer |
穿越該航段所需的時間,不包括開始時的任何等待或登機時間。 在極少數情況下,當無法計算持續時間時,可能會省略。 |
|
路徑
|
routes.legs.path | string |
腿經過的地理路徑,作為一系列以 Google 折線格式編碼的 WGS84 座標,十進位精度為 5 位數。 例如,值 '_flyHbjPDZBTBNDJ' 會編碼下列一系列 (緯度、經度) 座標: '' [(51.51344, -0.08882), (51.51341, -0.08896), (51.51339, -0.08907), (51.51337, -0.08915), (51.51334, -0.08921)] '' |
|
操作說明
|
routes.legs.instructions | array of object |
這提供了轉彎指示列表,以引導用戶通過用戶需要導航的腿,例如步行或使用踏板車或自行車時。 |
|
路徑索引
|
routes.legs.instructions.path_index | integer |
從 0 開始的索引,以建立到腿的 'path' 屬性所提供的座標清單中。 這表示要遵循指令的位置,因此它將是路徑上轉彎的位置,或腿的起點或終點。 |
|
距離
|
routes.legs.instructions.distance_meters | integer |
本指令 之前 的「路徑」部分的距離(以公尺為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Time
|
routes.legs.instructions.time_seconds | integer |
使用者在此指令 之前 周遊「路徑」區段所花費的時間(以秒為單位)。 對於類型為 'depart' 的初始指令,將省略此屬性。 |
|
Description
|
routes.legs.instructions.description_text | string |
向使用者提供的指令的純文字描述。 |
|
描述格式
|
routes.legs.instructions.description_format | string |
轉譯具有強調元素的指令的文字格式,其中 '{key}' 表示字串的一部分,必須取代為對應於 'description_format_replacements' 中 'key' 的專案所定義的內容。 這可讓用戶端視需要以不同的方式格式化取代所描述的元素。 索引鍵字串將僅包含字元 '[a-zA-Z0-9]'。 '{ }' 不會被嵌套,而文字字元 '{' 和 '}' 分別由轉義序列 '{' 和 '}' 編碼。 |
|
description_format_replacements
|
routes.legs.instructions.description_format_replacements | array of object | |
|
Key
|
routes.legs.instructions.description_format_replacements.key | string |
對應於「description_format」中「」中「」括在「{}」中的字串的鍵。 |
|
文字
|
routes.legs.instructions.description_format_replacements.text | string |
要用來取代 'description_format' 中 '{key}' 子字串的文字。 |
|
類型
|
routes.legs.instructions.description_format_replacements.type | string |
此值指出此格式取代所識別的真實世界事物類型。 這可讓服務用戶端視需要套用應用程式特定的格式。 |價值 |產品描述 | |----- |----------- | |street_name |街道、道路或其他方式的名稱 | |exit_number |出口的編號,通常來自迴旋處 | |
|
語言
|
routes.legs.instructions.description_format_replacements.language | string |
IETF BCP 47 語言標籤,指示相關「文字」的語言。 請注意,這可能與周圍描述的語言不同 - 當替換是當地語言的地名而描述是不同的語言時,這種情況最常見。 |
|
類型
|
routes.legs.instructions.type | string |
指出指令的類型。 |
|
類型方向
|
routes.legs.instructions.type_direction | string |
指示修改此指令的方向。 |
|
出發時間
|
routes.route_departure_time | string |
Citymapper 認為用戶將在給定可用出發信息的情況下出發該路線的時間。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
抵達時間
|
routes.route_arrival_time | string |
Citymapper 認為使用者將到達該路線終點的時間,考慮到可用的出發資訊和預期的行駛速度。 這是假設使用者位於路由的起點進行計算的。 'service/1/live/routeupdates' 會傳回 'route_departure_time' 和 'route_arrival_time' 的更新值,以反映任何更新的離境資訊。 時間以 ISO 8601 格式表示,包括事件發生的日期、時間和時區。 例如,'2020-08-19T08:10:42-04:00' 表示 2020 年 8 月 19 日上午 8:10 (東部夏令時間)。 |
|
groups
|
routes.route_metadata.groups | array of object | |
|
群組識別碼
|
routes.route_metadata.groups.group_id | string |
路由所包含之群組的 ID。 |
|
群體
|
routes.route_metadata.groups.group_name | string |
路線組的本地化名稱,例如「Transit」或「Le metro」。 |
|
路線位置
|
routes.route_metadata.groups.route_position | integer |
特定群組內路由的從零開始的位置。 |
|
設定檔名稱
|
routes.route_metadata.profile_name | string |
「設定檔」識別碼的人類可讀當地語系化名稱。 |
|
Profile
|
routes.profile | string |
指示使用哪個佈線「設定檔」來計算此佈線。 例如,來自自行車路線端點的回應可能會傳回多個路線,一條具有「安靜」設定檔,另一條具有「快速」設定檔。 請注意,可以隨時新增值,因此任何解析此欄位的程式碼都必須能夠處理非預期的值。 此值將符合支援選取特定路由設定檔的端點上的「profiles」請求引數。 此值僅供機器讀取。 若要向使用者顯示設定檔名稱,請改用「route_metadata」物件中的「profile_name」。 |
|
Signature
|
routes.signature | string |
在後續呼叫中要傳遞回伺服器以引用此路由的值(例如,當透過「service/1/live/routeupdates」請求即時出發資訊時)。 它必須被視為不透明值。 |
|
請求時間
|
routes.requested_time | string |
包含「時間」參數,在取得路線時用作出發或抵達時間限制 (如果適用)。 |
|
請求的時間類型
|
routes.requested_time_type | string |
包含 'time_type' 參數,用來決定如何使用 'time' 來約束傳回的方向 (如果適用)。 如果請求中未提供參數,將傳回預設用於規劃路由的「time_type」。 |
|
語言
|
language | string |
IETF BCP 47 語言標籤,指出用來編碼此回應中可當地語系化內容的語言,例如轉動指示。 這將反映盡最大努力滿足 'language' 請求參數或 'en-US' 作為預設所表達的任何語言偏好設定。 |