275 lines
26 KiB
Markdown
275 lines
26 KiB
Markdown
# Xboard API 清单
|
|
|
|
基于 `reference/Xboard` 中的路由定义与控制器源码静态整理。
|
|
|
|
说明：
|
|
- `admin_secure_path` 表示后台安全路径，对应实际路由前缀 `/api/v2/{secure_path}`。
|
|
- `subscribe_path` 表示订阅短链路径，对应实际路由前缀 `/{subscribe_path}/{token}`。
|
|
- `ANY` 表示路由声明为 `any/match`，即接受多个 HTTP 方法。
|
|
- “控制器缺失”表示路由已注册，但在 `reference/Xboard` 中未找到对应方法。
|
|
|
|
## V1 Guest
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v1/guest/plan/fetch` | 公开 | `V1\Guest\PlanController@fetch` | 获取可售套餐 |
|
|
| POST | `/api/v1/guest/telegram/webhook` | 公开 | `V1\Guest\TelegramController@webhook` | Telegram Webhook |
|
|
| GET/POST | `/api/v1/guest/payment/notify/{method}/{uuid}` | 公开 | `V1\Guest\PaymentController@notify` | 支付回调 |
|
|
| GET | `/api/v1/guest/comm/config` | 公开 | `V1\Guest\CommController@config` | 前台公共配置 |
|
|
|
|
## V1 Passport
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| POST | `/api/v1/passport/auth/register` | 公开 | `V1\Passport\AuthController@register` | 注册 |
|
|
| POST | `/api/v1/passport/auth/login` | 公开 | `V1\Passport\AuthController@login` | 登录 |
|
|
| GET | `/api/v1/passport/auth/token2Login` | 公开 | `V1\Passport\AuthController@token2Login` | 邮件/Token 快登 |
|
|
| POST | `/api/v1/passport/auth/forget` | 公开 | `V1\Passport\AuthController@forget` | 重置密码 |
|
|
| POST | `/api/v1/passport/auth/getQuickLoginUrl` | 公开 | `V1\Passport\AuthController@getQuickLoginUrl` | 生成快登链接 |
|
|
| POST | `/api/v1/passport/auth/loginWithMailLink` | 公开 | `V1\Passport\AuthController@loginWithMailLink` | 发送邮件登录链接 |
|
|
| POST | `/api/v1/passport/comm/sendEmailVerify` | 公开 | `V1\Passport\CommController@sendEmailVerify` | 发送邮箱验证码 |
|
|
| POST | `/api/v1/passport/comm/pv` | 公开 | `V1\Passport\CommController@pv` | 邀请码访问计数 |
|
|
|
|
## V1 User
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v1/user/resetSecurity` | `user` | `V1\User\UserController@resetSecurity` | 重置订阅密钥 |
|
|
| GET | `/api/v1/user/info` | `user` | `V1\User\UserController@info` | 当前用户概要 |
|
|
| POST | `/api/v1/user/changePassword` | `user` | `V1\User\UserController@changePassword` | 修改密码 |
|
|
| POST | `/api/v1/user/update` | `user` | `V1\User\UserController@update` | 更新提醒设置 |
|
|
| GET | `/api/v1/user/getSubscribe` | `user` | `V1\User\UserController@getSubscribe` | 订阅信息 |
|
|
| GET | `/api/v1/user/getStat` | `user` | `V1\User\UserController@getStat` | 用户统计 |
|
|
| GET | `/api/v1/user/checkLogin` | `user` | `V1\User\UserController@checkLogin` | 登录态检查 |
|
|
| POST | `/api/v1/user/transfer` | `user` | `V1\User\UserController@transfer` | 佣金转余额 |
|
|
| POST | `/api/v1/user/getQuickLoginUrl` | `user` | `V1\User\UserController@getQuickLoginUrl` | 生成快登链接 |
|
|
| GET | `/api/v1/user/getActiveSession` | `user` | `V1\User\UserController@getActiveSession` | 获取活跃会话 |
|
|
| POST | `/api/v1/user/removeActiveSession` | `user` | `V1\User\UserController@removeActiveSession` | 删除活跃会话 |
|
|
| POST | `/api/v1/user/order/save` | `user` | `V1\User\OrderController@save` | 创建订单 |
|
|
| POST | `/api/v1/user/order/checkout` | `user` | `V1\User\OrderController@checkout` | 订单支付 |
|
|
| GET | `/api/v1/user/order/check` | `user` | `V1\User\OrderController@check` | 查询订单状态 |
|
|
| GET | `/api/v1/user/order/detail` | `user` | `V1\User\OrderController@detail` | 订单详情 |
|
|
| GET | `/api/v1/user/order/fetch` | `user` | `V1\User\OrderController@fetch` | 订单列表 |
|
|
| GET | `/api/v1/user/order/getPaymentMethod` | `user` | `V1\User\OrderController@getPaymentMethod` | 支付方式列表 |
|
|
| POST | `/api/v1/user/order/cancel` | `user` | `V1\User\OrderController@cancel` | 取消订单 |
|
|
| GET | `/api/v1/user/plan/fetch` | `user` | `V1\User\PlanController@fetch` | 套餐列表/详情 |
|
|
| GET | `/api/v1/user/invite/save` | `user` | `V1\User\InviteController@save` | 创建邀请码 |
|
|
| GET | `/api/v1/user/invite/fetch` | `user` | `V1\User\InviteController@fetch` | 邀请概览 |
|
|
| GET | `/api/v1/user/invite/details` | `user` | `V1\User\InviteController@details` | 邀请返佣明细 |
|
|
| GET | `/api/v1/user/notice/fetch` | `user` | `V1\User\NoticeController@fetch` | 公告列表 |
|
|
| POST | `/api/v1/user/ticket/reply` | `user` | `V1\User\TicketController@reply` | 回复工单 |
|
|
| POST | `/api/v1/user/ticket/close` | `user` | `V1\User\TicketController@close` | 关闭工单 |
|
|
| POST | `/api/v1/user/ticket/save` | `user` | `V1\User\TicketController@save` | 创建工单 |
|
|
| GET | `/api/v1/user/ticket/fetch` | `user` | `V1\User\TicketController@fetch` | 工单列表/详情 |
|
|
| POST | `/api/v1/user/ticket/withdraw` | `user` | `V1\User\TicketController@withdraw` | 佣金提现工单 |
|
|
| GET | `/api/v1/user/server/fetch` | `user` | `V1\User\ServerController@fetch` | 可用节点列表 |
|
|
| POST | `/api/v1/user/coupon/check` | `user` | `V1\User\CouponController@check` | 校验优惠券 |
|
|
| POST | `/api/v1/user/gift-card/check` | `user` | `V1\User\GiftCardController@check` | 预检礼品卡 |
|
|
| POST | `/api/v1/user/gift-card/redeem` | `user` | `V1\User\GiftCardController@redeem` | 兑换礼品卡 |
|
|
| GET | `/api/v1/user/gift-card/history` | `user` | `V1\User\GiftCardController@history` | 礼品卡使用历史 |
|
|
| GET | `/api/v1/user/gift-card/detail` | `user` | `V1\User\GiftCardController@detail` | 礼品卡记录详情 |
|
|
| GET | `/api/v1/user/gift-card/types` | `user` | `V1\User\GiftCardController@types` | 礼品卡类型映射 |
|
|
| GET | `/api/v1/user/telegram/getBotInfo` | `user` | `V1\User\TelegramController@getBotInfo` | Telegram Bot 信息 |
|
|
| GET | `/api/v1/user/comm/config` | `user` | `V1\User\CommController@config` | 用户公共配置 |
|
|
| POST | `/api/v1/user/comm/getStripePublicKey` | `user` | `V1\User\CommController@getStripePublicKey` | Stripe 公钥 |
|
|
| GET | `/api/v1/user/knowledge/fetch` | `user` | `V1\User\KnowledgeController@fetch` | 知识库列表/详情 |
|
|
| GET | `/api/v1/user/knowledge/getCategory` | `user` | `V1\User\KnowledgeController@getCategory` | 路由已注册，但控制器缺失 |
|
|
| GET | `/api/v1/user/stat/getTrafficLog` | `user` | `V1\User\StatController@getTrafficLog` | 流量日志 |
|
|
|
|
## V1 Server
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v1/server/UniProxy/config` | `server` | `V1\Server\UniProxyController@config` | 节点配置 |
|
|
| GET | `/api/v1/server/UniProxy/user` | `server` | `V1\Server\UniProxyController@user` | 节点用户列表 |
|
|
| POST | `/api/v1/server/UniProxy/push` | `server` | `V1\Server\UniProxyController@push` | 上报流量 |
|
|
| POST | `/api/v1/server/UniProxy/alive` | `server` | `V1\Server\UniProxyController@alive` | 上报在线设备 |
|
|
| GET | `/api/v1/server/UniProxy/alivelist` | `server` | `V1\Server\UniProxyController@alivelist` | 获取在线设备 |
|
|
| POST | `/api/v1/server/UniProxy/status` | `server` | `V1\Server\UniProxyController@status` | 上报负载状态 |
|
|
| GET | `/api/v1/server/ShadowsocksTidalab/user` | `server:shadowsocks` | `V1\Server\ShadowsocksTidalabController@user` | Shadowsocks 用户 |
|
|
| POST | `/api/v1/server/ShadowsocksTidalab/submit` | `server:shadowsocks` | `V1\Server\ShadowsocksTidalabController@submit` | Shadowsocks 流量上报 |
|
|
| GET | `/api/v1/server/TrojanTidalab/config` | `server:trojan` | `V1\Server\TrojanTidalabController@config` | Trojan 配置 |
|
|
| GET | `/api/v1/server/TrojanTidalab/user` | `server:trojan` | `V1\Server\TrojanTidalabController@user` | Trojan 用户 |
|
|
| POST | `/api/v1/server/TrojanTidalab/submit` | `server:trojan` | `V1\Server\TrojanTidalabController@submit` | Trojan 流量上报 |
|
|
|
|
## V1 Client
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v1/client/subscribe` | `client` | `V1\Client\ClientController@subscribe` | 旧版订阅入口 |
|
|
| GET | `/api/v1/client/app/getConfig` | `client` | `V1\Client\AppController@getConfig` | Clash YAML 配置 |
|
|
| GET | `/api/v1/client/app/getVersion` | `client` | `V1\Client\AppController@getVersion` | 客户端版本信息 |
|
|
| GET | `/{subscribe_path}/{token}` | `client` | `V1\Client\ClientController@subscribe` | 短链订阅入口 |
|
|
|
|
## V2 Passport
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| POST | `/api/v2/passport/auth/register` | 公开 | `V1\Passport\AuthController@register` | 与 V1 相同 |
|
|
| POST | `/api/v2/passport/auth/login` | 公开 | `V1\Passport\AuthController@login` | 与 V1 相同 |
|
|
| GET | `/api/v2/passport/auth/token2Login` | 公开 | `V1\Passport\AuthController@token2Login` | 与 V1 相同 |
|
|
| POST | `/api/v2/passport/auth/forget` | 公开 | `V1\Passport\AuthController@forget` | 与 V1 相同 |
|
|
| POST | `/api/v2/passport/auth/getQuickLoginUrl` | 公开 | `V1\Passport\AuthController@getQuickLoginUrl` | 与 V1 相同 |
|
|
| POST | `/api/v2/passport/auth/loginWithMailLink` | 公开 | `V1\Passport\AuthController@loginWithMailLink` | 与 V1 相同 |
|
|
| POST | `/api/v2/passport/comm/sendEmailVerify` | 公开 | `V1\Passport\CommController@sendEmailVerify` | 与 V1 相同 |
|
|
| POST | `/api/v2/passport/comm/pv` | 公开 | `V1\Passport\CommController@pv` | 与 V1 相同 |
|
|
|
|
## V2 User / Client / Server
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v2/user/resetSecurity` | `user` | `V1\User\UserController@resetSecurity` | 与 V1 相同 |
|
|
| GET | `/api/v2/user/info` | `user` | `V1\User\UserController@info` | 与 V1 相同 |
|
|
| GET | `/api/v2/client/app/getConfig` | `client` | `V2\Client\AppController@getConfig` | 新客户端配置 JSON |
|
|
| GET | `/api/v2/client/app/getVersion` | `client` | `V2\Client\AppController@getVersion` | 与 V1 相同 |
|
|
| POST | `/api/v2/server/handshake` | `server` | `V2\Server\ServerController@handshake` | 节点握手 |
|
|
| POST | `/api/v2/server/report` | `server` | `V2\Server\ServerController@report` | 合并上报 |
|
|
| GET | `/api/v2/server/config` | `server` | `V1\Server\UniProxyController@config` | 与 V1 UniProxy 相同 |
|
|
| GET | `/api/v2/server/user` | `server` | `V1\Server\UniProxyController@user` | 与 V1 UniProxy 相同 |
|
|
| POST | `/api/v2/server/push` | `server` | `V1\Server\UniProxyController@push` | 与 V1 UniProxy 相同 |
|
|
| POST | `/api/v2/server/alive` | `server` | `V1\Server\UniProxyController@alive` | 与 V1 UniProxy 相同 |
|
|
| GET | `/api/v2/server/alivelist` | `server` | `V1\Server\UniProxyController@alivelist` | 与 V1 UniProxy 相同 |
|
|
| POST | `/api/v2/server/status` | `server` | `V1\Server\UniProxyController@status` | 与 V1 UniProxy 相同 |
|
|
|
|
## V2 Admin - Config / Plan / Server
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v2/{admin_secure_path}/config/fetch` | `admin` | `V2\Admin\ConfigController@fetch` | 后台配置 |
|
|
| POST | `/api/v2/{admin_secure_path}/config/save` | `admin` | `V2\Admin\ConfigController@save` | 保存配置 |
|
|
| GET | `/api/v2/{admin_secure_path}/config/getEmailTemplate` | `admin` | `V2\Admin\ConfigController@getEmailTemplate` | 邮件模板目录 |
|
|
| GET | `/api/v2/{admin_secure_path}/config/getThemeTemplate` | `admin` | `V2\Admin\ConfigController@getThemeTemplate` | 主题目录 |
|
|
| POST | `/api/v2/{admin_secure_path}/config/setTelegramWebhook` | `admin` | `V2\Admin\ConfigController@setTelegramWebhook` | 设置 Telegram Webhook |
|
|
| POST | `/api/v2/{admin_secure_path}/config/testSendMail` | `admin` | `V2\Admin\ConfigController@testSendMail` | 测试发信 |
|
|
| GET | `/api/v2/{admin_secure_path}/plan/fetch` | `admin` | `V2\Admin\PlanController@fetch` | 套餐列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/plan/save` | `admin` | `V2\Admin\PlanController@save` | 创建/更新套餐 |
|
|
| POST | `/api/v2/{admin_secure_path}/plan/drop` | `admin` | `V2\Admin\PlanController@drop` | 删除套餐 |
|
|
| POST | `/api/v2/{admin_secure_path}/plan/update` | `admin` | `V2\Admin\PlanController@update` | 更新开关字段 |
|
|
| POST | `/api/v2/{admin_secure_path}/plan/sort` | `admin` | `V2\Admin\PlanController@sort` | 套餐排序 |
|
|
| GET | `/api/v2/{admin_secure_path}/server/group/fetch` | `admin` | `V2\Admin\Server\GroupController@fetch` | 节点分组列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/group/save` | `admin` | `V2\Admin\Server\GroupController@save` | 创建/更新分组 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/group/drop` | `admin` | `V2\Admin\Server\GroupController@drop` | 删除分组 |
|
|
| GET | `/api/v2/{admin_secure_path}/server/route/fetch` | `admin` | `V2\Admin\Server\RouteController@fetch` | 路由规则列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/route/save` | `admin` | `V2\Admin\Server\RouteController@save` | 创建/更新路由规则 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/route/drop` | `admin` | `V2\Admin\Server\RouteController@drop` | 删除路由规则 |
|
|
| GET | `/api/v2/{admin_secure_path}/server/manage/getNodes` | `admin` | `V2\Admin\Server\ManageController@getNodes` | 节点列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/sort` | `admin` | `V2\Admin\Server\ManageController@sort` | 节点排序 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/update` | `admin` | `V2\Admin\Server\ManageController@update` | 节点开关 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/save` | `admin` | `V2\Admin\Server\ManageController@save` | 创建/更新节点 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/drop` | `admin` | `V2\Admin\Server\ManageController@drop` | 删除节点 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/copy` | `admin` | `V2\Admin\Server\ManageController@copy` | 复制节点 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/batchDelete` | `admin` | `V2\Admin\Server\ManageController@batchDelete` | 批量删除节点 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/resetTraffic` | `admin` | `V2\Admin\Server\ManageController@resetTraffic` | 重置单节点流量 |
|
|
| POST | `/api/v2/{admin_secure_path}/server/manage/batchResetTraffic` | `admin` | `V2\Admin\Server\ManageController@batchResetTraffic` | 批量重置节点流量 |
|
|
|
|
## V2 Admin - Order / User / Stat
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| ANY | `/api/v2/{admin_secure_path}/order/fetch` | `admin` | `V2\Admin\OrderController@fetch` | 订单分页列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/order/update` | `admin` | `V2\Admin\OrderController@update` | 更新订单佣金状态 |
|
|
| POST | `/api/v2/{admin_secure_path}/order/assign` | `admin` | `V2\Admin\OrderController@assign` | 指派订单 |
|
|
| POST | `/api/v2/{admin_secure_path}/order/paid` | `admin` | `V2\Admin\OrderController@paid` | 手动标记已支付 |
|
|
| POST | `/api/v2/{admin_secure_path}/order/cancel` | `admin` | `V2\Admin\OrderController@cancel` | 取消订单 |
|
|
| POST | `/api/v2/{admin_secure_path}/order/detail` | `admin` | `V2\Admin\OrderController@detail` | 订单详情 |
|
|
| ANY | `/api/v2/{admin_secure_path}/user/fetch` | `admin` | `V2\Admin\UserController@fetch` | 用户分页列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/user/update` | `admin` | `V2\Admin\UserController@update` | 更新用户 |
|
|
| GET | `/api/v2/{admin_secure_path}/user/getUserInfoById` | `admin` | `V2\Admin\UserController@getUserInfoById` | 用户详情 |
|
|
| POST | `/api/v2/{admin_secure_path}/user/generate` | `admin` | `V2\Admin\UserController@generate` | 生成用户 |
|
|
| POST | `/api/v2/{admin_secure_path}/user/dumpCSV` | `admin` | `V2\Admin\UserController@dumpCSV` | 导出 CSV |
|
|
| POST | `/api/v2/{admin_secure_path}/user/sendMail` | `admin` | `V2\Admin\UserController@sendMail` | 批量发信 |
|
|
| POST | `/api/v2/{admin_secure_path}/user/ban` | `admin` | `V2\Admin\UserController@ban` | 批量封禁 |
|
|
| POST | `/api/v2/{admin_secure_path}/user/resetSecret` | `admin` | `V2\Admin\UserController@resetSecret` | 重置用户订阅密钥 |
|
|
| POST | `/api/v2/{admin_secure_path}/user/setInviteUser` | `admin` | `V2\Admin\UserController@setInviteUser` | 路由已注册，但控制器缺失 |
|
|
| POST | `/api/v2/{admin_secure_path}/user/destroy` | `admin` | `V2\Admin\UserController@destroy` | 删除用户 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getOverride` | `admin` | `V2\Admin\StatController@getOverride` | 概览统计 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getStats` | `admin` | `V2\Admin\StatController@getStats` | 综合统计 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getServerLastRank` | `admin` | `V2\Admin\StatController@getServerLastRank` | 当日节点排行 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getServerYesterdayRank` | `admin` | `V2\Admin\StatController@getServerYesterdayRank` | 昨日节点排行 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getOrder` | `admin` | `V2\Admin\StatController@getOrder` | 订单统计 |
|
|
| ANY | `/api/v2/{admin_secure_path}/stat/getStatUser` | `admin` | `V2\Admin\StatController@getStatUser` | 用户统计明细 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getRanking` | `admin` | `V2\Admin\StatController@getRanking` | 路由已注册，但控制器缺失 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getStatRecord` | `admin` | `V2\Admin\StatController@getStatRecord` | 统计记录 |
|
|
| GET | `/api/v2/{admin_secure_path}/stat/getTrafficRank` | `admin` | `V2\Admin\StatController@getTrafficRank` | 流量排行 |
|
|
|
|
## V2 Admin - Notice / Ticket / Coupon / Knowledge
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v2/{admin_secure_path}/notice/fetch` | `admin` | `V2\Admin\NoticeController@fetch` | 公告列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/notice/save` | `admin` | `V2\Admin\NoticeController@save` | 创建/更新公告 |
|
|
| POST | `/api/v2/{admin_secure_path}/notice/update` | `admin` | `V2\Admin\NoticeController@update` | 路由已注册，但控制器缺失 |
|
|
| POST | `/api/v2/{admin_secure_path}/notice/drop` | `admin` | `V2\Admin\NoticeController@drop` | 删除公告 |
|
|
| POST | `/api/v2/{admin_secure_path}/notice/show` | `admin` | `V2\Admin\NoticeController@show` | 切换显示状态 |
|
|
| POST | `/api/v2/{admin_secure_path}/notice/sort` | `admin` | `V2\Admin\NoticeController@sort` | 公告排序 |
|
|
| ANY | `/api/v2/{admin_secure_path}/ticket/fetch` | `admin` | `V2\Admin\TicketController@fetch` | 工单分页/详情 |
|
|
| POST | `/api/v2/{admin_secure_path}/ticket/reply` | `admin` | `V2\Admin\TicketController@reply` | 回复工单 |
|
|
| POST | `/api/v2/{admin_secure_path}/ticket/close` | `admin` | `V2\Admin\TicketController@close` | 关闭工单 |
|
|
| ANY | `/api/v2/{admin_secure_path}/coupon/fetch` | `admin` | `V2\Admin\CouponController@fetch` | 优惠券分页列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/coupon/generate` | `admin` | `V2\Admin\CouponController@generate` | 创建/批量生成优惠券 |
|
|
| POST | `/api/v2/{admin_secure_path}/coupon/drop` | `admin` | `V2\Admin\CouponController@drop` | 删除优惠券 |
|
|
| POST | `/api/v2/{admin_secure_path}/coupon/show` | `admin` | `V2\Admin\CouponController@show` | 切换显示状态 |
|
|
| POST | `/api/v2/{admin_secure_path}/coupon/update` | `admin` | `V2\Admin\CouponController@update` | 源码成功路径未显式返回 |
|
|
| GET | `/api/v2/{admin_secure_path}/knowledge/fetch` | `admin` | `V2\Admin\KnowledgeController@fetch` | 知识库列表/详情 |
|
|
| GET | `/api/v2/{admin_secure_path}/knowledge/getCategory` | `admin` | `V2\Admin\KnowledgeController@getCategory` | 分类列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/knowledge/save` | `admin` | `V2\Admin\KnowledgeController@save` | 创建/更新知识库 |
|
|
| POST | `/api/v2/{admin_secure_path}/knowledge/show` | `admin` | `V2\Admin\KnowledgeController@show` | 切换显示状态 |
|
|
| POST | `/api/v2/{admin_secure_path}/knowledge/drop` | `admin` | `V2\Admin\KnowledgeController@drop` | 删除知识库 |
|
|
| POST | `/api/v2/{admin_secure_path}/knowledge/sort` | `admin` | `V2\Admin\KnowledgeController@sort` | 排序 |
|
|
|
|
## V2 Admin - Gift Card / Payment
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| ANY | `/api/v2/{admin_secure_path}/gift-card/templates` | `admin` | `V2\Admin\GiftCardController@templates` | 模板分页列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/gift-card/create-template` | `admin` | `V2\Admin\GiftCardController@createTemplate` | 创建模板 |
|
|
| POST | `/api/v2/{admin_secure_path}/gift-card/update-template` | `admin` | `V2\Admin\GiftCardController@updateTemplate` | 更新模板 |
|
|
| POST | `/api/v2/{admin_secure_path}/gift-card/delete-template` | `admin` | `V2\Admin\GiftCardController@deleteTemplate` | 删除模板 |
|
|
| POST | `/api/v2/{admin_secure_path}/gift-card/generate-codes` | `admin` | `V2\Admin\GiftCardController@generateCodes` | 批量生成兑换码 |
|
|
| ANY | `/api/v2/{admin_secure_path}/gift-card/codes` | `admin` | `V2\Admin\GiftCardController@codes` | 兑换码分页列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/gift-card/toggle-code` | `admin` | `V2\Admin\GiftCardController@toggleCode` | 启用/禁用兑换码 |
|
|
| GET | `/api/v2/{admin_secure_path}/gift-card/export-codes` | `admin` | `V2\Admin\GiftCardController@exportCodes` | 导出兑换码文本 |
|
|
| POST | `/api/v2/{admin_secure_path}/gift-card/update-code` | `admin` | `V2\Admin\GiftCardController@updateCode` | 更新兑换码 |
|
|
| POST | `/api/v2/{admin_secure_path}/gift-card/delete-code` | `admin` | `V2\Admin\GiftCardController@deleteCode` | 删除兑换码 |
|
|
| ANY | `/api/v2/{admin_secure_path}/gift-card/usages` | `admin` | `V2\Admin\GiftCardController@usages` | 使用记录分页列表 |
|
|
| ANY | `/api/v2/{admin_secure_path}/gift-card/statistics` | `admin` | `V2\Admin\GiftCardController@statistics` | 礼品卡统计 |
|
|
| GET | `/api/v2/{admin_secure_path}/gift-card/types` | `admin` | `V2\Admin\GiftCardController@types` | 礼品卡类型映射 |
|
|
| GET | `/api/v2/{admin_secure_path}/payment/fetch` | `admin` | `V2\Admin\PaymentController@fetch` | 支付方式列表 |
|
|
| GET | `/api/v2/{admin_secure_path}/payment/getPaymentMethods` | `admin` | `V2\Admin\PaymentController@getPaymentMethods` | 支付插件类型 |
|
|
| POST | `/api/v2/{admin_secure_path}/payment/getPaymentForm` | `admin` | `V2\Admin\PaymentController@getPaymentForm` | 支付表单定义 |
|
|
| POST | `/api/v2/{admin_secure_path}/payment/save` | `admin` | `V2\Admin\PaymentController@save` | 创建/更新支付方式 |
|
|
| POST | `/api/v2/{admin_secure_path}/payment/drop` | `admin` | `V2\Admin\PaymentController@drop` | 删除支付方式 |
|
|
| POST | `/api/v2/{admin_secure_path}/payment/show` | `admin` | `V2\Admin\PaymentController@show` | 切换支付方式状态 |
|
|
| POST | `/api/v2/{admin_secure_path}/payment/sort` | `admin` | `V2\Admin\PaymentController@sort` | 排序 |
|
|
|
|
## V2 Admin - System / Theme / Plugin / Traffic Reset
|
|
|
|
| 方法 | 路径 | 鉴权 | 控制器 | 备注 |
|
|
| --- | --- | --- | --- | --- |
|
|
| GET | `/api/v2/{admin_secure_path}/system/getSystemStatus` | `admin` | `V2\Admin\SystemController@getSystemStatus` | 系统状态 |
|
|
| GET | `/api/v2/{admin_secure_path}/system/getQueueStats` | `admin` | `V2\Admin\SystemController@getQueueStats` | Horizon 队列统计 |
|
|
| GET | `/api/v2/{admin_secure_path}/system/getQueueWorkload` | `admin` | `V2\Admin\SystemController@getQueueWorkload` | 队列负载 |
|
|
| GET | `/api/v2/{admin_secure_path}/system/getQueueMasters` | `admin` | `Laravel\Horizon\Http\Controllers\MasterSupervisorController@index` | 外部 Horizon 控制器 |
|
|
| GET | `/api/v2/{admin_secure_path}/system/getHorizonFailedJobs` | `admin` | `V2\Admin\SystemController@getHorizonFailedJobs` | Horizon 失败任务分页 |
|
|
| ANY | `/api/v2/{admin_secure_path}/system/getAuditLog` | `admin` | `V2\Admin\SystemController@getAuditLog` | 后台审计日志 |
|
|
| GET | `/api/v2/{admin_secure_path}/theme/getThemes` | `admin` | `V2\Admin\ThemeController@getThemes` | 主题列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/theme/upload` | `admin` | `V2\Admin\ThemeController@upload` | 上传主题 |
|
|
| POST | `/api/v2/{admin_secure_path}/theme/delete` | `admin` | `V2\Admin\ThemeController@delete` | 删除主题 |
|
|
| POST | `/api/v2/{admin_secure_path}/theme/saveThemeConfig` | `admin` | `V2\Admin\ThemeController@saveThemeConfig` | 保存主题配置 |
|
|
| POST | `/api/v2/{admin_secure_path}/theme/getThemeConfig` | `admin` | `V2\Admin\ThemeController@getThemeConfig` | 获取主题配置 |
|
|
| GET | `/api/v2/{admin_secure_path}/plugin/types` | `admin` | `V2\Admin\PluginController@types` | 插件类型 |
|
|
| GET | `/api/v2/{admin_secure_path}/plugin/getPlugins` | `admin` | `V2\Admin\PluginController@index` | 插件列表 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/upload` | `admin` | `V2\Admin\PluginController@upload` | 上传插件 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/delete` | `admin` | `V2\Admin\PluginController@delete` | 删除插件 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/install` | `admin` | `V2\Admin\PluginController@install` | 安装插件 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/uninstall` | `admin` | `V2\Admin\PluginController@uninstall` | 卸载插件 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/enable` | `admin` | `V2\Admin\PluginController@enable` | 启用插件 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/disable` | `admin` | `V2\Admin\PluginController@disable` | 禁用插件 |
|
|
| GET | `/api/v2/{admin_secure_path}/plugin/config` | `admin` | `V2\Admin\PluginController@getConfig` | 插件配置 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/config` | `admin` | `V2\Admin\PluginController@updateConfig` | 更新插件配置 |
|
|
| POST | `/api/v2/{admin_secure_path}/plugin/upgrade` | `admin` | `V2\Admin\PluginController@upgrade` | 升级插件 |
|
|
| GET | `/api/v2/{admin_secure_path}/traffic-reset/logs` | `admin` | `V2\Admin\TrafficResetController@logs` | 流量重置日志 |
|
|
| GET | `/api/v2/{admin_secure_path}/traffic-reset/stats` | `admin` | `V2\Admin\TrafficResetController@stats` | 流量重置统计 |
|
|
| GET | `/api/v2/{admin_secure_path}/traffic-reset/user/{userId}/history` | `admin` | `V2\Admin\TrafficResetController@userHistory` | 用户流量重置历史 |
|
|
| POST | `/api/v2/{admin_secure_path}/traffic-reset/reset-user` | `admin` | `V2\Admin\TrafficResetController@resetUser` | 手动重置用户流量 |
|