什么是 API 沙盒？

API 沙盒 是一个模拟环境，开发人员可以在其中安全地测试和试验应用程序编程接口（API），而不会影响实时生产系统。它模拟了 API 的真实功能，允许开发人员：

• 测试 API 调用：您可以发送请求、尝试不同的输入并观察响应，而不会产生实际影响。

• 验证集成：它有助于验证应用程序如何与 API 交互。

• 学习和探索：开发人员可以探索 API 的功能，了解其端点，并练习如何处理响应和错误。

API 沙盒的主要特点通常包括：

• 安全环境：沙盒环境不会影响真实数据或服务。

• 模拟数据：沙盒的响应通常是预先配置的或基于测试数据的，模拟真实场景。

• 速率限制：与生产环境相比，API 沙盒通常具有更宽松或独立的速率限制。

在开发和测试过程中，它是一个宝贵的工具，可确保在使用实际数据上线之前一切正常运行。

如何使用沙盒？

使用 API 沙盒涉及一些适用于大多数 API 的常见步骤，尽管具体细节可能因 API 提供商而异。以下是使用沙盒的一般指南：

1. 注册或获取 API 访问权限

• 注册 API 密钥：登录您的 ATRIP 门户，导航至"Profile --> My Profile --> Company Information"。点击"Generate"按钮，您的沙盒凭证将被创建。此密钥将用于在沙盒环境中验证您的请求。

• 定位沙盒特定端点：沙盒特定端点可在"API Document --> Shopping and Ticketing --> Specific Request"部分找到。请查看每个请求的信息以获取其端点。

2. 阅读文档

• 每个 API 都有文档，概述可用的端点、请求方法、参数和预期响应。请务必阅读沙盒特定的说明，因为某些行为可能与生产环境不同。

3. 发送 API 请求

• 使用像 Postman 这样的工具向 API 发送请求。

• Postman 是一个用户友好的工具，用于发送 API 请求：

  1. 安装并打开 Postman。

  2. 创建新请求。

  3. 输入沙盒 API 端点。

  4. 设置请求方法（PUT、POST 等）。

  5. 在标头或身份验证部分添加您的 API 密钥。

  6. 发送请求并检查响应。

4. 使用模拟或测试数据

• 在沙盒环境中，无法使用真实世界的数据。相反，沙盒提供模拟数据。这些数据模仿真实场景，允许您测试应用程序的行为而不影响实时系统。

• 您可能会收到硬编码的响应或仅限于特定的测试场景（如"成功请求"、"无效数据"等）。

• 所有价格都是_模拟_价格。不应使用沙盒环境进行价格比较。

5. 实验和处理响应

• 测试不同的请求，并检查您的应用如何处理成功和错误响应。

6. 调试和改进

• 通过查看请求日志、响应和错误消息，使用沙盒调试应用程序的 API 集成。

• 您可以继续调整请求并完善代码，直到其按预期运行。

7. 过渡到生产环境

• 一旦您对沙盒感到满意，并且您的集成按预期工作，您可以完成 UAT 认证场景并获取生产环境的访问权限。

• 确保更新：

  • API 端点（从 sandbox 切换到 production）。

  • 您的 API 密钥（您需要生产密钥来获取真实数据）。Atlas 将在认证后激活 ATRIP 中的此部分。

Postman 示例

• 打开 Postman，按如下方式设置请求：

  • 端点：https://search-sg.atriptech.com/search.do

  • 方法：POST

  • 标头：添加授权（AK/SK）

  • 正文：以 JSON 格式定义任何必需的正文参数。

  • 点击发送并检查响应。

沙盒使用技巧：

• 谨慎处理错误：沙盒是练习应用程序如何处理意外响应或错误的绝佳场所。

• 监控变化：沙盒环境可能与生产环境略有不同，因此在切换到生产环境后，请验证您的应用程序行为是否相同。