輸入提示 Rapid 專用 API

在旅客搜尋時向他們提供建議

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

運作方式

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

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

啟動指南

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

啟動需求：

您必須採用並使用「不透明存取憑證」流程進行驗證。

>> 進一步了解不透明存取憑證

存取憑證僅能由提出請求的同一電路 ID 或 API 金鑰使用。
存取憑證的有效期僅為 4 小時。
申請新的存取憑證時，應設計為能依照該時程表定期刷新，且更新頻率不宜過高。
語言和請求內容為必填參數。

>> 查看 Rapid 支援的所有語言

如果輸入提示無法針對某個搜尋查詢產生結果，它將會「回退」至 Google Places 來回傳結果。在此情境下，回應正文將與任何其他輸入提示回應完全相同；然而，若結果是透過 Google 取得，則會回傳一個回應標頭：Third-Party-Result-Source: Google。Google 的備用功能雖對所有合作夥伴開放，但必須透過 Partner Connect 的 Switchbox 設定來啟用。根據營運要求，所有合作夥伴均須依照 Google 的規定，顯示正確的來源標示。署名政策中搜尋。

必填

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

查詢參數

必填

language: 指定回應所需的語言，其格式為 BCP47 格式的子集，僅使用以連字號連接的「two-digit」語言與國家代碼組合。請僅使用 w3.org 中所述的 ISO 639-1 alpha-2 語言代碼及 ISO 3166-1 alpha-2 國家代碼 (例如：language=en-US)。

>> 查看支援的語言清單
 >> 前往 w3.org

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
    }
  }
]