← 返回平台 📥 下载 .md 文件 🔧 健康检查

⚡ 充电平台 API 文档

更新于 2026-07-29 13:50 · v1.5 · Token 鉴权版 · 基地址 http://49.232.222.161:3000

快充管理平台 API 契约文档

**版本**: v1.5
**最后更新**: 2026-07-29
**访问地址**: https://k-xx.cn/docs/api(密码: kxx-admin-2026)
**用途**: 前端(小程序 / 管理后台)与后端之间的接口协议
**原则**: 本文档是前后端之间的「合同」——接口定义一旦确认,双方按文档各自开发,互不阻塞
**给新人**: 拿到这份文档 + Mock Server 示例数据 = 可以独立开发小程序和后台,不需要碰协议网关

目录


1. 约定与规范

1.1 基础信息

协议 HTTPS
域名 `https://api.lkc.com` (开发期用 `http://localhost:3000`)
请求格式 `application/json`
响应格式 `application/json`
字符编码 UTF-8

1.2 统一响应结构

{
  "code": 0,
  "message": "ok",
  "data": { ... },
  "timestamp": 1717200000
}
字段 类型 说明
code int 0=成功, 非0=错误(见错误码表)
message string 提示信息
data object/array/null 业务数据
timestamp int 响应时间戳(秒)

1.3 通用错误码

code 说明
0 成功
1001 参数错误
1002 签名校验失败
1003 Token 过期
1004 Token 无效
2001 用户不存在
2002 余额不足
3001 充电桩不在线
3002 充电桩已占用
3003 充电桩故障
3004 充电订单不存在
4001 费率不存在
5000 服务器内部错误

1.4 分页结构

// 请求参数(Query String)
?page=1&pageSize=20

// 响应格式
{
  "code": 0,
  "message": "ok",
  "data": {
    "list": [ ... ],
    "total": 156,
    "page": 1,
    "pageSize": 20,
    "totalPages": 8
  }
}

1.5 认证方式


2. 用户模块

2.1 微信登录

POST /api/auth/login  (或 POST /api/users/login,完全等价)
参数 类型 必填 说明
code string code/userId 二选一 wx.login() 返回的临时 code(微信登录)
userId int code/userId 二选一 用户ID(管理后台/测试用,无需微信授权)
nickName string 微信昵称(code 模式下新用户自动存入)
avatarUrl string 微信头像URL(code 模式下新用户自动存入)

请求示例(微信登录):

{
  "code": "0a3XyY0w1kabcDeFGH",
  "nickName": "孔师傅",
  "avatarUrl": "https://thirdwx.qlogo.cn/xxx"
}

💡 wx.getUserProfile 已废弃(基础库 2.27.1+ 返回默认值)。新方案: