RESTful架构
采用标准RESTful API设计,易于理解和使用
HTTPS加密
全程HTTPS加密传输,保障数据安全
JSON格式
请求和响应均采用JSON格式,方便解析
频率限制
合理的频率限制,保障服务稳定
API接口列表
完整的API接口,满足各种业务需求
商品接口
| 接口名称 | 方法 | 路径 | 描述 |
|---|---|---|---|
| 商品搜索 | GET | /api/v1/goods/search | 根据关键词搜索商品列表 |
| 商品详情 | GET | /api/v1/goods/{id} | 获取商品详细信息 |
| 商品分类 | GET | /api/v1/goods/categories | 获取商品分类列表 |
| 热门商品 | GET | /api/v1/goods/hot | 获取热门推荐商品 |
订单接口
| 接口名称 | 方法 | 路径 | 描述 |
|---|---|---|---|
| 订单列表 | GET | /api/v1/orders | 获取推广订单列表 |
| 订单详情 | GET | /api/v1/orders/{id} | 获取订单详细信息 |
| 订单统计 | GET | /api/v1/orders/statistics | 获取订单统计数据 |
| 订单查询 | POST | /api/v1/orders/query | 按条件查询订单 |
推广接口
| 接口名称 | 方法 | 路径 | 描述 |
|---|---|---|---|
| 链接转换 | POST | /api/v1/promotion/convert | 商品链接转换为推广链接 |
| 推广位管理 | GET | /api/v1/promotion/adzones | 获取推广位列表 |
| 创建推广位 | POST | /api/v1/promotion/adzones | 创建新的推广位 |
| 收益查询 | GET | /api/v1/promotion/earnings | 获取推广收益数据 |
数据接口
| 接口名称 | 方法 | 路径 | 描述 |
|---|---|---|---|
| 数据概览 | GET | /api/v1/data/overview | 获取账户数据概览 |
| 效果报表 | GET | /api/v1/data/report | 获取推广效果报表 |
| 趋势分析 | GET | /api/v1/data/trends | 获取数据趋势分析 |
| 数据导出 | GET | /api/v1/data/export | 导出数据报表 |
代码示例
快速上手的代码示例
// 请求示例
const response = await fetch('https://api.zaomeng.com/api/v1/goods/search', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);响应格式
所有API接口返回统一的JSON格式响应,包含状态码、消息、数据和时间戳。
code状态码,200表示成功
message响应消息
data返回数据
timestamp响应时间戳
{
"code": 200,
"message": "success",
"data": {
"goods": [
{
"id": "123456",
"title": "商品标题",
"price": "99.00",
"commission_rate": "20.00",
"commission": "19.80",
"sales": 1000,
"image_url": "https://example.com/image.jpg",
"detail_url": "https://item.taobao.com/item.htm?id=123456"
}
],
"total": 100,
"page": 1,
"page_size": 20
},
"timestamp": 1704067200
}SDK与工具
提供多语言SDK,简化开发流程
JavaScript SDK
支持Node.js和浏览器环境
Python SDK
Python 3.7+ 支持
Java SDK
Java 8+ 支持