integral-shop/backend/docs/API接口速查表.md

# API 接口速查表

> **快速参考**: H5商城所有API接口  
> **Base URL**: http://miao1admin.suzhouyuqi.com  
> **更新时间**: 2025-11-08

---

## 🔑 认证说明

**Token Header**: `Authori-zation: Bearer {token}`  
**获取 Token**: 调用登录接口 `/api/user/login`

---

## 📋 完整接口列表

| # | 模块 | 接口路径 | 方法 | 需要登录 | 说明 |
|---|------|---------|------|---------|------|
| **一、用户认证** |
| 1 | 用户 | `/api/user/login` | POST | ❌ | 用户登录 |
| 2 | 用户 | `/api/user/register` | POST | ❌ | 用户注册 |
| 3 | 用户 | `/api/user/info` | POST | ✅ | 获取用户信息 |
| 4 | 用户 | `/api/user/nickname` | POST | ✅ | 修改昵称 |
| 5 | 用户 | `/api/user/changepwd` | POST | ✅ | 修改密码 |
| **二、商品相关** |
| 6 | 商品 | `/api/goods/category` | GET | ❌ | 商品分类列表 |
| 7 | 商品 | `/api/goods/list` | GET | ❌ | 商品列表 |
| 8 | 商品 | `/api/goods/detail` | GET | ❌ | 商品详情 |
| **三、订单相关** |
| 9 | 订单 | `/api/order/index` | POST | ✅ | 订单首页数据 |
| 10 | 订单 | `/api/order/goods` | GET | ✅ | 可购买商品列表 |
| 11 | 订单 | `/api/order/buy` | POST | ✅ | 购买商品（抢单） |
| 12 | 订单 | `/api/order/list` | GET | ✅ | 订单列表 |
| 13 | 订单 | `/api/order/detail` | GET | ✅ | 订单详情 |
| 14 | 订单 | `/api/order/pay` | POST | ✅ | 支付订单 |
| 15 | 订单 | `/api/order/confirm` | POST | ✅ | 确认订单（卖家发货） |
| 16 | 订单 | `/api/order/cancel` | POST | ✅ | 取消订单 |
| 17 | 订单 | `/api/order/resell` | POST | ✅ | 转卖订单 |
| **四、地址管理** |
| 18 | 地址 | `/api/address/list` | GET | ✅ | 地址列表 |
| 19 | 地址 | `/api/address/default` | POST | ✅ | 获取默认地址 |
| 20 | 地址 | `/api/address/insert` | POST | ✅ | 新增地址 |
| 21 | 地址 | `/api/address/update` | POST | ✅ | 更新地址 |
| 22 | 地址 | `/api/address/delete` | POST | ✅ | 删除地址 |
| **五、财务相关** |
| 23 | 财务 | `/api/money/list` | GET | ✅ | 财务记录列表 |
| 24 | 财务 | `/api/money/log` | GET | ✅ | 提现记录 |
| 25 | 财务 | `/api/money/withdraw` | POST | ✅ | 申请提现 |
| **六、支付相关** |
| 26 | 支付 | `/api/alipay/index` | GET | ✅ | 获取支付宝信息 |
| 27 | 支付 | `/api/alipay/bind` | POST | ✅ | 绑定支付宝 |
| 28 | 支付 | `/api/bank/index` | GET | ✅ | 获取银行卡信息 |
| **七、分享推广** |
| 29 | 分享 | `/api/share/index` | GET | ✅ | 分享首页数据 |
| 30 | 分享 | `/api/share/select` | GET | ✅ | 我的粉丝列表 |
| **八、首页相关** |
| 31 | 首页 | `/api/index/banner` | GET | ❌ | 轮播图 |
| 32 | 首页 | `/api/index/get` | POST | ❌ | 首页配置数据 |
| **九、短信相关** |
| 33 | 短信 | `/api/sms/send` | POST | ❌ | 发送短信验证码 |
| **十、其他** |
| 34 | 其他 | `/api/notify/sign` | POST | ❌ | 签名回调 |

---

## 🔥 常用接口

### 登录流程

```bash
# 1. 登录
POST /api/user/login
{
  "account": "手机号",
  "password": "密码"
}

# 2. 获取用户信息
POST /api/user/info
Header: Authori-zation: Bearer {token}
```

### 商品浏览

```bash
# 1. 获取分类
GET /api/goods/category

# 2. 获取商品列表
GET /api/goods/list?cate_id=1

# 3. 获取商品详情
GET /api/goods/detail?id=1
```

### 购买流程

