跳到主要内容

API V2 与 V1 对比

主要变化​

API V2 相比 V1 版本有以下重要变化：

1. 支持 RESTful 格式的 API 调用​

V1 版本：

  • 鉴权复杂
  • 不支持restful风格

V2 版本：

  • 支持标准的 RESTful API 调用
  • 使用 HTTP 方法（GET、POST、PUT、DELETE）表示操作类型
  • 统一的路径格式：/api/v1/{product}/{action}
  • 可以直接使用 HTTP 客户端（如 curl、Postman）调用

示例对比：

V1 调用方式：

// 需要 SDK 支持，鉴权复杂
client.CreateUSMSTemplate(req)

V2 调用方式（RESTful）：

curl -X POST "https://api.uspeedo.com/api/v1/usms/USMSTemplate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic ..."

2. 更简单的鉴权方式​

V1 版本：

  • 需要生成签名（Signature）进行认证
  • 需要 AccountId 参数
  • 签名算法相对复杂

V2 版本：

  • 使用标准的 HTTP Basic 认证
  • 只需要 ACCESSKEY_ID 和 ACCESSKEY_SECRET
  • 无需 AccountId
  • 认证方式更简单、更安全

认证方式对比：

V1 认证：

需要：
- Signature（签名）
- AccountId（项目ID）
- Action（API名称）

V2 认证：

只需要：
- Authorization: Basic base64(ACCESSKEY_ID:ACCESSKEY_SECRET)

3. 更详细的 API 文档​

V1 版本：

  • 文档相对简单
  • 主要面向 SDK 使用者

V2 版本：

  • 提供完整的 RESTful API 文档
  • 包含多种语言的代码示例（CURL、Golang、Java、Python、PHP）
  • 详细的请求参数说明
  • 完整的响应格式说明
  • 错误码说明

4. 路径格式统一​

V1 版本：

  • 不支持 RESTful 风格的路径格式
  • 需要通过 Action 参数指定操作

V2 版本：

  • 统一的 RESTful 路径格式：/api/v1/{product}/{action}
  • 使用 HTTP 方法区分操作类型：
    • GET：查询
    • POST：创建
    • PUT：更新
    • DELETE：删除

5. 请求参数简化​

V1 版本：

  • 所有请求都需要 Action 和 AccountId 参数
  • 参数结构复杂

V2 版本：

  • 无需 Action 参数（通过路径和方法确定）
  • 无需 AccountId 参数
  • 参数结构清晰简洁

迁移建议​

如果您正在使用 V1 API，建议迁移到 V2 版本以获得：

  • ✅ 更简单的认证方式
  • ✅ 标准的 RESTful API 接口
  • ✅ 更好的文档支持
  • ✅ 更灵活的调用方式（支持直接 HTTP 调用）

兼容性说明​

  • V1 和 V2 API 可以同时使用
  • V1 API 将继续维护，但建议新项目使用 V2
  • V2 API 提供了更好的开发体验和文档支持