輸入提示 Rapid 專用 API

在旅客搜尋時提供建議

Typehead (GET /suggestions) 是一個全新的 API 端點，可讓您根據地理區域、相關地點及可用庫存，為旅客提供建議性搜尋體驗。此端點會根據部分搜尋字串以及使用者輸入的任何請求參數，返回一組建議清單。請聯絡您的客戶經理，將輸入提示加入您的帳戶。

運作方式

輸入提示 API 是一項語言預測工具——有時也被稱為自動完成或自動建議功能。它會根據使用者在搜尋框中輸入的部分資訊，回傳地區、地點或庫存清單。當使用者在搜尋欄中輸入內容時，輸入提示 API 將根據城市、地區、庫存商品或郵遞區號等資訊，開始返回最多 10 項搜尋結果。旅客可以從此清單中選擇項目來開始搜尋，或繼續輸入文字以進一步篩選系統自動建議的結果。

例如，若搜尋詞以「Memp」開頭，系統會顯示數個地理選項，包括與美國田納西州孟菲斯市相關的社區、火車站、機場等，接著會顯示美國密蘇里州孟菲斯市。

啟動指南

您需要聯絡您的客戶經理或 Partner Connect 代表，以了解該 API。他們將申請存取權限，若獲批准，將修改您的協議以納入輸入提示。一旦您的組織啟用了輸入提示，Partner Connect 代表將協助您進行任何必要的開發工作。

啟動需求：

您必須採用並使用中的不透明存取憑證流程進行驗證。
存取憑證僅限於提出請求的相同迴路 ID 或 API 金鑰使用。
存取憑證的有效期僅為 25 分鐘。
申請新的存取憑證時，應設定為依照該時程表定期更新，且更新頻率不宜過高。
語言和請求內容是必填參數。請參閱上的 Rapid 支援語言清單。

必填

Accept: 指定客戶端希望接收的回應格式。此值必須為 application/json.
Accept-Encoding: 指定客戶端希望接收的回應編碼。此值必須為 gzip.
User-Agent：由您的整合系統擷取自客戶請求的標頭字串。如果您正在開發應用程式，則 User-Agent` ` 的值應設定為 {app name}/{app version}``。例如，TravelNow/3.30.112。

查詢參數

必填

language：指定回應所需的語言，格式為 BCP47 格式的子集，僅使用由語言代碼與國家代碼組成的連字號連接對 (two-digit)。請僅使用 ISO 639-1 alpha-2 語言代碼及 ISO 3166-1 alpha-2 國家代碼，詳見 w3.org (例如，language=en-US) 。請參閱 Rapid 支援的語言清單：。
text：要查詢的輸入字串，長度上限為 150 個字元 (例如：text=Springfie)。

選擇性

type: 描述使用者正在尋找的地點。此參數可以多次傳入，且每次傳入的值可以不同 (例如：type=AIRPORT&type=CITY)。若未指定，預設值將包含所有類型。請參閱下方的「允許值」表格，了解可用的選項。
line_of_business: 此參數提供搜尋啟發式演算法，設定有效的值可確保搜尋結果更具相關性。雖然此參數為可選項，但若未填寫可能會影響搜尋結果，因此我們已為每個 Rapid API 設定了預設值。請參閱下方的「允許值」表格，了解可用的選項。
package_type: 根據使用者指定的套件類型進行篩選。請參閱下方的「允許值」表格，了解可用的選項。
feature: 變更建議結果的計算方式。值包括hierarchy、nearby_airport 以及postal_code。
region_id: 將結果篩選至指定區域。
origin: 指定查詢文字是來源而非目的地。預設搜尋僅會找到目的地。
limit: 指定回應中返回的建議項目最大數量。此數值必須介於 1 至 10 之間 (例如：limit=5)。若未提供此參數，預設值為 10。

允許的值

type	line_of_business	package_type
`airport`	`properties`	`flight_property`
`city`	`flights`	`flight_property_car`
`multi_city_vicinity`	`packages`	`flight_car`
`neighborhood`	`cars`	`property_car`
`point_of_interest`	`activities`
`airport_metro_code`
`multi_region`
`train_station`
`metro_station`
`address`
`property`
`bus_station`

注意：若輸入的數值未包含於上表之中，系統將顯示錯誤訊息。

資料請求

取得access_token 後，您將設定GET 的請求。

範例請求 - 住宿 API

GET - https://api.ean.com/v3/suggestions?language=en-US&line_of_business=properties&limit=3&text=chicago&type=city&type=neighborhood 

Header : 
Authorization: Bearer {{access_token}}

範例回應 - 住宿 API

[
  {
    "related_id": "4477519",
    "type": "airport",
    "name": "Chicago, IL (ORD-O'Hare Intl.)",
    "name_full": "Chicago, IL, United States of America (ORD-O'Hare Intl.)",
    "name_display": "<B>Chicago</B>, IL, United States of America (ORD-O'Hare Intl.)",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "ORD",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.976977,
      "longitude": -87.90481
    }
  },
  {
    "related_id": "829",
    "type": "city",
    "name": "Chicago",
    "name_full": "Chicago, Illinois, United States of America",
    "name_display": "<B>Chicago</B>, Illinois, United States of America",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "CHI",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.878113,
      "longitude": -87.629799
    }
  },
  {
    "related_id": "6350699",
    "type": "neighborhood",
    "name": "Downtown Chicago",
    "name_full": "Downtown Chicago, Chicago, Illinois, United States of America",
    "name_display": "Downtown <B>Chicago</B>, <B>Chicago</B>, Illinois, United States of America",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "CHI",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.885969845574834,
      "longitude": -87.62933540465228
    }
  }
]

錯誤碼

輸入提示 API 與其他 Rapid API 共用相同的錯誤代碼。所有這些代碼的詳細說明，請參閱我們的常見錯誤回應頁面。

與其他 Rapid API 進行互動

當最終使用者在搜尋欄中輸入文字時，輸入提示 API 會根據搜尋所指定的type，擷取區域 (區域 ID、名稱、座標等) 或項目資訊。該 API 隨後會將這些資訊顯示在自動完成清單中。

當使用者從自動完成清單中選取一個地區時，系統會呼叫 Region API 以取得該地區周邊的庫存清單。使用該搜尋所返回的 ID 來呼叫 Shopping API，取得庫存狀況，並顯示清單。

若使用者從自動完成清單中選取一項商品，購物 API 將產生一個詳情頁面，其中包含商品供應狀況及庫存詳細資訊。

API 詳細資料

在這個頁面上探索相關端點的定義，然後使用 API Explorer 或其他測試軟體，了解範例和結構描述定義與實際輸出的比較。

其他資源

無論您是想試用所有 Rapid API 端點，還是想下載其 OpenAPI 規格或我們的 Postman 集合，我們都能滿足您的需求。