```bash
# 1. 查看可购买商品
GET /api/order/goods?page=1&limit=20

# 2. 抢单
POST /api/order/buy
{
  "id": 143657,
  "seller_id": 92467
}

# 3. 支付
POST /api/order/pay
{
  "order_id": 148674,
  "address_id": 2911
}

# 4. 卖家确认发货
POST /api/order/confirm
{
  "order_id": 148674
}
```

---

## 📊 参数说明

### 订单列表参数 (`/api/order/list`)

| 参数 | 值 | 说明 |
|------|---|------|
| **cate** | 1 | 买方仓库（我购买的） |
| | 2 | 卖方仓库（我寄卖的） |
| **type** | 1 | 寄卖中/交易中 |
| | 2 | 已完成 |

### 财务列表参数 (`/api/money/list`)

| 参数 | 值 | 说明 |
|------|---|------|
| **cate** | 1 | 分红明细 |
| | 2 | 优惠券明细 |
| | 3 | 自购分红明细 |
| **type** | 1 | 收入 |
| | 2 | 支出 |

### 短信事件类型 (`/api/sms/send`)

| event | 说明 |
|-------|------|
| register | 注册 |
| resetpwd | 重置密码 |
| changepwd | 修改密码 |

### 订单状态

| status | 说明 |
|--------|------|
| 0 | 待支付 |
| 1 | 已支付（待发货） |
| 2 | 已完成（已发货） |

---

## 🎨 快速测试命令

### 设置变量

```bash
BASE_URL="http://miao1admin.suzhouyuqi.com"
TOKEN="your_token_here"
```

### 登录

```bash
curl -X POST $BASE_URL/api/user/login \
  -H "Content-Type: application/json" \
  -d '{"account":"18379637515","password":"123456"}'
```

### 获取用户信息

```bash
curl -X POST $BASE_URL/api/user/info \
  -H "Authori-zation: Bearer $TOKEN"
```

### 获取商品分类

```bash
curl $BASE_URL/api/goods/category
```

### 获取商品列表

```bash
curl "$BASE_URL/api/goods/list?cate_id=1"
```

### 查看可购买商品

```bash
curl "$BASE_URL/api/order/goods?page=1&limit=20" \
  -H "Authori-zation: Bearer $TOKEN"
```

### 查看我的订单（买方仓库-交易中）

```bash
curl "$BASE_URL/api/order/list?cate=1&type=1&page=1&limit=10" \
  -H "Authori-zation: Bearer $TOKEN"
```

### 查看我的订单（卖方仓库-已完成）

```bash
curl "$BASE_URL/api/order/list?cate=2&type=2&page=1&limit=10" \
  -H "Authori-zation: Bearer $TOKEN"
```

### 查看分红明细

```bash
curl "$BASE_URL/api/money/list?cate=1&type=1&page=1&limit=10" \
  -H "Authori-zation: Bearer $TOKEN"
```

### 查看我的粉丝

```bash
curl "$BASE_URL/api/share/select?page=1&limit=10" \
  -H "Authori-zation: Bearer $TOKEN"
```

### 发送短信验证码

```bash
curl -X POST $BASE_URL/api/sms/send \
  -H "Content-Type: application/json" \
  -d '{"mobile":"13800138000","event":"register"}'
```

---

## ⚠️ 重要提示

### 1. 认证头名称

**注意**: Header 名称是 `Authori-zation`（不是标准的 `Authorization`）

```
正确: Authori-zation: Bearer token
错误: Authorization: Bearer token
```

### 2. POST 方法查询

以下接口虽然是查询，但使用 POST 方法：

- `/api/user/info` - 获取用户信息
- `/api/index/get` - 获取首页配置
- `/api/order/index` - 获取订单首页
- `/api/address/default` - 获取默认地址

### 3. 限流保护

以下接口有频率限制：

- `/api/order/buy` - 购买（10秒内只能提交一次）
- `/api/order/pay` - 支付（有限流）
- `/api/order/confirm` - 确认（10秒内只能提交一次）
- `/api/sms/send` - 短信（每天每IP有限制）

### 4. 营业时间

购买商品受营业时间限制，超出时间无法购买。

---

## 📱 响应格式

### 成功响应

```json
{
  "code": 0,
  "msg": "success",
  "data": {
    // 返回数据
  }
}
```

### 失败响应

```json
{
  "code": 1001,
  "msg": "错误提示信息",
  "data": null
}
```

---

## 📚 相关文档

- [后端API接口文档.md](./后端API接口文档.md) - 详细的接口文档
- [API分析总结-2025-11-08.md](./API分析总结-2025-11-08.md) - 分析总结报告
- [服务器日志API分析.md](./服务器日志API分析.md) - 日志分析文档

---

**最后更新**: 2025-11-08  
**文档版本**: v1.0