Appearance
接口概述
凌悦易游前端 API 基础路径为 /api,所有接口均返回统一 JSON 格式。
基础信息
| 项目 | 说明 |
|---|---|
| 基础路径 | https://你的域名/api |
| 请求格式 | application/json 或 application/x-www-form-urlencoded |
| 响应格式 | application/json |
| 认证方式 | 请求头 token: {用户Token} |
统一响应结构
json
{
"code": 1,
"msg": "成功",
"data": {},
"show": 0
}| 字段 | 类型 | 说明 |
|---|---|---|
code | int | 1 = 成功,0 = 失败 |
msg | string | 提示信息 |
data | object/array | 业务数据 |
show | int | 1 = 前端应弹窗提示,0 = 不提示 |
认证说明
- 需要登录的接口必须在请求头中携带
token - Token 通过登录接口获取,详见 登录与注册
- 每个接口文档中均标注了是否需要登录
分页参数
列表类接口通常支持以下分页参数:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
page_no | int | 1 | 页码 |
page_size | int | 15 | 每页条数 |
分页响应:
json
{
"code": 1,
"data": {
"lists": [...],
"count": 100,
"page_no": 1,
"page_size": 15
}
}终端标识
部分接口需要 terminal 参数标识客户端类型:
| 值 | 终端 |
|---|---|
1 | H5 |
2 | 微信公众号 |
3 | 微信小程序 |
4 | APP |
5 | PC |
接口模块
| 模块 | 路径前缀 | 说明 |
|---|---|---|
| 首页与配置 | /api/index | 首页数据、全局配置、装修、公告 |
| 登录与注册 | /api/login | 账号登录、微信登录、插件登录 |
| 用户 | /api/user | 个人中心、编辑资料、排行榜 |
| 商品 | /api/goods | 分类、商品列表、详情、评论 |
| 订单 | /api/order | 下单、取消、确认、投诉、退款 |
| 打手 | /api/thug | 打手申请、接单、佣金、排行 |
| 支付 | /api/pay | 支付方式、预支付、回调 |
| 充值与提现 | /api/recharge /api/withdrawal | 充值、提现、余额 |
| IM | /api/im | 聊天 Token、创建会话 |
| 罚款 | /api/fine | 罚款列表、检查、缴纳 |
| 短信与搜索 | /api/sms /api/search | 验证码、热搜 |