端點

這些端點和方式適用於所有 API 要求,除非另有說明。

請注意,預訂要求必須透過 POST以個別的安全端點送出。

測試要求 (CID 55505): GET/POST http://dev.api.ean.com
一般要求: GET http://api.ean.com
訂房要求: POST https://book.api.ean.com
通用要求參數
大多數的此類參數必須以每一種 API 要求的部分傳送;您可選擇提供部分此類參數做測試使用,或者只針對特定社定要求使用。

名稱 必要 說明
cid 長整數 yes

您的 EAN 發布帳戶 ID。此數字可於針對線上網站的統計數據和佣金追蹤銷售成績時使用。

精準定價功能只有已啟用的帳戶可用。在 55505 中傳回的定價僅供測試使用。

可以驗證部分的方式與 apiKey 配對。

apiKey 字串 yes 您的 API EAN 發佈存取索引碼。決定您的線上訂房存取權限、您的驗證方式 (IP 或簽章式) 及要求配額。

可以整體驗證部分的方式與 cid 配對。
minorRev 整數 yes 設定處理要求和傳回回傳使用的 次要修訂
如果省略,則顯示預設的 4 (原始釋出)。
locale 字串 yes 請辨識您顧客的國家及銷售點 (Point of Sale) 用於預訂的國籍。請查看我們的 支援地區

預設: en_US
currencyCode 字串 no(僅限訂房和付款類型可用) 如果可用,則以 其他貨幣 傳回資料。

訂房時,此值必須與之前空房回傳中 ChargeableRateInfo 節點內傳回的值完全相同。

預設: USD
customerSessionId 字串 yes 針對每位以第一份飯店清單搜尋開始的旅客插入您自己的唯一值,或使用第一份清單回傳中傳回的值以提醒訂房路徑。

繼續以使用每個旅客工作階段的新值,在每個訂房工作階段期間,傳送此相同的值給每位旅客。

加入此值會大幅減少 EAN 針對合作夥伴要求的問題所進行的內部除錯程序,因為此值會將個別旅客的要求路徑以明確的方式連結在一起。

customerIpAddress 字串 yes 旅客的 IP 位址 (和您的整合方式所擷取的資料相同)。

確認您的整合方式傳送的是旅客的 IP 位址而不是您自己的 IP 位址。此值可協助決定他們的位置並指定正確的付款閘道,

而且可針對詐騙復原和其他重要分析資料使用。
customerUserAgent 字串 yes 旅客的使用者代理程式字串 (和您的整合方式所擷取的資料相同)。

如為行動網站,則包含此元素範圍內的字串值 MOBILE_SITE。如為行動應用程式則使用 MOBILE_APP。這些值可自行傳送,或附加至擷取的使用者代理程式字串。

如果系統偵測不到行動版專用字串,API 將嘗試透過原始使用者代理程式字串的內容來決定使用的是行動網站或行動應用程式,但並非所有行動版瀏覽器或行動裝置皆可使用此方式。

如果系統偵測不到行動版字串或行動版特定關鍵字,就會假定使用的是桌面瀏覽器。
sig 字串 yes, (如果使用簽章驗證) 簽章驗證搭配使用的簽章值 - 確認此值的所有顯示代碼皆可清晰顯示。

所有簽章值的長度都必須至少有 32 個小寫字元。

如果您在產生您自己的數位簽章時收到錯誤訊息,請傳送 Ping 要求以使用 EAN 的 Unix 時間驗證您的 Unix 時間,或使用 EAN 的簽章產生器檢查您的值。
_type 字串 no 加入此有 json 值的參數以傳回 JSON 回傳。

使用 xml 的值;如果省略此參數,系統將傳回預設 XML 回傳。

常見的回傳元素
這些元素可能會顯示在任何 EAN API 要求的任何回傳中。
名稱 說明
customerSessionId 字串 API 將總是會針對任何初始要求傳回此元素的唯一值。

若要追蹤使用者工作階段,請針對該使用者的初始要求採用回傳中傳回的值,然後將此值加入至他們的下一個要求中。

每次傳回此值時,系統會傳回相同的值而不是新值。然後您可以追蹤此值 (如同此值在您的伺服器和 API 之間來回傳遞) 以追蹤使用者要求/回傳路徑。
EanWSError 物件 如果您的要求產生錯誤,相關資訊將包含在此物件中。如需此物件的詳細資料,請參閱我們的 例外概覽