商铺租赁物业管理系统 API

版本 1.0.0 · 基于 Laravel 11 + Sanctum Token 认证

Base URL: https://store.shuxing.vip/api
🚀 快速入门
1. 获取 Token
POST /api/auth/login
Content-Type: application/json

{"email": "admin@srpms.com", "password": "admin123"}

→ {"code":200,"data":{"token":"1|xxx...","user":{...}}}
2. 使用 Token
GET /api/health
Authorization: Bearer 1|xxx...
3. 公共参数
✅ 分页参数:?page=1&per_page=15
✅ 搜索参数:?keyword=xxx&status=1
✅ 响应格式:{"code":200,"message":"success","data":{...}}
💚 健康检查 1 个接口
GET /api/api/health 服务健康检查(PHP版本/磁盘/状态)
🔐 认证管理 6 个接口
POST /api/auth/login ⏱ 10次/分钟 用户登录
请求示例
{"email":"admin@srpms.com","password":"admin123"}
响应示例
{"code":200,"data":{"token":"1|xxx","user":{...}}}
POST /api/auth/register ⏱ 5次/分钟 用户注册
POST /api/auth/logout 🔒 需登录 退出登录
GET /api/auth/user 🔒 需登录 获取当前用户信息
PUT /api/auth/profile 🔒 需登录 更新个人资料
PUT /api/auth/password 🔒 需登录 修改密码
🏢 楼栋管理 5 个接口
GET /api/buildings 🔒 需登录📦 multi_building 楼栋列表(分页)
POST /api/buildings 🔒 需登录📦 multi_building 新建楼栋
GET /api/buildings/{id} 🔒 需登录 楼栋详情(含商铺列表)
PUT /api/buildings/{id} 🔒 需登录 更新楼栋
DELETE /api/buildings/{id} 🔒 需登录 删除楼栋
🏪 商铺管理 8 个接口
GET /api/shops 🔒 需登录📦 shop_management 商铺列表(分页+搜索)
POST /api/shops 🔒 需登录 新增商铺
GET /api/shops/{id} 🔒 需登录 商铺详情
PUT /api/shops/{id} 🔒 需登录 更新商铺
DELETE /api/shops/{id} 🔒 需登录 删除商铺
POST /api/shops/import 🔒 需登录 Excel批量导入商铺
GET /api/shops/statistics 🔒 需登录 商铺统计
GET /api/shops/buildings 🔒 需登录 楼栋下拉列表
📄 合同管理(含批量+打印+结算) 14 个接口
GET /api/contracts 🔒 需登录📦 simple_contract 合同列表(分页+搜索)
POST /api/contracts 🔒 需登录 新建合同(含递增/免租)
GET /api/contracts/expiring 🔒 需登录 即将到期合同
GET /api/contracts/{id} 🔒 需登录 合同详情
PUT /api/contracts/{id} 🔒 需登录 更新合同
PUT /api/contracts/{id}/activate 🔒 需登录 激活合同(自动生成账单)
POST /api/contracts/{id}/terminate 🔒 需登录 终止合同
POST /api/contracts/{id}/renew 🔒 需登录 续租合同
DELETE /api/contracts/{id} 🔒 需登录 删除合同
GET /api/contracts/{id}/print 🔒 需登录 🚀 合同打印(HTML页面)
GET /api/contracts/{id}/settle 🔒 需登录 🚀 退租结算(押金/欠费)
POST /api/contracts/batch-activate 🔒 需登录 🚀 批量激活合同
POST /api/contracts/batch-terminate 🔒 需登录 🚀 批量终止合同
POST /api/contracts/batch-renew 🔒 需登录 🚀 批量续租合同
💰 账单管理 7 个接口
GET /api/bills 🔒 需登录📦 rent_billing 账单列表(分页)
POST /api/bills 🔒 需登录 创建账单
GET /api/bills/statistics 🔒 需登录 账单统计
GET /api/bills/overdue 🔒 需登录 逾期账单
POST /api/bills/batch-pay 🔒 需登录 批量缴费
GET /api/bills/{id} 🔒 需登录 账单详情
POST /api/bills/{id}/pay 🔒 需登录 单笔缴费
💳 收款记录 4 个接口
GET /api/payments 🔒 需登录📦 payment_record 收款列表
POST /api/payments 🔒 需登录 新增收款(支持多种支付方式)
GET /api/payments/{id} 🔒 需登录 收款详情
DELETE /api/payments/{id} 🔒 需登录 删除收款
💸 🚀 支出管理 7 个接口
GET /api/expenses 🔒 需登录 支出列表
POST /api/expenses 🔒 需登录 新增支出
GET /api/expenses/{id} 🔒 需登录 支出详情
PUT /api/expenses/{id} 🔒 需登录 更新支出
DELETE /api/expenses/{id} 🔒 需登录 删除支出
GET /api/expenses/summary 🔒 需登录 支出月度汇总
GET /api/expenses/categories 🔒 需登录 支出分类列表
🔌 抄表管理 4 个接口
GET /api/meter-readings 🔒 需登录📦 meter_reading 抄表列表
POST /api/meter-readings 🔒 需登录 新增抄表
GET /api/meter-readings/{id} 🔒 需登录 抄表详情
GET /api/meter-readings/latest/{shopId}/{meterType} 🔒 需登录 最新读数
🔧 维修工单 6 个接口
GET /api/maintenance 🔒 需登录📦 maintenance_order 工单列表
POST /api/maintenance 🔒 需登录 创建工单
GET /api/maintenance/{id} 🔒 需登录 工单详情
POST /api/maintenance/{id}/assign 🔒 需登录 派单
POST /api/maintenance/{id}/status 🔒 需登录 更新工单状态
POST /api/maintenance/{id}/rate 🔒 需登录 评价工单
📊 报表中心 8 个接口
GET /api/reports/dashboard 🔒 需登录📦 basic_report 首页仪表盘
GET /api/reports/shops 🔒 需登录 商铺统计报表
GET /api/reports/contracts 🔒 需登录 合同统计报表
GET /api/reports/finance 🔒 需登录 财务报表
GET /api/reports/monthly-revenue 🔒 需登录 月度营收趋势
请求参数
?year=2026
GET /api/reports/tenant-ranking 🔒 需登录 租户欠费排名
GET /api/reports/revenue-summary 🔒 需登录 🚀 营收概要(本月/增长/待收)
GET /api/reports/occupancy-trend 🔒 需登录 🚀 出租率趋势(近4季度)
📈 🚀 财务驾驶舱 1 个接口
GET /api/finance/overview 🔒 需登录 财务总览(营收/支付/逾期/月度)
🏠 🚀 Dashboard组件 2 个接口
GET /api/dashboard/quick-stats 🔒 需登录 今日快捷统计
GET /api/dashboard/recent-payments 🔒 需登录 最近收款记录
🔔 通知中心 6 个接口
GET /api/notifications 🔒 需登录 通知列表(筛选/分页)
GET /api/notifications/unread-count 🔒 需登录 未读通知数
PUT /api/notifications/read-all 🔒 需登录 全部标记已读
PUT /api/notifications/{id}/read 🔒 需登录 标记单条已读
DELETE /api/notifications/clear-all 🔒 需登录 清空通知
DELETE /api/notifications/{id} 🔒 需登录 删除通知
📥 导出 3 个接口
GET /api/export/shops 🔒 需登录⏱ 10次/分钟 导出商铺 Excel
GET /api/export/contracts 🔒 需登录⏱ 10次/分钟 导出合同 Excel
GET /api/export/bills 🔒 需登录⏱ 10次/分钟 导出账单 Excel
⚙️ 系统管理(超管) 17 个接口
GET /api/admin/tenants 🔒 需登录 租户列表
POST /api/admin/tenants 🔒 需登录 创建租户
GET /api/admin/tenants/{id} 🔒 需登录 租户详情
PUT /api/admin/tenants/{id} 🔒 需登录 更新租户
DELETE /api/admin/tenants/{id} 🔒 需登录 删除租户
PUT /api/admin/tenants/{id}/package 🔒 需登录 切换套餐
PUT /api/admin/tenants/{id}/expiry 🔒 需登录 设置到期时间
PUT /api/admin/tenants/{id}/suspend 🔒 需登录 停用租户
PUT /api/admin/tenants/{id}/activate 🔒 需登录 启用租户
GET /api/admin/packages 🔒 需登录 套餐列表
POST /api/admin/packages 🔒 需登录 创建套餐
GET /api/admin/packages/features 🔒 需登录 套餐功能列表
GET /api/admin/stats/overview 🔒 需登录 系统概览统计
GET /api/admin/operation-logs 🔒 需登录 操作日志列表
GET /api/admin/operation-logs/stats 🔒 需登录 操作日志统计
GET /api/admin/operation-logs/modules 🔒 需登录 操作模块列表
GET /api/admin/operation-logs/{id} 🔒 需登录 操作日志详情
📖 📚 API 文档 1 个接口
GET /api/api/docs API 在线文档(本页面)