Analytics API の利用開始

Analytics API は簡単に利用を開始できます。API キーと共有シークレットを取得し、テストを開始するだけです。

1. パートナーになる

Analytics API と統合するには、ホワイトラベル テンプレート パートナーになっていただく必要があります。まだパートナー登録をしていない場合は、Expedia Partner Solutions サイトで申請できます。

ホワイトラベル テンプレート パートナーになる

2. オプションを選択する

パートナーになったら、次のデータドメイン オプションから選択できます。

• Loyalty Earn : お客様が貴社を通じた旅行の購入時にポイントを獲得できるようになります
• Itineraries : 貴社のサイトを通じてお客様が立てた旅行計画の調整またはキャンセルについて、サポートをお客様に提供できます

次に、API ログイン情報を入手し、認証を設定します。認証方法は、統合する配信メカニズムによって異なります。

3. プッシュ方式による認証の準備

通知は、指定したエンドポイントにプッシュ方式で送信されます。データ送信のセキュリティと信頼性を確保するために、各イベントには API キーと共有シークレットを使って生成されたヘッダー署名が含まれます。ヘッダー署名により、エクスペディアが送信者であることを認証および検証できます。

4. プル方式による認証の設定

Loyalty Earn エンドポイントや Itineraries エンドポイントにアクセスするには、API キーと共有シークレットが必要です。

4.1 アクセストークンをリクエストする

貴社のログイン情報が組み込まれた有効なトークンが提供されます (詳細については、担当のテクニカル アカウントマネージャーまでお問い合わせください)。このトークンは、HTTP Basic 認証メカニズムを使用します。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 のバージョンを指定する必要があります。OpenAPI 仕様の servers.url 値を使用して URL を構築します。標準的な値は以下の 2 つです。

• 統合の検証 : 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