客户端 API 概览
本文档介绍俄罗斯代购淘宝平台的客户端 API 接口,供移动端和 Web 端开发者使用。
基础信息
- Base URL:
https://api.russia-taobao.com/v1 - 认证方式: Bearer Token
- 数据格式: JSON
- 字符编码: UTF-8
认证
获取 API 密钥
- 注册平台账号
- 登录后台管理系统
- 进入"开发者中心"
- 创建应用并获取 API Key 和 Secret
请求头
所有 API 请求需要包含以下请求头:
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept-Language: zh-CN
获取访问令牌
接口地址: POST /auth/token
请求参数:
{
"apiKey": "your_api_key",
"apiSecret": "your_api_secret",
"grantType": "client_credentials"
}
响应示例:
{
"code": 200,
"message": "success",
"data": {
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"tokenType": "Bearer",
"expiresIn": 7200,
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
}
通用响应格式
成功响应
{
"code": 200,
"message": "success",
"data": {},
"timestamp": 1704946800
}
错误响应
{
"code": 400,
"message": "参数错误",
"error": "缺少必填参数: userId",
"timestamp": 1704946800
}
状态码
| 状态码 | 说明 |
|---|---|
| 200 | 请求成功 |
| 201 | 创建成功 |
| 400 | 请求参数错误 |
| 401 | 未授权 / Token 过期 |
| 403 | 禁止访问 |
| 404 | 资源不存在 |
| 429 | 请求过于频繁 |
| 500 | 服务器内部错误 |
业务错误码
| 错误码 | 说明 |
|---|---|
| 1001 | 用户不存在 |
| 1002 | 用户已被禁用 |
| 2001 | 商品不存在 |
| 2002 | 商品已下架 |
| 2003 | 库存不足 |
| 3001 | 订单不存在 |
| 3002 | 订单状态错误 |
| 4001 | 支付失败 |
| 4002 | 余额不足 |
速率限制
- 每分钟最多 100 次请求
- 超过限制将返回 429 状态码
- 响应头包含速率限制信息:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1704946860
分页参数
所有列表接口支持分页:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | int | 否 | 页码,默认 1 |
| pageSize | int | 否 | 每页数量,默认 20,最大 100 |
分页响应格式:
{
"code": 200,
"message": "success",
"data": {
"list": [],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 100,
"totalPages": 5
}
}
}
API 接口列表
用户相关
| 接口 | 方法 | 说明 |
|---|---|---|
/user/profile | GET | 获取用户信息 |
/user/profile | PUT | 更新用户信息 |
/user/address | GET | 获取收货地址列表 |
/user/address | POST | 添加收货地址 |
/user/address/{id} | PUT | 更新收货地址 |
/user/address/{id} | DELETE | 删除收货地址 |
商品相关
| 接口 | 方法 | 说明 |
|---|---|---|
/product/list | GET | 获取商品列表 |
/product/{id} | GET | 获取商品详情 |
/product/search | GET | 搜索商品 |
/product/category | GET | 获取商品分类 |
/product/{id}/reviews | GET | 获取商品评价 |
订单相关
| 接口 | 方法 | 说明 |
|---|---|---|
/order/create | POST | 创建订单 |
/order/list | GET | 获取订单列表 |
/order/{id} | GET | 获取订单详情 |
/order/{id}/cancel | POST | 取消订单 |
/order/{id}/refund | POST | 申请退款 |
支付相关
| 接口 | 方法 | 说明 |
|---|---|---|
/payment/create | POST | 创建支付 |
/payment/status | GET | 查询支付状态 |
/payment/refund | POST | 申请退款 |
物流相关
| 接口 | 方法 | 说明 |
|---|---|---|
/shipping/tracking | GET | 查询物流轨迹 |
/shipping/companies | GET | 获取物流公司列表 |