API接口文档
系统采用RESTful API设计规范,所有接口使用JSON格式进行数据交换。
RESTful
标准REST接口设计
JSON
统一JSON数据格式
JWT认证
Bearer Token认证
通用说明
Base URL
https://api.example.com/api/v1认证方式
除了登录接口外,所有接口都需要在请求头中携带Token:
Authorization: Bearer {access_token}响应格式
{
"code": 200,
"message": "success",
"data": { ... }
}错误码
200请求成功
400请求参数错误
401未授权,Token无效或过期
403无权限访问
404资源不存在
500服务器内部错误
API路由
认证接口
POST
/api/v1/auth/login用户登录,支持密码、验证码、微信扫码等登录方式
POST
/api/v1/auth/logout用户登出,清除登录状态
需要认证
GET
/api/v1/auth/me获取当前用户信息
需要认证
POST
/api/v1/auth/send-code发送验证码(登录、注册、重置密码)
GET
/api/v1/auth/wechat-qr获取微信扫码登录二维码
用户管理
GET
/api/v1/users获取用户列表(支持分页、搜索、筛选)
需要认证user:read
GET
/api/v1/users/:id获取用户详情
需要认证user:read
POST
/api/v1/users创建新用户
需要认证user:create
PUT
/api/v1/users/:id更新用户信息
需要认证user:update
DELETE
/api/v1/users/:id删除用户
需要认证user:delete
合作伙伴管理
GET
/api/v1/partners获取合作伙伴列表
需要认证agent:read
GET
/api/v1/partners/:id获取合作伙伴详情
需要认证agent:read
POST
/api/v1/partners创建合作伙伴
需要认证agent:create
PUT
/api/v1/partners/:id更新合作伙伴信息
需要认证agent:update
DELETE
/api/v1/partners/:id删除合作伙伴
需要认证agent:delete
企业管理
GET
/api/v1/tenants获取企业列表
需要认证tenant:read
GET
/api/v1/tenants/:id获取企业详情
需要认证tenant:read
POST
/api/v1/tenants创建企业
需要认证tenant:create
PUT
/api/v1/tenants/:id更新企业信息
需要认证tenant:update
DELETE
/api/v1/tenants/:id删除企业
需要认证tenant:delete
员工管理
GET
/api/v1/employees获取员工列表
需要认证employee:read
GET
/api/v1/employees/:id获取员工详情
需要认证employee:read
POST
/api/v1/employees创建员工
需要认证employee:create
PUT
/api/v1/employees/:id更新员工信息
需要认证employee:update
DELETE
/api/v1/employees/:id删除员工
需要认证employee:delete
工资表管理
GET
/api/v1/payroll-sheets获取工资表列表
需要认证payroll:read
GET
/api/v1/payroll-sheets/:id获取工资表详情
需要认证payroll:read
POST
/api/v1/payroll-sheets创建工资表
需要认证payroll:create
PUT
/api/v1/payroll-sheets/:id更新工资表
需要认证payroll:update
POST
/api/v1/payroll-sheets/:id/calculate计算薪资
需要认证payroll:calculate
POST
/api/v1/payroll-sheets/:id/approve审批工资表
需要认证payroll:approve
POST
/api/v1/payroll-sheets/:id/send发送工资条
需要认证payroll:send
订单管理
GET
/api/v1/orders获取订单列表
需要认证order:read
GET
/api/v1/orders/:id获取订单详情
需要认证order:read
POST
/api/v1/orders创建订单
需要认证order:create
POST
/api/v1/orders/:id/pay支付订单
需要认证order:pay
POST
/api/v1/orders/:id/refund订单退款
需要认证order:refund
微信小程序管理
GET
/api/v1/miniprogram/upload-tasks获取代码上传任务列表
需要认证miniprogram:read
POST
/api/v1/miniprogram/upload上传小程序代码包
需要认证miniprogram:upload
GET
/api/v1/miniprogram/audit-tasks获取审核任务列表
需要认证miniprogram:read
POST
/api/v1/miniprogram/audit/submit提交代码审核
需要认证miniprogram:audit
GET
/api/v1/miniprogram/audit/status查询审核状态
需要认证miniprogram:read
POST
/api/v1/miniprogram/publish发布小程序(全量或灰度)
需要认证miniprogram:publish
POST
/api/v1/miniprogram/rollback回滚小程序版本
需要认证miniprogram:publish
GET
/api/v1/miniprogram/payment/config获取支付配置
需要认证miniprogram:payment
PUT
/api/v1/miniprogram/payment/config更新支付配置
需要认证miniprogram:payment
POST
/api/v1/miniprogram/payment/cert/upload上传支付证书
需要认证miniprogram:payment
POST
/api/v1/miniprogram/payment/test测试支付
需要认证miniprogram:payment
POST
/api/v1/miniprogram/payment/unified-order统一下单
需要认证payment:pay
POST
/api/v1/miniprogram/payment/query查询订单
需要认证payment:query
POST
/api/v1/miniprogram/payment/refund申请退款
需要认证payment:refund
POST
/api/v1/miniprogram/payment/close关闭订单
需要认证payment:close