分析数据 API 入门

分析数据 API 入门很简单。只需获得 API 密钥和共享秘钥,即可开始测试。

1. 成为合作伙伴

您首先需要成为白标模板合作伙伴才能集成分析数据 API。如果您还不是我们的合作伙伴,可以在我们的 Expedia Partner Solutions 网站上申请。

成为白标模板合作伙伴

2. 选择您的选项

成为合作伙伴后,您可以从我们的数据域选项中进行选择:

  • 会员积分:让您的客户在通过您购买旅游产品时获得积分
  • 行程:为客户提供支持,帮助他们调整或取消通过您的网站制定的旅行计划

接下来,您将获得您的 API 凭据并设置身份验证。身份验证方法将根据您集成的交付机制而有所不同。

3. Push 方式身份验证准备

系统将通过 Push 方式将通知发送到您提供的端点。为确保数据传输安全可靠,每个事件都将包含一个使用您的 API 密钥和共享秘钥生成的标头签名。通过标头签名,您可以验证并确认 Expedia 为发件人。

4. 配置 Pull 方式身份验证

要访问会员积分和行程端点,您需要 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

有效的身份验证调用将返回一个 Bearer 令牌,您将在下一步中使用该令牌。

4.2 使用令牌向 API 发出请求

我们会对 transactionslast_update 端点使用 Bearer 令牌身份验证。您需要提供一个授权标头,其中包含您在上一步中收到的令牌。

示例:

Authorization: Bearer {token}

4.3 测试您的请求

在收到凭据并配置身份验证之后,您可以针对我们的测试端点 https://test.analytics.ean.com/ 提出请求。通过此端点返回的任何数据都是示例数据;它的唯一用途就是理解数据的结构。

Information

重要说明

为确保我们为所有合作伙伴提供稳定且可维护的服务,我们对所有 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
您觉得这个页面有用吗?
我们该如何改进这些内容?
感谢您帮助我们改进!