沙盒入门指南
访问并设置沙盒模式以安全测试您的 API
访问沙盒功能
登录 Expedia Group 控制台并选择一个帐户。当您第一次访问沙盒功能时,我们将创建一个沙盒帐户,以镜像您用其访问沙盒功能的合作伙伴帐户。
进入沙盒模式有两种方法。
1. 使用全局切换开关
点击左下角的帐户名称,转到合作伙伴帐户菜单。
在帐户浮出控件上,点击沙盒模式切换开关以将其打开。
转到产品目录以添加您想试用的产品。注意:在沙盒模式下,只有启用沙盒的产品才会出现在产品目录中。
添加产品后,您可以创建特定于沙盒的 API 客户端,并在我们的 API Explorer、Postman 或其他工具中使用那些凭据来检查结果是否符合预期。在沙盒模式下,您创建的 API 凭据不会影响您的生产应用程序,因此,您可以在此生产应用程序上线之前对配置进行微调。
当您准备恢复上线模式时,请再次“关闭”帐户浮出控件中的相应切换开关。
2. 从产品详细信息页面中试用产品
转到产品目录并找到您感兴趣的产品。启用沙盒的产品将标有徽标。
点击启用沙盒的产品的产品卡,您将进入产品详细信息页面。点击页面顶部的试用产品按钮以切换到沙盒模式。系统将提示您配置沙盒帐户以使其与您的 Expedia Group 帐户保持一致。
针对想要试用的产品创建特定于沙盒的 API 客户端,并在我们的 API Explorer、Postman 或其他工具中使用凭据来检查结果是否符合预期。在沙盒模式下,您创建的 API 凭据不会影响您的生产应用程序,因此,您可以在此生产应用程序上线之前对配置进行微调。注意:在沙盒模式下,只有启用沙盒的产品才会出现在产品目录中。
当您准备恢复上线模式时,请点击转到实时模式链接或返回到帐户浮出控件以切换全局切换开关。
在沙盒上配置产品
初始配置
在启用沙盒的产品的产品详细信息页面上,点击试用产品以在沙盒模式下启动配置。
更新
- 使用全局切换开关打开您的沙盒帐户。
- 转到您要更新的产品的产品详细信息页面。
- 打开上下文菜单(右上角的三个垂直点)并选择“更新配置”以启动配置流程。
注意:此上下文菜单也适用于您的上线帐户,因此,请务必切换到您的沙盒帐户以避免错误。您将需要使用沙盒选项来手动更新上线配置。
API 客户端创建
无论要在沙盒模式下还是在上线模式下使用 Expedia Group 旅行平台 API,您都必须创建一个或多个 API 客户端,这些客户端类似于受密码保护的用户帐户。本质上,API 客户端确定发出 API 请求的软件属于您(身份验证),并允许您限制每个客户端可以发出的 API 请求类型(授权)。创建 API 客户端有两种方法:
- 点击产品详细信息页面上的上下文菜单,然后选择创建 API 客户端。
- 点击左侧导航栏中的创建 API 客户端。
在“创建 API 客户端”页面上,输入名称和描述,以帮助您和组织中的其他人了解其中包含的产品。在可用产品列表中,选择要包含的范围(API 请求类型)。注意:选中顶层的复选框将选择所有子元素。
点击创建。
创建 API 客户端后,您将看到一个确认屏幕,其中包含您的凭据 ID 和秘钥。**这些信息仅显示一次。请务必复制凭据和秘钥并将其保存到安全位置。**不要将您的客户端 ID 或秘钥存储在可公开访问的区域,例如 GitHub、客户端代码等。
产品和范围
所有 API 客户端都在一个合作伙伴帐户中运行。当您将产品添加到帐户时,它们将可以包含在 API 客户端中。您可以创建一个 API 客户端并授予其访问一个或多个产品的权限。
每个产品都包含一组“范围”,用于授予对特定请求类型的访问权限。您分配的范围将控制该客户端被授权执行的操作。如果您有多个发出 API 请求的软件服务,我们建议您为每个服务创建一个单独的 API 客户端,并仅选择每个 API 客户端所需要的范围。
查看和调整沙盒 API 客户端
为沙盒产品创建 API 客户端后,请转到要在 Developer Hub 中测试的产品的 API Explorer 页面。更改 API 服务器 URL 以指向沙盒并插入安全凭据。
使用我们的 API Explorer、Postman 或其他 API 工具,您可以查看 API 客户端设置将返回的结果。尽早使用可确保我们的 API 适合您,并在将我们的其中一个产品推送到生产应用程序之前测试对设置所做的任何更改。
将 API 上线
完成沙盒测试后,您可以创建上线版本的 API 客户端以在生产应用程序中使用。
- 登录控制台。
- 在产品目录中,转到您要添加的产品的产品详细信息页面。
- 点击添加产品(或者,如果产品需要批准,请点击请求添加)。
- 配置产品。通常,上线后的设置会模仿您在沙盒测试中使用的许多或大部分设置。
- 点击提交。
- 创建上线版本 API 客户端:点击左侧导航栏中的创建 API 客户端。
- 通常,您将使用与沙盒相同的范围。
- 点击获取凭据。
注意:当您添加产品时,Expedia 团队可能会与您联系以获取更多信息。
您还可以请求直接在沙盒中完成上线 - 请查找转到上线模式链接。
要了解如何在软件中嵌入 API 客户端,请阅读 API 身份验证和授权。