端点

除非另外注明,否则这些端点和方法适用于所有 API 请求。

请注意,预订请求必须通过 POST 在单独的安全端点上发送。

一般请求: GET http://api.ean.com
预订请求: POST https://book.api.ean.com
通用请求参数
这些参数大部分都必须在向 API 提交的每个请求中发送;部分参数可有选择地提供用于测试,或者只是特定设置所必需的。

名称 是否必需 说明
apiExperience 字符串

使用此属性可识别您的请求源。针对您发送的每个请求,从下文提供的集合中选择一个适用的值。

值:
PARTNER_CALL_CENTER - 来自呼叫中心代理的请求
PARTNER_WEBSITE - 来自面向客户网站的请求
PARTNER_MOBILE_WEB - 来自手机格式网站的请求
PARTNER_MOBILE_APP - 来自手机应用程序的请求
PARTNER_BOT_CACHE - 来自缓存 bot 的请求
PARTNER_BOT_REPORTING - 来自报告 bot 的请求

cid 长整型

EAN 核发的帐户 ID。该编号用于跟踪销售情况,以便在实时网站上收集统计信息和计算佣金。

与 apiKey 配对作为身份验证的一部分。

apiKey 字符串 EAN 核发的 API 访问密钥。确定您对实时预订、验证方式(基于 IP 或签名)和请求配额的访问权限。

cid 配对作为总体验证的一部分。
minorRev 整型 设置用于处理请求和返回回复内容的次要版本
如果忽略,则使用默认值 4(原始版本)。
locale 字符串 确认客户所在的国家/地区以及用于预订的销售点所在的国家。查看我们支持的区域设置

默认: en_US
currencyCode 字符串 ,仅适用于预订和付款方式 以可用的其他货币返回数据。

在预订时,该值必须与先前从可订空房回复内容的 ChargeableRateInfo 节点中返回的值相匹配,以避免价格不匹配错误。

默认: USD
customerSessionId 字符串 为每位客户插入您自己的唯一值,以其首个酒店列表搜索开头,或将初始列表回复中返回的值用作预订路径的剩余部分。

在每个预订会话期间继续为每位客户传递该值,并且为每个新客户会话使用新值。

包含此值可大大简化 EAN 对合作伙伴请求中所含问题的内部调试流程,因为其将各个客户的请求路径明确地关联在一起。

customerIpAddress 字符串 客户的 IP 地址,由您的集成捕捉。仅发送 IPV4 地址。

请确保您的集成传递客户的 IP,而不是您自己的 IP。该值可帮助确定他们的位置,并分配正确的支付网关。

此外还用于欺诈恢复和其他重要的分析。
customerUserAgent 字符串

客户请求中的 user-agent 标题字符串,由您的集成捕捉。

API 将通过原始 user-agent 字符串的内容检测移动设备的使用情况。

对于来自移动或桌面应用程序的流量,使用以下格式:
{App Name}/{App Version} ({OS} {OS Version}) [APP or MOBILE_APP]

示例

TravelWizard/1.0 (iOS 10_10_3) MOBILE_APP
Explorer/2.1 (Windows 7) APP
Explorer/2.1 (Linux 2.6.32) APP

已弃用对于移动网站,在此元素中的所有位置都包括字符串值 MOBILE_SITE。为移动应用程序使用 MOBILE_APP。这些值可单独发送,也可附加到捕捉的用户代理字符串。注意:以后可能会取消对 MOBILE_SITE 的支持。

如果未检测到移动字符串和任何移动特定的关键字,则假定使用的是桌面浏览器。

sig 字符串 如果使用 sig 验证,则为 sig 值与签名验证一起使用,确保该值没有任何可见的代码。

所有 sig 值的长度都必须至少为 32 个小写字符。

如果您在生成自己的数字签名时收到错误,请发送 ping 请求向 EAN 验证 Unix 时间,或者根据 EAN 的 sig 生成器检查值。

通用回复元素
这些元素可显示在任何 EAN API 请求的任何回复中。
名称 说明
customerSessionId 字符串 对于任何初始请求,API 始终为此元素返回唯一的值。

要跟踪各个用户会话,请获取在针对用户初始请求的回复中返回的值,然后将其包含在他们的下一请求中。

每次发送回该值时,都将返回相同的值,而不是新值。然后,您可以通过在您的服务器和 API 之间来回传递该值时对其进行跟踪,从而跟踪用户请求/回复路径。
EanWSError 对象 如果您的请求生成错误,信息将包含在此对象中。有关此对象的详细信息,请参阅例外概述

通用回复元素
这些元素可显示在任何 EAN API 请求的任何回复中。
名称 说明
customerSessionId 字符串 对于任何初始请求,API 始终为此元素返回唯一的值。

要跟踪各个用户会话,请获取在针对用户初始请求的回复中返回的值,然后将其包含在他们的下一请求中。

每次发送回该值时,都将返回相同的值,而不是新值。然后,您可以通过在您的服务器和 API 之间来回传递该值时对其进行跟踪,从而跟踪用户请求/回复路径。
EanWSError 对象 如果您的请求生成错误,信息将包含在此对象中。有关此对象的详细信息,请参阅例外概述