简介#

欢迎使用 eBay AI 广告平台 Open API！通过我们的 API，您可以将广告管理功能集成到您的系统中，实现广告投放的全自动化。

什么是 Open API？#

Open API 是 eBay AI 广告平台提供的 RESTful 风格的开放接口。通过这些接口，您可以：

• 📋 管理广告活动 - 创建、更新、暂停广告活动
• 🔑 批量操作关键词 - 添加关键词、调整出价
• 📊 获取数据报表 - 拉取广告效果数据进行分析
• 🔔 接收实时通知 - 通过 Webhook 获取状态变更

核心概念#

在开始之前，了解以下核心概念有助于您更好地使用 API：

| 概念 | 说明 | |------|------| | 租户 (Tenant) | 您的账户所属的隔离空间，数据相互独立 | | API Key | 用于标识您身份的密钥对（公钥 + 私钥） | | 广告活动 (Campaign) | 广告投放的顶层实体，包含预算、时间等配置 | | 广告组 (Ad Group) | 活动下的分组，包含关键词和商品 | | 关键词 (Keyword) | 触发广告展示的搜索词 |

API 基础信息#

请求地址#

生产环境：https://api.eaby-ads.com/api/v1/open
测试环境：https://sandbox.eaby-ads.com/api/v1/open

请求格式#

所有 API 请求使用 JSON 格式，请确保设置正确的 Content-Type：

Content-Type: application/json

响应格式#

API 响应统一采用以下格式：

{
  "success": true,
  "data": { ... },
  "message": "操作成功",
  "timestamp": "2026-01-10T12:00:00Z"
}

错误响应示例：

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "参数校验失败",
    "details": [
      { "field": "name", "message": "名称不能为空" }
    ]
  },
  "timestamp": "2026-01-10T12:00:00Z"
}

下一步#

准备好开始了吗？请继续阅读以下文档：

1. 获取 API Key - 创建并管理您的 API 密钥
2. 认证方式 - 了解 HMAC-SHA256 签名机制
3. 快速开始 - 5 分钟完成第一个 API 调用