開始使用分析 API

開始使用分析 API 很簡單。只需取得 API 金鑰與共用密碼，然後開始執行測試即可。

1. 成為合作夥伴

您必須先成為白牌範本合作夥伴，才能整合分析 API。如果您尚未成為合作夥伴，請前往 Expedia Partner Solutions 網站提出申請。

成為白標範本合作夥伴

2. 選擇您的選項

成為合作夥伴後，您可以選擇我們提供的資料網域選項：

賺取會員點數：讓旅客在透過您的服務選購旅遊產品時賺取點數
行程：協助旅客調整或取消透過您的網站安排之旅遊計畫

接下來，您將取得 API 憑證並設定驗證。驗證方法將根據您整合的交付機制而有不同。

3. 推播驗證方法的相關準備

通知將透過推播方法傳送到您提供的端點。為了確保資料傳輸安全且值得信賴，每個事件都將包含使用您的 API 金鑰和共用密碼產生的標頭簽章。標頭簽章可讓您驗證 Expedia 是否為寄件者。

4. 設定提取方法驗證

您需要使用 API 金鑰和共用密碼，才能存取賺取會員點數和行程等端點。

4.1 要求存取標記

您將取得整合所持有憑證的有效標記 (如需詳細資訊，請聯絡您的技術客戶經理)。此標記會使用 HTTP 基本驗證機制。您需要提供一個授權標題，其中包含 API 金鑰和共用密碼的 base64 編碼字串。

範例：

Authorization: Basic {api-key}:{shared-secret}

隨後將對 OpenAPI 規範中記錄的標記端點進行呼叫。

securitySchemes:
    oauth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://analytics.ean.com/template/v1/oauth/token

有效的驗證呼叫將傳回一個不記名標記，您將需要在下一步中使用該標記。

4.2 使用標記向 API 提出要求

我們會在 transactions 或 last_update 端點使用不記名標記驗證機制。您將需要提供一個授權標題，其中包含您在上一步中收到的標記。

範例：

Authorization: Bearer {token}

4.3 測試您的要求

收到憑證並進行驗證設定後，即可開始針對以下測試端點提出要求：https://test.analytics.ean.com/。透過此端點傳回的任何資料都是樣本資料；該資料只會用於理解資料的結構。

重要事項

為確保我們為所有合作夥伴提供穩定且不間斷的服務，我們對所有 API 呼叫套用了速率限制。我們的系統會監控異常的 API 流量，並自動採取保護措施。若要針對呼叫 API 的行為進行計畫性變更或使用 API 進行效能測試，請務必先與分析 API 顧問討論您的計畫。

測試時，您需要指定 API 版本。使用 OpenAPI 規格中的 servers.url 值來建立 URL。這兩個值為標準值：

整合驗證：test.analytics.ean.com
生產端點：analytics.ean.com

注意：在端點之間切換時，保留通訊協定和路徑指定 (https://[test.]analytics.ean.com)。

範例：

https://test.analytics.ean.com/template/v1/loyalty/earn/last_update
https://test.analytics.ean.com/template/v1/itineraries

servers.url 值位於我們可下載的 OpenAPI 規格檔案最上方，並與指定 API 服務的版本號碼相對應。

範例：

openapi: 3.0.1
info:
  title: Analytics API
  description: Analytics API V1
  version: v1

tags:
  - name: Analytics
    description: Template Analytics API

servers:
  - url: https://analytics.ean.com/template/v1
  - url: https://test.analytics.ean.com/template/v1