# JoyHub API 接口文档

- 文档来源：https://joyhub-website-manager-api-dev.best-envision.com/v3/api-docs/all
- 标题：芋道快速开发平台
- 描述：提供管理后台、用户 App 的所有功能
- OpenAPI：3.1.0
- 生成时间：2026-04-28 14:25:19
- 接口数量：740
- 分组数量：112

## 接口总览

| 分组 | 数量 |
| --- | ---: |
| C端 - APP版本 | 1 |
| C端 - FAQ | 2 |
| C端 - FAQ联系我们 | 1 |
| C端 - blog信息 | 3 |
| C端 - blog分类 | 1 |
| C端 - news分类 | 1 |
| C端 - news管理 | 3 |
| C端 - 二维码访问统计 | 2 |
| C端 - 产品 | 2 |
| C端 - 产品分类 | 1 |
| C端 - 产品结算 | 2 |
| C端 - 协议 | 2 |
| C端 - 合作联系 | 1 |
| C端 - 售后 | 4 |
| C端 - 售后政策 | 2 |
| C端 - 售后政策-品牌 | 2 |
| C端 - 国家信息 | 1 |
| C端 - 埋点 | 1 |
| C端 - 基础数据-说明（售后/运费说明，售后问题） | 2 |
| C端 - 我的订单 | 11 |
| C端 - 支付页产品推荐 | 1 |
| C端 - 文件存储 | 3 |
| C端 - 点赞记录 | 4 |
| C端 - 用户 | 1 |
| C端 - 积分结算 | 1 |
| C端 - 购物车 | 7 |
| c端 - Banner信息 | 2 |
| default-controller | 77 |
| pay-pal-payment-controller | 9 |
| pay-pal-webhook-controller | 1 |
| 用户 App - 地区 | 1 |
| 用户 App - 字典数据 | 1 |
| 用户 App - 租户 | 1 |
| 管理后台 - API 访问日志 | 2 |
| 管理后台 - API 错误日志 | 3 |
| 管理后台 - Banner管理 | 9 |
| 管理后台 - FAQ分类 | 8 |
| 管理后台 - FAQ数据 | 10 |
| 管理后台 - FAQ联系数据 | 9 |
| 管理后台 - LX 亚马逊FBA货件详情 | 9 |
| 管理后台 - LX 亚马逊店铺信息 | 9 |
| 管理后台 - OAuth2 客户端 | 6 |
| 管理后台 - OAuth2.0 令牌 | 3 |
| 管理后台 - OAuth2.0 授权 | 5 |
| 管理后台 - OAuth2.0 用户 | 2 |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | 9 |
| 管理后台 - Redis 监控 | 1 |
| 管理后台 - app版本号管理 | 9 |
| 管理后台 - blog分类 | 9 |
| 管理后台 - blog管理 | 10 |
| 管理后台 - news分类 | 9 |
| 管理后台 - news管理 | 10 |
| 管理后台 - 二维码 | 9 |
| 管理后台 - 产品 | 11 |
| 管理后台 - 产品分类 | 7 |
| 管理后台 - 产品属性 | 7 |
| 管理后台 - 产品属性值 | 6 |
| 管理后台 - 代码生成器 | 11 |
| 管理后台 - 协议 | 9 |
| 管理后台 - 参数配置 | 8 |
| 管理后台 - 合作联系数据 | 9 |
| 管理后台 - 售后 | 3 |
| 管理后台 - 售后政策 | 9 |
| 管理后台 - 售后政策-品牌 | 10 |
| 管理后台 - 国家信息 | 11 |
| 管理后台 - 地区 | 2 |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | 9 |
| 管理后台 - 字典数据 | 9 |
| 管理后台 - 字典类型 | 9 |
| 管理后台 - 学生 | 37 |
| 管理后台 - 定时任务 | 11 |
| 管理后台 - 定时任务日志 | 3 |
| 管理后台 - 岗位 | 9 |
| 管理后台 - 我的站内信 | 7 |
| 管理后台 - 折扣 | 13 |
| 管理后台 - 折扣数据 | 2 |
| 管理后台 - 操作日志 | 2 |
| 管理后台 - 支付页产品推荐 | 6 |
| 管理后台 - 数据源配置 | 6 |
| 管理后台 - 文件存储 | 7 |
| 管理后台 - 文件配置 | 8 |
| 管理后台 - 权限 | 5 |
| 管理后台 - 流量详情 | 2 |
| 管理后台 - 用户 | 14 |
| 管理后台 - 用户个人中心 | 3 |
| 管理后台 - 登录日志 | 2 |
| 管理后台 - 短信回调 | 4 |
| 管理后台 - 短信日志 | 2 |
| 管理后台 - 短信模板 | 8 |
| 管理后台 - 短信渠道 | 8 |
| 管理后台 - 示例分类 | 6 |
| 管理后台 - 示例联系人 | 7 |
| 管理后台 - 社交客户端 | 7 |
| 管理后台 - 社交用户 | 5 |
| 管理后台 - 租户 | 10 |
| 管理后台 - 租户套餐 | 8 |
| 管理后台 - 站内信模版 | 7 |
| 管理后台 - 联系我们数据 | 9 |
| 管理后台 - 菜单 | 8 |
| 管理后台 - 角色 | 9 |
| 管理后台 - 订单 | 6 |
| 管理后台 - 认证 | 11 |
| 管理后台 - 路由 | 9 |
| 管理后台 - 运费模板信息 | 8 |
| 管理后台 - 通知公告 | 7 |
| 管理后台 - 邮件日志 | 2 |
| 管理后台 - 邮件模版 | 9 |
| 管理后台 - 邮箱账号 | 8 |
| 管理后台 - 部门 | 8 |
| 管理后台 - 链接 | 7 |
| 管理后台 - 领星订单同步调试 | 3 |
| 管理后台 - 验证码 | 2 |

## 接口清单

| 分组 | 方法 | 路径 | 名称 | operationId |
| --- | --- | --- | --- | --- |
| C端 - APP版本 | GET | `/web-api/jh/web/appversion/page` | 获取APP版本列表 | `WebAppversion_getAppversionPage` |
| C端 - FAQ | GET | `/web-api/jh/faq/cate-list` | 获得FAQ分类树 | `WebFaq_getFaqCateTree` |
| C端 - FAQ | GET | `/web-api/jh/faq/list` | 获得FAQ列表 | `WebFaq_getFaqList` |
| C端 - FAQ联系我们 | POST | `/web-api/jh/faq-contact-us/create` | 提交FAQ联系信息 | `WebFaqContactUs_createFaqContactUs` |
| C端 - blog信息 | GET | `/web-api/jh/blog/get-detail` | 获得blog详情 | `WebBlog_getBlog` |
| C端 - blog信息 | GET | `/web-api/jh/blog/get-next` | 获得blog下一条 | `WebBlog_getBlogNext` |
| C端 - blog信息 | GET | `/web-api/jh/blog/page` | 获得blog管理分页 | `WebBlog_getBlogPage` |
| C端 - blog分类 | GET | `/web-api/jh/blog-cate/list` | 获得blog分类列表 | `WebBlogCate_getBlogCateList` |
| C端 - news分类 | GET | `/web-api/jh/news-cate/list` | 获得news分类列表 | `WebNewsCate_getNewsCateList` |
| C端 - news管理 | GET | `/web-api/jh/news/get-detail` | 获得news详情 | `WebNews_getBlog` |
| C端 - news管理 | GET | `/web-api/jh/news/get-next` | 获得news下一条 | `WebNews_getBlogNext` |
| C端 - news管理 | GET | `/web-api/jh/news/page` | 获得news管理分页 | `WebNews_getBlogPage` |
| C端 - 二维码访问统计 | GET | `/web-api/jh/download-qrcode/get` | 获取二维码信息 | `WebDownloadQrcode_getByCode` |
| C端 - 二维码访问统计 | POST | `/web-api/jh/download-qrcode/increment` | 增加二维码访问/点击次数 | `WebDownloadQrcode_incrementCount` |
| C端 - 产品 | GET | `/web-api/jh/product/get` | 产品详情 | `WebProduct_getProduct` |
| C端 - 产品 | GET | `/web-api/jh/product/page` | 获得产品分页 | `WebProduct_getProductPage` |
| C端 - 产品分类 | GET | `/web-api/jh/product-cate/list` | 获得产品分类列表 | `WebProductCate_getProductCateList` |
| C端 - 产品结算 | GET | `/web-api/jh/settlement/points/settlement` | 获取积分结算信息 | `WebSettlement_getProductPointsSettlement` |
| C端 - 产品结算 | POST | `/web-api/jh/settlement/points/submit` | 纯积分结算提交订单 | `WebSettlement_submitProductPointsSettlement` |
| C端 - 协议 | GET | `/web-api/jh/agreement/get` | 获得协议 | `WebAgreement_getAgreement` |
| C端 - 协议 | GET | `/web-api/jh/agreement/page` | 获得协议分页 | `WebAgreement_getAgreementPage` |
| C端 - 合作联系 | POST | `/web-api/jh/cooperation/create` | 提交合作联系信息 | `WebCooperation_createCooperation` |
| C端 - 售后 | POST | `/web-api/jh/order-after-sale/create` | 提交售后 | `WebOrderAfterSale_createOrderAfterSale` |
| C端 - 售后 | GET | `/web-api/jh/order-after-sale/get` | 售后详情 | `WebOrderAfterSale_getOrderAfterSale` |
| C端 - 售后 | POST | `/web-api/jh/order-after-sale/sync-oa` | 同步oa售后数据 | `WebOrderAfterSale_syncOrderAfterSaleFromOA` |
| C端 - 售后 | POST | `/web-api/jh/order-after-sale/update` | 提供给OA接收售后信息变化 | `WebOrderAfterSale_updateOrderAfterSale` |
| C端 - 售后政策 | GET | `/web-api/jh/after-sales-policy/get` | 获得售后政策 | `WebAfterSalesPolicy_getAfterSalesPolicy` |
| C端 - 售后政策 | GET | `/web-api/jh/after-sales-policy/page` | 获得售后政策分页 | `WebAfterSalesPolicy_getAfterSalesPolicyPage` |
| C端 - 售后政策-品牌 | GET | `/web-api/jh/after-sales-brand/get` | 获得售后政策-品牌 | `WebAfterSalesBrand_getAfterSalesBrand` |
| C端 - 售后政策-品牌 | GET | `/web-api/jh/after-sales-brand/page` | 获得售后政策-品牌分页 | `WebAfterSalesBrand_getAfterSalesBrandPage` |
| C端 - 国家信息 | GET | `/web-api/jh/address-country/list` | 获取国家列表（启用状态） | `WebAddressCountry_getCountryList` |
| C端 - 埋点 | POST | `/web-api/jh/event-tracking/create` | 创建埋点记录 | `WebEventTracking_createEventTracking` |
| C端 - 基础数据-说明（售后/运费说明，售后问题） | GET | `/web-api/jh/article/get` | 获得基础数据-说明 | `WebArticle_getArticle` |
| C端 - 基础数据-说明（售后/运费说明，售后问题） | GET | `/web-api/jh/article/page` | 获得基础数据-说明分页 | `WebArticle_getArticlePage` |
| C端 - 我的订单 | PUT | `/web-api/jh/order/cancel` | 取消订单 | `ClientOrder_cancelOrder` |
| C端 - 我的订单 | GET | `/web-api/jh/order/capture` | 捕获订单 | `ClientOrder_captureOrder` |
| C端 - 我的订单 | POST | `/web-api/jh/order/change-shipping-amount` | 重新计算运费和总价 | `ClientOrder_changeShippingAmount` |
| C端 - 我的订单 | GET | `/web-api/jh/order/count` | 查询各状态订单数量 | `ClientOrder_getOrderCount` |
| C端 - 我的订单 | POST | `/web-api/jh/order/creat` | 创建订单 | `ClientOrder_creatOrder` |
| C端 - 我的订单 | GET | `/web-api/jh/order/export-excel` | 导出订单 Excel | `ClientOrder_exportOrderExcel` |
| C端 - 我的订单 | GET | `/web-api/jh/order/get` | 获得订单 | `ClientOrder_getOrder` |
| C端 - 我的订单 | GET | `/web-api/jh/order/order-item` | 支付成功页订单详情产品信息 | `ClientOrder_getOrderItemList` |
| C端 - 我的订单 | GET | `/web-api/jh/order/page` | 获得订单分页 | `ClientOrder_getOrderPage` |
| C端 - 我的订单 | PUT | `/web-api/jh/order/set-remark` | 设置订单备注 | `ClientOrder_updateOrderRemark` |
| C端 - 我的订单 | GET | `/web-api/jh/order/status` | 查询状态列表 | `ClientOrder_getStatus` |
| C端 - 支付页产品推荐 | GET | `/web-api/jh/product-payment-recommend/page` | 获得支付页产品推荐分页 | `WebProductPaymentRecommend_getProductPaymentRecommendPage` |
| C端 - 文件存储 | POST | `/web-api/infra/file/create` | 创建文件 | `AppFile_createFile` |
| C端 - 文件存储 | GET | `/web-api/infra/file/presigned-url` | 获取文件预签名地址（上传） | `AppFile_getFilePresignedUrl` |
| C端 - 文件存储 | POST | `/web-api/infra/file/upload` | 上传文件 | `AppFile_uploadFile` |
| C端 - 点赞记录 | POST | `/web-api/jh/like-info/create` | 创建点赞记录 | `LikeInfo_createLikeInfo` |
| C端 - 点赞记录 | POST | `/web-api/jh/like-info/delete` | 取消点赞 | `LikeInfo_deleteLikeInfo` |
| C端 - 点赞记录 | GET | `/web-api/jh/like-info/get` | 获得点赞记录 | `LikeInfo_getLikeInfo` |
| C端 - 点赞记录 | GET | `/web-api/jh/like-info/page` | 获得点赞记录分页 | `LikeInfo_getLikeInfoPage` |
| C端 - 用户 | GET | `/web-api/jh/client/get/point` | 查询当前用户积分 | `WebClient_getPoint` |
| C端 - 积分结算 | POST | `/web-api/jh/settle_points/estimated-calculation` | 积分商品检测计算积分价格 | `WebSettlePoints_estimatedCalculation` |
| C端 - 购物车 | POST | `/web-api/jh/shopping-cart/calculate` | 购物车计算 | `WebShoppingCart_calculate` |
| C端 - 购物车 | POST | `/web-api/jh/shopping-cart/calculate-shippingcost` | 单独计算运费 | `WebShoppingCart_calculateShippingcost` |
| C端 - 购物车 | POST | `/web-api/jh/shopping-cart/check` | 检测购物车产品列表数据 | `WebShoppingCart_checkShoppingCart` |
| C端 - 购物车 | POST | `/web-api/jh/shopping-cart/create` | 创建购物车 | `WebShoppingCart_createShoppingCart` |
| C端 - 购物车 | DELETE | `/web-api/jh/shopping-cart/delete-list` | 刪除 | `WebShoppingCart_deleteBlog` |
| C端 - 购物车 | GET | `/web-api/jh/shopping-cart/list` | 获得购物车列表 | `WebShoppingCart_getShoppingCart` |
| C端 - 购物车 | POST | `/web-api/jh/shopping-cart/update` | 更新购物车产品数量 | `WebShoppingCart_updateShoppingCart` |
| c端 - Banner信息 | GET | `/web-api/jh/banner/get` | 获得Banner管理 | `WebBanner_getBanner` |
| c端 - Banner信息 | GET | `/web-api/jh/banner/page` | 获得Banner管理分页 | `WebBanner_getBannerPage` |
| default-controller | DELETE | `/admin-api/ai/**` |  | `Default_ai404_3` |
| default-controller | GET | `/admin-api/ai/**` |  | `Default_ai404` |
| default-controller | HEAD | `/admin-api/ai/**` |  | `Default_ai404_5` |
| default-controller | OPTIONS | `/admin-api/ai/**` |  | `Default_ai404_6` |
| default-controller | PATCH | `/admin-api/ai/**` |  | `Default_ai404_4` |
| default-controller | POST | `/admin-api/ai/**` |  | `Default_ai404_1` |
| default-controller | PUT | `/admin-api/ai/**` |  | `Default_ai404_2` |
| default-controller | DELETE | `/admin-api/bpm/**` |  | `Default_bpm404_3` |
| default-controller | GET | `/admin-api/bpm/**` |  | `Default_bpm404` |
| default-controller | HEAD | `/admin-api/bpm/**` |  | `Default_bpm404_5` |
| default-controller | OPTIONS | `/admin-api/bpm/**` |  | `Default_bpm404_6` |
| default-controller | PATCH | `/admin-api/bpm/**` |  | `Default_bpm404_4` |
| default-controller | POST | `/admin-api/bpm/**` |  | `Default_bpm404_1` |
| default-controller | PUT | `/admin-api/bpm/**` |  | `Default_bpm404_2` |
| default-controller | DELETE | `/admin-api/crm/**` |  | `Default_crm404_3` |
| default-controller | GET | `/admin-api/crm/**` |  | `Default_crm404` |
| default-controller | HEAD | `/admin-api/crm/**` |  | `Default_crm404_5` |
| default-controller | OPTIONS | `/admin-api/crm/**` |  | `Default_crm404_6` |
| default-controller | PATCH | `/admin-api/crm/**` |  | `Default_crm404_4` |
| default-controller | POST | `/admin-api/crm/**` |  | `Default_crm404_1` |
| default-controller | PUT | `/admin-api/crm/**` |  | `Default_crm404_2` |
| default-controller | DELETE | `/admin-api/erp/**` |  | `Default_erp404_3` |
| default-controller | GET | `/admin-api/erp/**` |  | `Default_erp404` |
| default-controller | HEAD | `/admin-api/erp/**` |  | `Default_erp404_5` |
| default-controller | OPTIONS | `/admin-api/erp/**` |  | `Default_erp404_6` |
| default-controller | PATCH | `/admin-api/erp/**` |  | `Default_erp404_4` |
| default-controller | POST | `/admin-api/erp/**` |  | `Default_erp404_1` |
| default-controller | PUT | `/admin-api/erp/**` |  | `Default_erp404_2` |
| default-controller | DELETE | `/admin-api/iot/**` |  | `Default_iot404_3` |
| default-controller | GET | `/admin-api/iot/**` |  | `Default_iot404` |
| default-controller | HEAD | `/admin-api/iot/**` |  | `Default_iot404_5` |
| default-controller | OPTIONS | `/admin-api/iot/**` |  | `Default_iot404_6` |
| default-controller | PATCH | `/admin-api/iot/**` |  | `Default_iot404_4` |
| default-controller | POST | `/admin-api/iot/**` |  | `Default_iot404_1` |
| default-controller | PUT | `/admin-api/iot/**` |  | `Default_iot404_2` |
| default-controller | DELETE | `/admin-api/mp/**` |  | `Default_mp404_3` |
| default-controller | GET | `/admin-api/mp/**` |  | `Default_mp404` |
| default-controller | HEAD | `/admin-api/mp/**` |  | `Default_mp404_5` |
| default-controller | OPTIONS | `/admin-api/mp/**` |  | `Default_mp404_6` |
| default-controller | PATCH | `/admin-api/mp/**` |  | `Default_mp404_4` |
| default-controller | POST | `/admin-api/mp/**` |  | `Default_mp404_1` |
| default-controller | PUT | `/admin-api/mp/**` |  | `Default_mp404_2` |
| default-controller | DELETE | `/admin-api/pay/**` |  | `Default_pay404_3` |
| default-controller | GET | `/admin-api/pay/**` |  | `Default_pay404` |
| default-controller | HEAD | `/admin-api/pay/**` |  | `Default_pay404_5` |
| default-controller | OPTIONS | `/admin-api/pay/**` |  | `Default_pay404_6` |
| default-controller | PATCH | `/admin-api/pay/**` |  | `Default_pay404_4` |
| default-controller | POST | `/admin-api/pay/**` |  | `Default_pay404_1` |
| default-controller | PUT | `/admin-api/pay/**` |  | `Default_pay404_2` |
| default-controller | DELETE | `/admin-api/product/**` |  | `Default_mall404_17` |
| default-controller | GET | `/admin-api/product/**` |  | `Default_mall404_14` |
| default-controller | HEAD | `/admin-api/product/**` |  | `Default_mall404_19` |
| default-controller | OPTIONS | `/admin-api/product/**` |  | `Default_mall404_20` |
| default-controller | PATCH | `/admin-api/product/**` |  | `Default_mall404_18` |
| default-controller | POST | `/admin-api/product/**` |  | `Default_mall404_15` |
| default-controller | PUT | `/admin-api/product/**` |  | `Default_mall404_16` |
| default-controller | DELETE | `/admin-api/promotion/**` |  | `Default_mall404_10` |
| default-controller | GET | `/admin-api/promotion/**` |  | `Default_mall404_7` |
| default-controller | HEAD | `/admin-api/promotion/**` |  | `Default_mall404_12` |
| default-controller | OPTIONS | `/admin-api/promotion/**` |  | `Default_mall404_13` |
| default-controller | PATCH | `/admin-api/promotion/**` |  | `Default_mall404_11` |
| default-controller | POST | `/admin-api/promotion/**` |  | `Default_mall404_8` |
| default-controller | PUT | `/admin-api/promotion/**` |  | `Default_mall404_9` |
| default-controller | DELETE | `/admin-api/report/**` |  | `Default_report404_3` |
| default-controller | GET | `/admin-api/report/**` |  | `Default_report404` |
| default-controller | HEAD | `/admin-api/report/**` |  | `Default_report404_5` |
| default-controller | OPTIONS | `/admin-api/report/**` |  | `Default_report404_6` |
| default-controller | PATCH | `/admin-api/report/**` |  | `Default_report404_4` |
| default-controller | POST | `/admin-api/report/**` |  | `Default_report404_1` |
| default-controller | PUT | `/admin-api/report/**` |  | `Default_report404_2` |
| default-controller | DELETE | `/admin-api/trade/**` |  | `Default_mall404_3` |
| default-controller | GET | `/admin-api/trade/**` |  | `Default_mall404` |
| default-controller | HEAD | `/admin-api/trade/**` |  | `Default_mall404_5` |
| default-controller | OPTIONS | `/admin-api/trade/**` |  | `Default_mall404_6` |
| default-controller | PATCH | `/admin-api/trade/**` |  | `Default_mall404_4` |
| default-controller | POST | `/admin-api/trade/**` |  | `Default_mall404_1` |
| default-controller | PUT | `/admin-api/trade/**` |  | `Default_mall404_2` |
| pay-pal-payment-controller | GET | `/admin-api/paypal/cancel` |  | `PayPalPayment_cancel` |
| pay-pal-payment-controller | GET | `/admin-api/paypal/capture-order` |  | `PayPalPayment_captureOrder` |
| pay-pal-payment-controller | POST | `/admin-api/paypal/create-order` |  | `PayPalPayment_createOrder` |
| pay-pal-payment-controller | GET | `/admin-api/paypal/get-order` |  | `PayPalPayment_getOrder` |
| pay-pal-payment-controller | GET | `/admin-api/paypal/get-refund` |  | `PayPalPayment_getRefund` |
| pay-pal-payment-controller | POST | `/admin-api/paypal/refund-captured-payment` |  | `PayPalPayment_refundCapturedPayment` |
| pay-pal-payment-controller | POST | `/admin-api/paypal/search-transaction` |  | `PayPalPayment_searchTransaction` |
| pay-pal-payment-controller | GET | `/admin-api/paypal/success` |  | `PayPalPayment_success` |
| pay-pal-payment-controller | POST | `/admin-api/paypal/track-order` |  | `PayPalPayment_trackOrder` |
| pay-pal-webhook-controller | POST | `/admin-api/paypal/webhook/payment` |  | `PayPalWebhook_receivePayPalWebhook` |
| 用户 App - 地区 | GET | `/app-api/system/area/tree` | 获得地区树 | `AppArea_getAreaTree` |
| 用户 App - 字典数据 | GET | `/app-api/system/dict-data/type` | 根据字典类型查询字典数据信息 | `AppDictData_getDictDataListByType` |
| 用户 App - 租户 | GET | `/app-api/system/tenant/get-by-website` | 使用域名，获得租户信息 | `AppTenant_getTenantByWebsite` |
| 管理后台 - API 访问日志 | GET | `/admin-api/infra/api-access-log/export-excel` | 导出API 访问日志 Excel | `ApiAccessLog_exportApiAccessLogExcel` |
| 管理后台 - API 访问日志 | GET | `/admin-api/infra/api-access-log/page` | 获得API 访问日志分页 | `ApiAccessLog_getApiAccessLogPage` |
| 管理后台 - API 错误日志 | GET | `/admin-api/infra/api-error-log/export-excel` | 导出 API 错误日志 Excel | `ApiErrorLog_exportApiErrorLogExcel` |
| 管理后台 - API 错误日志 | GET | `/admin-api/infra/api-error-log/page` | 获得 API 错误日志分页 | `ApiErrorLog_getApiErrorLogPage` |
| 管理后台 - API 错误日志 | PUT | `/admin-api/infra/api-error-log/update-status` | 更新 API 错误日志的状态 | `ApiErrorLog_updateApiErrorLogProcess` |
| 管理后台 - Banner管理 | POST | `/admin-api/jh/banner/create` | 创建Banner管理 | `Banner_createBanner` |
| 管理后台 - Banner管理 | DELETE | `/admin-api/jh/banner/delete` | 删除Banner管理 | `Banner_deleteBanner` |
| 管理后台 - Banner管理 | DELETE | `/admin-api/jh/banner/delete-list` | 批量删除Banner管理 | `Banner_deleteBannerList` |
| 管理后台 - Banner管理 | GET | `/admin-api/jh/banner/export-excel` | 导出Banner管理 Excel | `Banner_exportBannerExcel` |
| 管理后台 - Banner管理 | GET | `/admin-api/jh/banner/get` | 获得Banner管理 | `Banner_getBanner` |
| 管理后台 - Banner管理 | GET | `/admin-api/jh/banner/get-import-template` | 获得导入Banner管理模板 | `Banner_getImportTemplate` |
| 管理后台 - Banner管理 | POST | `/admin-api/jh/banner/import-excel` | 导入Banner管理Excel | `Banner_importBannerExcel` |
| 管理后台 - Banner管理 | GET | `/admin-api/jh/banner/page` | 获得Banner管理分页 | `Banner_getBannerPage` |
| 管理后台 - Banner管理 | PUT | `/admin-api/jh/banner/update` | 更新Banner管理 | `Banner_updateBanner` |
| 管理后台 - FAQ分类 | POST | `/admin-api/jh/faq-cate/create` | 创建FAQ分类 | `FaqCate_createFaqCate` |
| 管理后台 - FAQ分类 | DELETE | `/admin-api/jh/faq-cate/delete` | 删除FAQ分类 | `FaqCate_deleteFaqCate` |
| 管理后台 - FAQ分类 | GET | `/admin-api/jh/faq-cate/export-excel` | 导出FAQ分类 Excel | `FaqCate_exportFaqCateExcel` |
| 管理后台 - FAQ分类 | GET | `/admin-api/jh/faq-cate/get` | 获得FAQ分类 | `FaqCate_getFaqCate` |
| 管理后台 - FAQ分类 | GET | `/admin-api/jh/faq-cate/get-import-template` | 获得导入FAQ分类模板 | `FaqCate_getImportTemplate` |
| 管理后台 - FAQ分类 | POST | `/admin-api/jh/faq-cate/import-excel` | 导入FAQ分类Excel | `FaqCate_importFaqCateExcel` |
| 管理后台 - FAQ分类 | GET | `/admin-api/jh/faq-cate/list` | 获得FAQ分类列表 | `FaqCate_getFaqCateList` |
| 管理后台 - FAQ分类 | PUT | `/admin-api/jh/faq-cate/update` | 更新FAQ分类 | `FaqCate_updateFaqCate` |
| 管理后台 - FAQ数据 | GET | `/admin-api/jh/faq/cate-list` | 获得FAQ分类下拉列表 | `Faq_getFaqCateList` |
| 管理后台 - FAQ数据 | POST | `/admin-api/jh/faq/create` | 创建FAQ数据 | `Faq_createFaq` |
| 管理后台 - FAQ数据 | DELETE | `/admin-api/jh/faq/delete` | 删除FAQ数据 | `Faq_deleteFaq` |
| 管理后台 - FAQ数据 | DELETE | `/admin-api/jh/faq/delete-list` | 批量删除FAQ数据 | `Faq_deleteFaqList` |
| 管理后台 - FAQ数据 | GET | `/admin-api/jh/faq/export-excel` | 导出FAQ数据 Excel | `Faq_exportFaqExcel` |
| 管理后台 - FAQ数据 | GET | `/admin-api/jh/faq/get` | 获得FAQ数据 | `Faq_getFaq` |
| 管理后台 - FAQ数据 | GET | `/admin-api/jh/faq/get-import-template` | 获得导入FAQ数据模板 | `Faq_getImportTemplate` |
| 管理后台 - FAQ数据 | POST | `/admin-api/jh/faq/import-excel` | 导入FAQ数据Excel | `Faq_importFaqExcel` |
| 管理后台 - FAQ数据 | GET | `/admin-api/jh/faq/page` | 获得FAQ数据分页 | `Faq_getFaqPage` |
| 管理后台 - FAQ数据 | PUT | `/admin-api/jh/faq/update` | 更新FAQ数据 | `Faq_updateFaq` |
| 管理后台 - FAQ联系数据 | POST | `/admin-api/jh/faq-contact-us/create` | 创建FAQ联系数据 | `FaqContactUs_createFaqContactUs` |
| 管理后台 - FAQ联系数据 | DELETE | `/admin-api/jh/faq-contact-us/delete` | 删除FAQ联系数据 | `FaqContactUs_deleteFaqContactUs` |
| 管理后台 - FAQ联系数据 | DELETE | `/admin-api/jh/faq-contact-us/delete-list` | 批量删除FAQ联系数据 | `FaqContactUs_deleteFaqContactUsList` |
| 管理后台 - FAQ联系数据 | GET | `/admin-api/jh/faq-contact-us/export-excel` | 导出FAQ联系数据 Excel | `FaqContactUs_exportFaqContactUsExcel` |
| 管理后台 - FAQ联系数据 | GET | `/admin-api/jh/faq-contact-us/get` | 获得FAQ联系数据 | `FaqContactUs_getFaqContactUs` |
| 管理后台 - FAQ联系数据 | GET | `/admin-api/jh/faq-contact-us/get-import-template` | 获得导入FAQ联系数据模板 | `FaqContactUs_getImportTemplate` |
| 管理后台 - FAQ联系数据 | POST | `/admin-api/jh/faq-contact-us/import-excel` | 导入FAQ联系数据Excel | `FaqContactUs_importFaqContactUsExcel` |
| 管理后台 - FAQ联系数据 | GET | `/admin-api/jh/faq-contact-us/page` | 获得FAQ联系数据分页 | `FaqContactUs_getFaqContactUsPage` |
| 管理后台 - FAQ联系数据 | PUT | `/admin-api/jh/faq-contact-us/update` | 更新FAQ联系数据 | `FaqContactUs_updateFaqContactUs` |
| 管理后台 - LX 亚马逊FBA货件详情 | POST | `/admin-api/lx/fba-inbound-shipment-detail/create` | 创建LX 亚马逊FBA货件详情 | `LxFbaInboundShipmentDetail_createFbaInboundShipmentDetail` |
| 管理后台 - LX 亚马逊FBA货件详情 | DELETE | `/admin-api/lx/fba-inbound-shipment-detail/delete` | 删除LX 亚马逊FBA货件详情 | `LxFbaInboundShipmentDetail_deleteFbaInboundShipmentDetail` |
| 管理后台 - LX 亚马逊FBA货件详情 | DELETE | `/admin-api/lx/fba-inbound-shipment-detail/delete-list` | 批量删除LX 亚马逊FBA货件详情 | `LxFbaInboundShipmentDetail_deleteFbaInboundShipmentDetailList` |
| 管理后台 - LX 亚马逊FBA货件详情 | GET | `/admin-api/lx/fba-inbound-shipment-detail/export-excel` | 导出LX 亚马逊FBA货件详情 Excel | `LxFbaInboundShipmentDetail_exportFbaInboundShipmentDetailExcel` |
| 管理后台 - LX 亚马逊FBA货件详情 | GET | `/admin-api/lx/fba-inbound-shipment-detail/get` | 获得LX 亚马逊FBA货件详情 | `LxFbaInboundShipmentDetail_getFbaInboundShipmentDetail` |
| 管理后台 - LX 亚马逊FBA货件详情 | GET | `/admin-api/lx/fba-inbound-shipment-detail/get-import-template` | 获得导入LX 亚马逊FBA货件详情模板 | `LxFbaInboundShipmentDetail_getImportTemplate` |
| 管理后台 - LX 亚马逊FBA货件详情 | POST | `/admin-api/lx/fba-inbound-shipment-detail/import-excel` | 导入LX 亚马逊FBA货件详情Excel | `LxFbaInboundShipmentDetail_importFbaInboundShipmentDetailExcel` |
| 管理后台 - LX 亚马逊FBA货件详情 | GET | `/admin-api/lx/fba-inbound-shipment-detail/page` | 获得LX 亚马逊FBA货件详情分页 | `LxFbaInboundShipmentDetail_getFbaInboundShipmentDetailPage` |
| 管理后台 - LX 亚马逊FBA货件详情 | PUT | `/admin-api/lx/fba-inbound-shipment-detail/update` | 更新LX 亚马逊FBA货件详情 | `LxFbaInboundShipmentDetail_updateFbaInboundShipmentDetail` |
| 管理后台 - LX 亚马逊店铺信息 | POST | `/admin-api/lx/amazon-shop/create` | 创建LX 亚马逊店铺信息 | `LxAmazonShop_createAmazonShop` |
| 管理后台 - LX 亚马逊店铺信息 | DELETE | `/admin-api/lx/amazon-shop/delete` | 删除LX 亚马逊店铺信息 | `LxAmazonShop_deleteAmazonShop` |
| 管理后台 - LX 亚马逊店铺信息 | DELETE | `/admin-api/lx/amazon-shop/delete-list` | 批量删除LX 亚马逊店铺信息 | `LxAmazonShop_deleteAmazonShopList` |
| 管理后台 - LX 亚马逊店铺信息 | GET | `/admin-api/lx/amazon-shop/export-excel` | 导出LX 亚马逊店铺信息 Excel | `LxAmazonShop_exportAmazonShopExcel` |
| 管理后台 - LX 亚马逊店铺信息 | GET | `/admin-api/lx/amazon-shop/get` | 获得LX 亚马逊店铺信息 | `LxAmazonShop_getAmazonShop` |
| 管理后台 - LX 亚马逊店铺信息 | GET | `/admin-api/lx/amazon-shop/get-import-template` | 获得导入LX 亚马逊店铺信息模板 | `LxAmazonShop_getImportTemplate` |
| 管理后台 - LX 亚马逊店铺信息 | POST | `/admin-api/lx/amazon-shop/import-excel` | 导入LX 亚马逊店铺信息Excel | `LxAmazonShop_importAmazonShopExcel` |
| 管理后台 - LX 亚马逊店铺信息 | GET | `/admin-api/lx/amazon-shop/page` | 获得LX 亚马逊店铺信息分页 | `LxAmazonShop_getAmazonShopPage` |
| 管理后台 - LX 亚马逊店铺信息 | PUT | `/admin-api/lx/amazon-shop/update` | 更新LX 亚马逊店铺信息 | `LxAmazonShop_updateAmazonShop` |
| 管理后台 - OAuth2 客户端 | POST | `/admin-api/system/oauth2-client/create` | 创建 OAuth2 客户端 | `OAuth2Client_createOAuth2Client` |
| 管理后台 - OAuth2 客户端 | DELETE | `/admin-api/system/oauth2-client/delete` | 删除 OAuth2 客户端 | `OAuth2Client_deleteOAuth2Client` |
| 管理后台 - OAuth2 客户端 | DELETE | `/admin-api/system/oauth2-client/delete-list` | 批量删除 OAuth2 客户端 | `OAuth2Client_deleteOAuth2ClientList` |
| 管理后台 - OAuth2 客户端 | GET | `/admin-api/system/oauth2-client/get` | 获得 OAuth2 客户端 | `OAuth2Client_getOAuth2Client` |
| 管理后台 - OAuth2 客户端 | GET | `/admin-api/system/oauth2-client/page` | 获得 OAuth2 客户端分页 | `OAuth2Client_getOAuth2ClientPage` |
| 管理后台 - OAuth2 客户端 | PUT | `/admin-api/system/oauth2-client/update` | 更新 OAuth2 客户端 | `OAuth2Client_updateOAuth2Client` |
| 管理后台 - OAuth2.0 令牌 | DELETE | `/admin-api/system/oauth2-token/delete` | 删除访问令牌 | `OAuth2Token_deleteAccessToken` |
| 管理后台 - OAuth2.0 令牌 | DELETE | `/admin-api/system/oauth2-token/delete-list` | 批量删除访问令牌 | `OAuth2Token_deleteAccessTokenList` |
| 管理后台 - OAuth2.0 令牌 | GET | `/admin-api/system/oauth2-token/page` | 获得访问令牌分页 | `OAuth2Token_getAccessTokenPage` |
| 管理后台 - OAuth2.0 授权 | GET | `/admin-api/system/oauth2/authorize` | 获得授权信息 | `OAuth2Open_authorize` |
| 管理后台 - OAuth2.0 授权 | POST | `/admin-api/system/oauth2/authorize` | 申请授权 | `OAuth2Open_approveOrDeny` |
| 管理后台 - OAuth2.0 授权 | POST | `/admin-api/system/oauth2/check-token` | 校验访问令牌 | `OAuth2Open_checkToken` |
| 管理后台 - OAuth2.0 授权 | DELETE | `/admin-api/system/oauth2/token` | 删除访问令牌 | `OAuth2Open_revokeToken` |
| 管理后台 - OAuth2.0 授权 | POST | `/admin-api/system/oauth2/token` | 获得访问令牌 | `OAuth2Open_postAccessToken` |
| 管理后台 - OAuth2.0 用户 | GET | `/admin-api/system/oauth2/user/get` | 获得用户基本信息 | `OAuth2User_getUserInfo` |
| 管理后台 - OAuth2.0 用户 | PUT | `/admin-api/system/oauth2/user/update` | 更新用户基本信息 | `OAuth2User_updateUserInfo` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | POST | `/admin-api/paypal/webhook-idempotent/create` | 创建PayPal Webhook 幂等表（防重复处理） | `WebhookIdempotent_createWebhookIdempotent` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | DELETE | `/admin-api/paypal/webhook-idempotent/delete` | 删除PayPal Webhook 幂等表（防重复处理） | `WebhookIdempotent_deleteWebhookIdempotent` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | DELETE | `/admin-api/paypal/webhook-idempotent/delete-list` | 批量删除PayPal Webhook 幂等表（防重复处理） | `WebhookIdempotent_deleteWebhookIdempotentList` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | GET | `/admin-api/paypal/webhook-idempotent/export-excel` | 导出PayPal Webhook 幂等表（防重复处理） Excel | `WebhookIdempotent_exportWebhookIdempotentExcel` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | GET | `/admin-api/paypal/webhook-idempotent/get` | 获得PayPal Webhook 幂等表（防重复处理） | `WebhookIdempotent_getWebhookIdempotent` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | GET | `/admin-api/paypal/webhook-idempotent/get-import-template` | 获得导入PayPal Webhook 幂等表（防重复处理）模板 | `WebhookIdempotent_getImportTemplate` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | POST | `/admin-api/paypal/webhook-idempotent/import-excel` | 导入PayPal Webhook 幂等表（防重复处理）Excel | `WebhookIdempotent_importWebhookIdempotentExcel` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | GET | `/admin-api/paypal/webhook-idempotent/page` | 获得PayPal Webhook 幂等表（防重复处理）分页 | `WebhookIdempotent_getWebhookIdempotentPage` |
| 管理后台 - PayPal Webhook 幂等表（防重复处理） | PUT | `/admin-api/paypal/webhook-idempotent/update` | 更新PayPal Webhook 幂等表（防重复处理） | `WebhookIdempotent_updateWebhookIdempotent` |
| 管理后台 - Redis 监控 | GET | `/admin-api/infra/redis/get-monitor-info` | 获得 Redis 监控信息 | `Redis_getRedisMonitorInfo` |
| 管理后台 - app版本号管理 | POST | `/admin-api/jh/appversion/create` | 创建app版本号管理 | `Appversion_createAppversion` |
| 管理后台 - app版本号管理 | DELETE | `/admin-api/jh/appversion/delete` | 删除app版本号管理 | `Appversion_deleteAppversion` |
| 管理后台 - app版本号管理 | DELETE | `/admin-api/jh/appversion/delete-list` | 批量删除app版本号管理 | `Appversion_deleteAppversionList` |
| 管理后台 - app版本号管理 | GET | `/admin-api/jh/appversion/export-excel` | 导出app版本号管理 Excel | `Appversion_exportAppversionExcel` |
| 管理后台 - app版本号管理 | GET | `/admin-api/jh/appversion/get` | 获得app版本号管理 | `Appversion_getAppversion` |
| 管理后台 - app版本号管理 | GET | `/admin-api/jh/appversion/get-import-template` | 获得导入app版本号管理模板 | `Appversion_getImportTemplate` |
| 管理后台 - app版本号管理 | POST | `/admin-api/jh/appversion/import-excel` | 导入app版本号管理Excel | `Appversion_importAppversionExcel` |
| 管理后台 - app版本号管理 | GET | `/admin-api/jh/appversion/page` | 获得app版本号管理分页 | `Appversion_getAppversionPage` |
| 管理后台 - app版本号管理 | PUT | `/admin-api/jh/appversion/update` | 更新app版本号管理 | `Appversion_updateAppversion` |
| 管理后台 - blog分类 | POST | `/admin-api/jh/blog-cate/create` | 创建blog分类 | `BlogCate_createBlogCate` |
| 管理后台 - blog分类 | DELETE | `/admin-api/jh/blog-cate/delete` | 删除blog分类 | `BlogCate_deleteBlogCate` |
| 管理后台 - blog分类 | DELETE | `/admin-api/jh/blog-cate/delete-list` | 批量删除blog分类 | `BlogCate_deleteBlogCateList` |
| 管理后台 - blog分类 | GET | `/admin-api/jh/blog-cate/export-excel` | 导出blog分类 Excel | `BlogCate_exportBlogCateExcel` |
| 管理后台 - blog分类 | GET | `/admin-api/jh/blog-cate/get` | 获得blog分类 | `BlogCate_getBlogCate` |
| 管理后台 - blog分类 | GET | `/admin-api/jh/blog-cate/get-import-template` | 获得导入blog分类模板 | `BlogCate_getImportTemplate` |
| 管理后台 - blog分类 | POST | `/admin-api/jh/blog-cate/import-excel` | 导入blog分类Excel | `BlogCate_importBlogCateExcel` |
| 管理后台 - blog分类 | GET | `/admin-api/jh/blog-cate/page` | 获得blog分类分页 | `BlogCate_getBlogCatePage` |
| 管理后台 - blog分类 | PUT | `/admin-api/jh/blog-cate/update` | 更新blog分类 | `BlogCate_updateBlogCate` |
| 管理后台 - blog管理 | GET | `/admin-api/jh/blog/blog-cate-relation/list-by-blog-id` | 获得blog分类列表 | `Blog_getBlogCateRelationListByBlogId` |
| 管理后台 - blog管理 | POST | `/admin-api/jh/blog/create` | 创建blog管理 | `Blog_createBlog` |
| 管理后台 - blog管理 | DELETE | `/admin-api/jh/blog/delete` | 删除blog管理 | `Blog_deleteBlog` |
| 管理后台 - blog管理 | DELETE | `/admin-api/jh/blog/delete-list` | 批量删除blog管理 | `Blog_deleteBlogList` |
| 管理后台 - blog管理 | GET | `/admin-api/jh/blog/export-excel` | 导出blog管理 Excel | `Blog_exportBlogExcel` |
| 管理后台 - blog管理 | GET | `/admin-api/jh/blog/get` | 获得blog管理 | `Blog_getBlog` |
| 管理后台 - blog管理 | GET | `/admin-api/jh/blog/get-import-template` | 获得导入blog管理模板 | `Blog_getImportTemplate` |
| 管理后台 - blog管理 | POST | `/admin-api/jh/blog/import-excel` | 导入blog管理Excel | `Blog_importBlogExcel` |
| 管理后台 - blog管理 | GET | `/admin-api/jh/blog/page` | 获得blog管理分页 | `Blog_getBlogPage` |
| 管理后台 - blog管理 | PUT | `/admin-api/jh/blog/update` | 更新blog管理 | `Blog_updateBlog` |
| 管理后台 - news分类 | POST | `/admin-api/jh/news-cate/create` | 创建news分类 | `NewsCate_createNewsCate` |
| 管理后台 - news分类 | DELETE | `/admin-api/jh/news-cate/delete` | 删除news分类 | `NewsCate_deleteNewsCate` |
| 管理后台 - news分类 | DELETE | `/admin-api/jh/news-cate/delete-list` | 批量删除news分类 | `NewsCate_deleteNewsCateList` |
| 管理后台 - news分类 | GET | `/admin-api/jh/news-cate/export-excel` | 导出news分类 Excel | `NewsCate_exportNewsCateExcel` |
| 管理后台 - news分类 | GET | `/admin-api/jh/news-cate/get` | 获得news分类 | `NewsCate_getNewsCate` |
| 管理后台 - news分类 | GET | `/admin-api/jh/news-cate/get-import-template` | 获得导入news分类模板 | `NewsCate_getImportTemplate` |
| 管理后台 - news分类 | POST | `/admin-api/jh/news-cate/import-excel` | 导入news分类Excel | `NewsCate_importNewsCateExcel` |
| 管理后台 - news分类 | GET | `/admin-api/jh/news-cate/page` | 获得news分类分页 | `NewsCate_getNewsCatePage` |
| 管理后台 - news分类 | PUT | `/admin-api/jh/news-cate/update` | 更新news分类 | `NewsCate_updateNewsCate` |
| 管理后台 - news管理 | POST | `/admin-api/jh/news/create` | 创建news管理 | `News_createNews` |
| 管理后台 - news管理 | DELETE | `/admin-api/jh/news/delete` | 删除news管理 | `News_deleteNews` |
| 管理后台 - news管理 | DELETE | `/admin-api/jh/news/delete-list` | 批量删除news管理 | `News_deleteNewsList` |
| 管理后台 - news管理 | GET | `/admin-api/jh/news/export-excel` | 导出news管理 Excel | `News_exportNewsExcel` |
| 管理后台 - news管理 | GET | `/admin-api/jh/news/get` | 获得news管理 | `News_getNews` |
| 管理后台 - news管理 | GET | `/admin-api/jh/news/get-import-template` | 获得导入news管理模板 | `News_getImportTemplate` |
| 管理后台 - news管理 | POST | `/admin-api/jh/news/import-excel` | 导入news管理Excel | `News_importNewsExcel` |
| 管理后台 - news管理 | GET | `/admin-api/jh/news/news-cate-relation/list-by-news-id` | 获得news分类关联列表 | `News_getNewsCateRelationListByNewsId` |
| 管理后台 - news管理 | GET | `/admin-api/jh/news/page` | 获得news管理分页 | `News_getNewsPage` |
| 管理后台 - news管理 | PUT | `/admin-api/jh/news/update` | 更新news管理 | `News_updateNews` |
| 管理后台 - 二维码 | POST | `/admin-api/jh/download-qrcode/create` | 创建二维码 | `DownloadQrcode_createDownloadQrcode` |
| 管理后台 - 二维码 | DELETE | `/admin-api/jh/download-qrcode/delete` | 删除二维码 | `DownloadQrcode_deleteDownloadQrcode` |
| 管理后台 - 二维码 | DELETE | `/admin-api/jh/download-qrcode/delete-list` | 批量删除二维码 | `DownloadQrcode_deleteDownloadQrcodeList` |
| 管理后台 - 二维码 | GET | `/admin-api/jh/download-qrcode/export-excel` | 导出二维码 Excel | `DownloadQrcode_exportDownloadQrcodeExcel` |
| 管理后台 - 二维码 | GET | `/admin-api/jh/download-qrcode/get` | 获得二维码 | `DownloadQrcode_getDownloadQrcode` |
| 管理后台 - 二维码 | GET | `/admin-api/jh/download-qrcode/get-import-template` | 获得导入二维码模板 | `DownloadQrcode_getImportTemplate` |
| 管理后台 - 二维码 | POST | `/admin-api/jh/download-qrcode/import-excel` | 导入二维码Excel | `DownloadQrcode_importDownloadQrcodeExcel` |
| 管理后台 - 二维码 | GET | `/admin-api/jh/download-qrcode/page` | 获得二维码分页（含统计） | `DownloadQrcode_getDownloadQrcodePage` |
| 管理后台 - 二维码 | PUT | `/admin-api/jh/download-qrcode/update` | 更新二维码 | `DownloadQrcode_updateDownloadQrcode` |
| 管理后台 - 产品 | PUT | `/admin-api/jh/product/change-status` | 批量上下架产品 | `Product_updateProductStatus` |
| 管理后台 - 产品 | POST | `/admin-api/jh/product/create` | 创建产品 | `Product_createProduct` |
| 管理后台 - 产品 | DELETE | `/admin-api/jh/product/delete` | 删除产品 | `Product_deleteProduct` |
| 管理后台 - 产品 | DELETE | `/admin-api/jh/product/delete-list` | 批量删除产品 | `Product_deleteProductList` |
| 管理后台 - 产品 | GET | `/admin-api/jh/product/get` | 获得产品 | `Product_getProduct` |
| 管理后台 - 产品 | GET | `/admin-api/jh/product/page` | 获得产品分页 | `Product_getProductPage` |
| 管理后台 - 产品 | GET | `/admin-api/jh/product/product-attr/list-by-product-id` | 获得产品规格类型关联列表 | `Product_getProductAttrListByProductId` |
| 管理后台 - 产品 | GET | `/admin-api/jh/product/product-detail/list-by-product-id` | 获得产品详情列表 | `Product_getProductDetailListByProductId` |
| 管理后台 - 产品 | GET | `/admin-api/jh/product/product-sku/list-by-product-id` | 获得产品规格列表 | `Product_getProductSkuListByProductId` |
| 管理后台 - 产品 | GET | `/admin-api/jh/product/product/sku-list` | 获得产品及规格列表-优惠券中使用 | `Product_getProductSkuList` |
| 管理后台 - 产品 | PUT | `/admin-api/jh/product/update` | 更新产品 | `Product_updateProduct` |
| 管理后台 - 产品分类 | PUT | `/admin-api/jh/product-cate/change-status` | 修改产品分类启用/停用状态 | `ProductCate_updateProductCateStatus` |
| 管理后台 - 产品分类 | POST | `/admin-api/jh/product-cate/create` | 创建产品分类 | `ProductCate_createProductCate` |
| 管理后台 - 产品分类 | DELETE | `/admin-api/jh/product-cate/delete` | 删除产品分类 | `ProductCate_deleteProductCate` |
| 管理后台 - 产品分类 | DELETE | `/admin-api/jh/product-cate/delete-list` | 批量删除产品分类 | `ProductCate_deleteProductCateList` |
| 管理后台 - 产品分类 | GET | `/admin-api/jh/product-cate/get` | 获得产品分类 | `ProductCate_getProductCate` |
| 管理后台 - 产品分类 | GET | `/admin-api/jh/product-cate/page` | 获得产品分类分页 | `ProductCate_getProductCatePage` |
| 管理后台 - 产品分类 | PUT | `/admin-api/jh/product-cate/update` | 更新产品分类 | `ProductCate_updateProductCate` |
| 管理后台 - 产品属性 | PUT | `/admin-api/jh/product-attr-type/change-status` | 启用/停用产品属性状态 | `ProductAttrType_updateProductAttrTypeStatus` |
| 管理后台 - 产品属性 | POST | `/admin-api/jh/product-attr-type/create` | 创建产品属性 | `ProductAttrType_createProductAttrType` |
| 管理后台 - 产品属性 | DELETE | `/admin-api/jh/product-attr-type/delete` | 删除产品属性 | `ProductAttrType_deleteProductAttrType` |
| 管理后台 - 产品属性 | DELETE | `/admin-api/jh/product-attr-type/delete-list` | 批量删除产品属性 | `ProductAttrType_deleteProductAttrTypeList` |
| 管理后台 - 产品属性 | GET | `/admin-api/jh/product-attr-type/get` | 获得产品属性 | `ProductAttrType_getProductAttrType` |
| 管理后台 - 产品属性 | GET | `/admin-api/jh/product-attr-type/page` | 获得产品属性分页 | `ProductAttrType_getProductAttrTypePage` |
| 管理后台 - 产品属性 | PUT | `/admin-api/jh/product-attr-type/update` | 更新产品属性 | `ProductAttrType_updateProductAttrType` |
| 管理后台 - 产品属性值 | POST | `/admin-api/jh/product-attr-data/create` | 创建产品属性值 | `ProductAttrData_createProductAttrData` |
| 管理后台 - 产品属性值 | DELETE | `/admin-api/jh/product-attr-data/delete` | 删除产品属性值 | `ProductAttrData_deleteProductAttrData` |
| 管理后台 - 产品属性值 | DELETE | `/admin-api/jh/product-attr-data/delete-list` | 批量删除产品属性值 | `ProductAttrData_deleteProductAttrDataList` |
| 管理后台 - 产品属性值 | GET | `/admin-api/jh/product-attr-data/get` | 获得产品属性值 | `ProductAttrData_getProductAttrData` |
| 管理后台 - 产品属性值 | GET | `/admin-api/jh/product-attr-data/page` | 获得产品属性值分页 | `ProductAttrData_getProductAttrDataPage` |
| 管理后台 - 产品属性值 | PUT | `/admin-api/jh/product-attr-data/update` | 更新产品属性值 | `ProductAttrData_updateProductAttrData` |
| 管理后台 - 代码生成器 | POST | `/admin-api/infra/codegen/create-list` | 基于数据库的表结构，创建代码生成器的表和字段定义 | `Codegen_createCodegenList` |
| 管理后台 - 代码生成器 | GET | `/admin-api/infra/codegen/db/table/list` | 获得数据库自带的表定义列表 | `Codegen_getDatabaseTableList` |
| 管理后台 - 代码生成器 | DELETE | `/admin-api/infra/codegen/delete` | 删除数据库的表和字段定义 | `Codegen_deleteCodegen` |
| 管理后台 - 代码生成器 | DELETE | `/admin-api/infra/codegen/delete-list` | 批量删除数据库的表和字段定义 | `Codegen_deleteCodegenList` |
| 管理后台 - 代码生成器 | GET | `/admin-api/infra/codegen/detail` | 获得表和字段的明细 | `Codegen_getCodegenDetail` |
| 管理后台 - 代码生成器 | GET | `/admin-api/infra/codegen/download` | 下载生成代码 | `Codegen_downloadCodegen` |
| 管理后台 - 代码生成器 | GET | `/admin-api/infra/codegen/preview` | 预览生成代码 | `Codegen_previewCodegen` |
| 管理后台 - 代码生成器 | PUT | `/admin-api/infra/codegen/sync-from-db` | 基于数据库的表结构，同步数据库的表和字段定义 | `Codegen_syncCodegenFromDB` |
| 管理后台 - 代码生成器 | GET | `/admin-api/infra/codegen/table/list` | 获得表定义列表 | `Codegen_getCodegenTableList` |
| 管理后台 - 代码生成器 | GET | `/admin-api/infra/codegen/table/page` | 获得表定义分页 | `Codegen_getCodegenTablePage` |
| 管理后台 - 代码生成器 | PUT | `/admin-api/infra/codegen/update` | 更新数据库的表和字段定义 | `Codegen_updateCodegen` |
| 管理后台 - 协议 | POST | `/admin-api/jh/agreement/create` | 创建协议 | `Agreement_createAgreement` |
| 管理后台 - 协议 | DELETE | `/admin-api/jh/agreement/delete` | 删除协议 | `Agreement_deleteAgreement` |
| 管理后台 - 协议 | DELETE | `/admin-api/jh/agreement/delete-list` | 批量删除协议 | `Agreement_deleteAgreementList` |
| 管理后台 - 协议 | GET | `/admin-api/jh/agreement/export-excel` | 导出协议 Excel | `Agreement_exportAgreementExcel` |
| 管理后台 - 协议 | GET | `/admin-api/jh/agreement/get` | 获得协议 | `Agreement_getAgreement` |
| 管理后台 - 协议 | GET | `/admin-api/jh/agreement/get-import-template` | 获得导入协议模板 | `Agreement_getImportTemplate` |
| 管理后台 - 协议 | POST | `/admin-api/jh/agreement/import-excel` | 导入协议Excel | `Agreement_importAgreementExcel` |
| 管理后台 - 协议 | GET | `/admin-api/jh/agreement/page` | 获得协议分页 | `Agreement_getAgreementPage` |
| 管理后台 - 协议 | PUT | `/admin-api/jh/agreement/update` | 更新协议 | `Agreement_updateAgreement` |
| 管理后台 - 参数配置 | POST | `/admin-api/infra/config/create` | 创建参数配置 | `Config_createConfig` |
| 管理后台 - 参数配置 | DELETE | `/admin-api/infra/config/delete` | 删除参数配置 | `Config_deleteConfig` |
| 管理后台 - 参数配置 | DELETE | `/admin-api/infra/config/delete-list` | 批量删除参数配置 | `Config_deleteConfigList` |
| 管理后台 - 参数配置 | GET | `/admin-api/infra/config/export-excel` | 导出参数配置 | `Config_exportConfig` |
| 管理后台 - 参数配置 | GET | `/admin-api/infra/config/get` | 获得参数配置 | `Config_getConfig` |
| 管理后台 - 参数配置 | GET | `/admin-api/infra/config/get-value-by-key` | 根据参数键名查询参数值 | `Config_getConfigKey` |
| 管理后台 - 参数配置 | GET | `/admin-api/infra/config/page` | 获取参数配置分页 | `Config_getConfigPage` |
| 管理后台 - 参数配置 | PUT | `/admin-api/infra/config/update` | 修改参数配置 | `Config_updateConfig` |
| 管理后台 - 合作联系数据 | POST | `/admin-api/jh/cooperation/create` | 创建合作联系数据 | `Cooperation_createCooperation` |
| 管理后台 - 合作联系数据 | DELETE | `/admin-api/jh/cooperation/delete` | 删除合作联系数据 | `Cooperation_deleteCooperation` |
| 管理后台 - 合作联系数据 | DELETE | `/admin-api/jh/cooperation/delete-list` | 批量删除合作联系数据 | `Cooperation_deleteCooperationList` |
| 管理后台 - 合作联系数据 | GET | `/admin-api/jh/cooperation/export-excel` | 导出合作联系数据 Excel | `Cooperation_exportCooperationExcel` |
| 管理后台 - 合作联系数据 | GET | `/admin-api/jh/cooperation/get` | 获得合作联系数据 | `Cooperation_getCooperation` |
| 管理后台 - 合作联系数据 | GET | `/admin-api/jh/cooperation/get-import-template` | 获得导入合作联系数据模板 | `Cooperation_getImportTemplate` |
| 管理后台 - 合作联系数据 | POST | `/admin-api/jh/cooperation/import-excel` | 导入合作联系数据Excel | `Cooperation_importCooperationExcel` |
| 管理后台 - 合作联系数据 | GET | `/admin-api/jh/cooperation/page` | 获得合作联系数据分页 | `Cooperation_getCooperationPage` |
| 管理后台 - 合作联系数据 | PUT | `/admin-api/jh/cooperation/update` | 更新合作联系数据 | `Cooperation_updateCooperation` |
| 管理后台 - 售后 | GET | `/admin-api/jh/order-after-sale/export-excel` | 导出售后 Excel | `OrderAfterSale_exportOrderAfterSaleExcel` |
| 管理后台 - 售后 | GET | `/admin-api/jh/order-after-sale/get` | 获得售后 | `OrderAfterSale_getOrderAfterSale` |
| 管理后台 - 售后 | GET | `/admin-api/jh/order-after-sale/page` | 获得售后分页 | `OrderAfterSale_getOrderAfterSalePage` |
| 管理后台 - 售后政策 | POST | `/admin-api/jh/after-sales-policy/create` | 创建售后政策 | `AfterSalesPolicy_createAfterSalesPolicy` |
| 管理后台 - 售后政策 | DELETE | `/admin-api/jh/after-sales-policy/delete` | 删除售后政策 | `AfterSalesPolicy_deleteAfterSalesPolicy` |
| 管理后台 - 售后政策 | DELETE | `/admin-api/jh/after-sales-policy/delete-list` | 批量删除售后政策 | `AfterSalesPolicy_deleteAfterSalesPolicyList` |
| 管理后台 - 售后政策 | GET | `/admin-api/jh/after-sales-policy/export-excel` | 导出售后政策 Excel | `AfterSalesPolicy_exportAfterSalesPolicyExcel` |
| 管理后台 - 售后政策 | GET | `/admin-api/jh/after-sales-policy/get` | 获得售后政策 | `AfterSalesPolicy_getAfterSalesPolicy` |
| 管理后台 - 售后政策 | GET | `/admin-api/jh/after-sales-policy/get-import-template` | 获得导入售后政策模板 | `AfterSalesPolicy_getImportTemplate` |
| 管理后台 - 售后政策 | POST | `/admin-api/jh/after-sales-policy/import-excel` | 导入售后政策Excel | `AfterSalesPolicy_importAfterSalesPolicyExcel` |
| 管理后台 - 售后政策 | GET | `/admin-api/jh/after-sales-policy/page` | 获得售后政策分页 | `AfterSalesPolicy_getAfterSalesPolicyPage` |
| 管理后台 - 售后政策 | PUT | `/admin-api/jh/after-sales-policy/update` | 更新售后政策 | `AfterSalesPolicy_updateAfterSalesPolicy` |
| 管理后台 - 售后政策-品牌 | POST | `/admin-api/jh/after-sales-brand/create` | 创建售后政策-品牌 | `AfterSalesBrand_createAfterSalesBrand` |
| 管理后台 - 售后政策-品牌 | DELETE | `/admin-api/jh/after-sales-brand/delete` | 删除售后政策-品牌 | `AfterSalesBrand_deleteAfterSalesBrand` |
| 管理后台 - 售后政策-品牌 | DELETE | `/admin-api/jh/after-sales-brand/delete-list` | 批量删除售后政策-品牌 | `AfterSalesBrand_deleteAfterSalesBrandList` |
| 管理后台 - 售后政策-品牌 | GET | `/admin-api/jh/after-sales-brand/export-excel` | 导出售后政策-品牌 Excel | `AfterSalesBrand_exportAfterSalesBrandExcel` |
| 管理后台 - 售后政策-品牌 | GET | `/admin-api/jh/after-sales-brand/get` | 获得售后政策-品牌 | `AfterSalesBrand_getAfterSalesBrand` |
| 管理后台 - 售后政策-品牌 | GET | `/admin-api/jh/after-sales-brand/get-import-template` | 获得导入售后政策-品牌模板 | `AfterSalesBrand_getImportTemplate` |
| 管理后台 - 售后政策-品牌 | POST | `/admin-api/jh/after-sales-brand/import-excel` | 导入售后政策-品牌Excel | `AfterSalesBrand_importAfterSalesBrandExcel` |
| 管理后台 - 售后政策-品牌 | GET | `/admin-api/jh/after-sales-brand/list-available` | 获得可用的品牌列表 | `AfterSalesBrand_getAvailableBrandList` |
| 管理后台 - 售后政策-品牌 | GET | `/admin-api/jh/after-sales-brand/page` | 获得售后政策-品牌分页 | `AfterSalesBrand_getAfterSalesBrandPage` |
| 管理后台 - 售后政策-品牌 | PUT | `/admin-api/jh/after-sales-brand/update` | 更新售后政策-品牌 | `AfterSalesBrand_updateAfterSalesBrand` |
| 管理后台 - 国家信息 | POST | `/admin-api/jh/address-country/create` | 创建国家信息 | `AddressCountry_createAddressCountry` |
| 管理后台 - 国家信息 | DELETE | `/admin-api/jh/address-country/delete` | 删除国家信息 | `AddressCountry_deleteAddressCountry` |
| 管理后台 - 国家信息 | DELETE | `/admin-api/jh/address-country/delete-list` | 批量删除国家信息 | `AddressCountry_deleteAddressCountryList` |
| 管理后台 - 国家信息 | GET | `/admin-api/jh/address-country/export-excel` | 导出国家信息 Excel | `AddressCountry_exportAddressCountryExcel` |
| 管理后台 - 国家信息 | GET | `/admin-api/jh/address-country/get` | 获得国家信息 | `AddressCountry_getAddressCountry` |
| 管理后台 - 国家信息 | GET | `/admin-api/jh/address-country/get-import-template` | 获得导入国家信息模板 | `AddressCountry_getImportTemplate` |
| 管理后台 - 国家信息 | POST | `/admin-api/jh/address-country/import-excel` | 导入国家信息Excel | `AddressCountry_importAddressCountryExcel` |
| 管理后台 - 国家信息 | GET | `/admin-api/jh/address-country/options-for-shipping` | 获得运费规则国家下拉选项（弃用） | `AddressCountry_getOptionsForShipping` |
| 管理后台 - 国家信息 | GET | `/admin-api/jh/address-country/page` | 获得国家信息分页 | `AddressCountry_getAddressCountryPage` |
| 管理后台 - 国家信息 | PUT | `/admin-api/jh/address-country/update` | 更新国家信息 | `AddressCountry_updateAddressCountry` |
| 管理后台 - 国家信息 | PUT | `/admin-api/jh/address-country/update-status-list` | 批量更新国家信息状态 | `AddressCountry_updateAddressCountryStatusList` |
| 管理后台 - 地区 | GET | `/admin-api/system/area/get-by-ip` | 获得 IP 对应的地区名 | `Area_getAreaByIp` |
| 管理后台 - 地区 | GET | `/admin-api/system/area/tree` | 获得地区树 | `Area_getAreaTree` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | POST | `/admin-api/jh/article/create` | 创建基础数据-说明 | `Article_createArticle` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | DELETE | `/admin-api/jh/article/delete` | 删除基础数据-说明 | `Article_deleteArticle` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | DELETE | `/admin-api/jh/article/delete-list` | 批量删除基础数据-说明 | `Article_deleteArticleList` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | GET | `/admin-api/jh/article/export-excel` | 导出基础数据-说明 Excel | `Article_exportArticleExcel` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | GET | `/admin-api/jh/article/get` | 获得基础数据-说明 | `Article_getArticle` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | GET | `/admin-api/jh/article/get-import-template` | 获得导入基础数据-说明模板 | `Article_getImportTemplate` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | POST | `/admin-api/jh/article/import-excel` | 导入基础数据-说明Excel | `Article_importArticleExcel` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | GET | `/admin-api/jh/article/page` | 获得基础数据-说明分页 | `Article_getArticlePage` |
| 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等) | PUT | `/admin-api/jh/article/update` | 更新基础数据-说明 | `Article_updateArticle` |
| 管理后台 - 字典数据 | POST | `/admin-api/system/dict-data/create` | 新增字典数据 | `DictData_createDictData` |
| 管理后台 - 字典数据 | DELETE | `/admin-api/system/dict-data/delete` | 删除字典数据 | `DictData_deleteDictData` |
| 管理后台 - 字典数据 | DELETE | `/admin-api/system/dict-data/delete-list` | 批量删除字典数据 | `DictData_deleteDictDataList` |
| 管理后台 - 字典数据 | GET | `/admin-api/system/dict-data/export-excel` | 导出字典数据 | `DictData_export` |
| 管理后台 - 字典数据 | GET | `/admin-api/system/dict-data/get` | /查询字典数据详细 | `DictData_getDictData` |
| 管理后台 - 字典数据 | GET | `/admin-api/system/dict-data/list-all-simple` | 获得全部字典数据列表 | `DictData_getSimpleDictDataList` |
| 管理后台 - 字典数据 | GET | `/admin-api/system/dict-data/page` | 获得字典类型的分页 | `DictData_getDictTypePage` |
| 管理后台 - 字典数据 | GET | `/admin-api/system/dict-data/simple-list` | 获得全部字典数据列表 | `DictData_getSimpleDictDataList_1` |
| 管理后台 - 字典数据 | PUT | `/admin-api/system/dict-data/update` | 修改字典数据 | `DictData_updateDictData` |
| 管理后台 - 字典类型 | POST | `/admin-api/system/dict-type/create` | 创建字典类型 | `DictType_createDictType` |
| 管理后台 - 字典类型 | DELETE | `/admin-api/system/dict-type/delete` | 删除字典类型 | `DictType_deleteDictType` |
| 管理后台 - 字典类型 | DELETE | `/admin-api/system/dict-type/delete-list` | 批量删除字典类型 | `DictType_deleteDictTypeList` |
| 管理后台 - 字典类型 | GET | `/admin-api/system/dict-type/export-excel` | 导出数据类型 | `DictType_export` |
| 管理后台 - 字典类型 | GET | `/admin-api/system/dict-type/get` | /查询字典类型详细 | `DictType_getDictType` |
| 管理后台 - 字典类型 | GET | `/admin-api/system/dict-type/list-all-simple` | 获得全部字典类型列表 | `DictType_getSimpleDictTypeList` |
| 管理后台 - 字典类型 | GET | `/admin-api/system/dict-type/page` | 获得字典类型的分页列表 | `DictType_pageDictTypes` |
| 管理后台 - 字典类型 | GET | `/admin-api/system/dict-type/simple-list` | 获得全部字典类型列表 | `DictType_getSimpleDictTypeList_1` |
| 管理后台 - 字典类型 | PUT | `/admin-api/system/dict-type/update` | 修改字典类型 | `DictType_updateDictType` |
| 管理后台 - 学生 | POST | `/admin-api/infra/demo03-student-erp/create` | 创建学生 | `Demo03StudentErp_createDemo03Student` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-erp/delete` | 删除学生 | `Demo03StudentErp_deleteDemo03Student` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-erp/delete-list` | 批量删除学生 | `Demo03StudentErp_deleteDemo03StudentList` |
| 管理后台 - 学生 | POST | `/admin-api/infra/demo03-student-erp/demo03-course/create` | 创建学生课程 | `Demo03StudentErp_createDemo03Course` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-erp/demo03-course/delete` | 删除学生课程 | `Demo03StudentErp_deleteDemo03Course` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-erp/demo03-course/delete-list` | 批量删除学生课程 | `Demo03StudentErp_deleteDemo03CourseList` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-erp/demo03-course/get` | 获得学生课程 | `Demo03StudentErp_getDemo03Course` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-erp/demo03-course/page` | 获得学生课程分页 | `Demo03StudentErp_getDemo03CoursePage` |
| 管理后台 - 学生 | PUT | `/admin-api/infra/demo03-student-erp/demo03-course/update` | 更新学生课程 | `Demo03StudentErp_updateDemo03Course` |
| 管理后台 - 学生 | POST | `/admin-api/infra/demo03-student-erp/demo03-grade/create` | 创建学生班级 | `Demo03StudentErp_createDemo03Grade` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-erp/demo03-grade/delete` | 删除学生班级 | `Demo03StudentErp_deleteDemo03Grade` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-erp/demo03-grade/delete-list` | 批量删除学生班级 | `Demo03StudentErp_deleteDemo03GradeList` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-erp/demo03-grade/get` | 获得学生班级 | `Demo03StudentErp_getDemo03Grade` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-erp/demo03-grade/page` | 获得学生班级分页 | `Demo03StudentErp_getDemo03GradePage` |
| 管理后台 - 学生 | PUT | `/admin-api/infra/demo03-student-erp/demo03-grade/update` | 更新学生班级 | `Demo03StudentErp_updateDemo03Grade` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-erp/export-excel` | 导出学生 Excel | `Demo03StudentErp_exportDemo03StudentExcel` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-erp/get` | 获得学生 | `Demo03StudentErp_getDemo03Student` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-erp/page` | 获得学生分页 | `Demo03StudentErp_getDemo03StudentPage` |
| 管理后台 - 学生 | PUT | `/admin-api/infra/demo03-student-erp/update` | 更新学生 | `Demo03StudentErp_updateDemo03Student` |
| 管理后台 - 学生 | POST | `/admin-api/infra/demo03-student-inner/create` | 创建学生 | `Demo03StudentInner_createDemo03Student` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-inner/delete` | 删除学生 | `Demo03StudentInner_deleteDemo03Student` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-inner/delete-list` | 批量删除学生 | `Demo03StudentInner_deleteDemo03StudentList` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-inner/demo03-course/list-by-student-id` | 获得学生课程列表 | `Demo03StudentInner_getDemo03CourseListByStudentId` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-inner/demo03-grade/get-by-student-id` | 获得学生班级 | `Demo03StudentInner_getDemo03GradeByStudentId` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-inner/export-excel` | 导出学生 Excel | `Demo03StudentInner_exportDemo03StudentExcel` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-inner/get` | 获得学生 | `Demo03StudentInner_getDemo03Student` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-inner/page` | 获得学生分页 | `Demo03StudentInner_getDemo03StudentPage` |
| 管理后台 - 学生 | PUT | `/admin-api/infra/demo03-student-inner/update` | 更新学生 | `Demo03StudentInner_updateDemo03Student` |
| 管理后台 - 学生 | POST | `/admin-api/infra/demo03-student-normal/create` | 创建学生 | `Demo03StudentNormal_createDemo03Student` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-normal/delete` | 删除学生 | `Demo03StudentNormal_deleteDemo03Student` |
| 管理后台 - 学生 | DELETE | `/admin-api/infra/demo03-student-normal/delete-list` | 批量删除学生 | `Demo03StudentNormal_deleteDemo03StudentList` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-normal/demo03-course/list-by-student-id` | 获得学生课程列表 | `Demo03StudentNormal_getDemo03CourseListByStudentId` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-normal/demo03-grade/get-by-student-id` | 获得学生班级 | `Demo03StudentNormal_getDemo03GradeByStudentId` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-normal/export-excel` | 导出学生 Excel | `Demo03StudentNormal_exportDemo03StudentExcel` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-normal/get` | 获得学生 | `Demo03StudentNormal_getDemo03Student` |
| 管理后台 - 学生 | GET | `/admin-api/infra/demo03-student-normal/page` | 获得学生分页 | `Demo03StudentNormal_getDemo03StudentPage` |
| 管理后台 - 学生 | PUT | `/admin-api/infra/demo03-student-normal/update` | 更新学生 | `Demo03StudentNormal_updateDemo03Student` |
| 管理后台 - 定时任务 | POST | `/admin-api/infra/job/create` | 创建定时任务 | `Job_createJob` |
| 管理后台 - 定时任务 | DELETE | `/admin-api/infra/job/delete` | 删除定时任务 | `Job_deleteJob` |
| 管理后台 - 定时任务 | DELETE | `/admin-api/infra/job/delete-list` | 批量删除定时任务 | `Job_deleteJobList` |
| 管理后台 - 定时任务 | GET | `/admin-api/infra/job/export-excel` | 导出定时任务 Excel | `Job_exportJobExcel` |
| 管理后台 - 定时任务 | GET | `/admin-api/infra/job/get` | 获得定时任务 | `Job_getJob` |
| 管理后台 - 定时任务 | GET | `/admin-api/infra/job/get_next_times` | 获得定时任务的下 n 次执行时间 | `Job_getJobNextTimes` |
| 管理后台 - 定时任务 | GET | `/admin-api/infra/job/page` | 获得定时任务分页 | `Job_getJobPage` |
| 管理后台 - 定时任务 | POST | `/admin-api/infra/job/sync` | 同步定时任务 | `Job_syncJob` |
| 管理后台 - 定时任务 | PUT | `/admin-api/infra/job/trigger` | 触发定时任务 | `Job_triggerJob` |
| 管理后台 - 定时任务 | PUT | `/admin-api/infra/job/update` | 更新定时任务 | `Job_updateJob` |
| 管理后台 - 定时任务 | PUT | `/admin-api/infra/job/update-status` | 更新定时任务的状态 | `Job_updateJobStatus` |
| 管理后台 - 定时任务日志 | GET | `/admin-api/infra/job-log/export-excel` | 导出定时任务日志 Excel | `JobLog_exportJobLogExcel` |
| 管理后台 - 定时任务日志 | GET | `/admin-api/infra/job-log/get` | 获得定时任务日志 | `JobLog_getJobLog` |
| 管理后台 - 定时任务日志 | GET | `/admin-api/infra/job-log/page` | 获得定时任务日志分页 | `JobLog_getJobLogPage` |
| 管理后台 - 岗位 | POST | `/admin-api/system/post/create` | 创建岗位 | `Post_createPost` |
| 管理后台 - 岗位 | DELETE | `/admin-api/system/post/delete` | 删除岗位 | `Post_deletePost` |
| 管理后台 - 岗位 | DELETE | `/admin-api/system/post/delete-list` | 批量删除岗位 | `Post_deletePostList` |
| 管理后台 - 岗位 | GET | `/admin-api/system/post/export-excel` | 岗位管理 | `Post_export` |
| 管理后台 - 岗位 | GET | `/admin-api/system/post/get` | 获得岗位信息 | `Post_getPost` |
| 管理后台 - 岗位 | GET | `/admin-api/system/post/list-all-simple` | 获取岗位全列表 | `Post_getSimplePostList` |
| 管理后台 - 岗位 | GET | `/admin-api/system/post/page` | 获得岗位分页列表 | `Post_getPostPage` |
| 管理后台 - 岗位 | GET | `/admin-api/system/post/simple-list` | 获取岗位全列表 | `Post_getSimplePostList_1` |
| 管理后台 - 岗位 | PUT | `/admin-api/system/post/update` | 修改岗位 | `Post_updatePost` |
| 管理后台 - 我的站内信 | GET | `/admin-api/system/notify-message/get` | 获得站内信 | `NotifyMessage_getNotifyMessage` |
| 管理后台 - 我的站内信 | GET | `/admin-api/system/notify-message/get-unread-count` | 获得当前用户的未读站内信数量 | `NotifyMessage_getUnreadNotifyMessageCount` |
| 管理后台 - 我的站内信 | GET | `/admin-api/system/notify-message/get-unread-list` | 获取当前用户的最新站内信列表，默认 10 条 | `NotifyMessage_getUnreadNotifyMessageList` |
| 管理后台 - 我的站内信 | GET | `/admin-api/system/notify-message/my-page` | 获得我的站内信分页 | `NotifyMessage_getMyMyNotifyMessagePage` |
| 管理后台 - 我的站内信 | GET | `/admin-api/system/notify-message/page` | 获得站内信分页 | `NotifyMessage_getNotifyMessagePage` |
| 管理后台 - 我的站内信 | PUT | `/admin-api/system/notify-message/update-all-read` | 标记所有站内信为已读 | `NotifyMessage_updateAllNotifyMessageRead` |
| 管理后台 - 我的站内信 | PUT | `/admin-api/system/notify-message/update-read` | 标记站内信为已读 | `NotifyMessage_updateNotifyMessageRead` |
| 管理后台 - 折扣 | PUT | `/admin-api/jh/discount/change-status` | 启用/停用 | `Discount_updateDiscountStatus` |
| 管理后台 - 折扣 | POST | `/admin-api/jh/discount/create` | 创建折扣 | `Discount_createDiscount` |
| 管理后台 - 折扣 | DELETE | `/admin-api/jh/discount/delete` | 删除折扣 | `Discount_deleteDiscount` |
| 管理后台 - 折扣 | DELETE | `/admin-api/jh/discount/delete-list` | 批量删除折扣 | `Discount_deleteDiscountList` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/discount-customer-cate/list-by-discount-id` | 获得折扣特定客户分类列表 | `Discount_getDiscountCustomerCateListByDiscountId` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/discount-customer/get_cate` | 获得APP客户分类 | `Discount_getDiscountCustomerCateList` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/discount-customer/get_customer` | 查询APP客户 | `Discount_getDiscountCustomerList` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/discount-customer/list-by-discount-id` | 获得折扣特定客户列表 | `Discount_getDiscountCustomerListByDiscountId` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/discount-product-cate/list-by-discount-id` | 获得折扣产品分类列表 | `Discount_getDiscountProductCateListByDiscountId` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/discount-product/list-by-discount-id` | 获得折扣产品列表 | `Discount_getDiscountProductListByDiscountId` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/get` | 获得折扣 | `Discount_getDiscount` |
| 管理后台 - 折扣 | GET | `/admin-api/jh/discount/page` | 获得折扣分页 | `Discount_getDiscountPage` |
| 管理后台 - 折扣 | PUT | `/admin-api/jh/discount/update` | 更新折扣 | `Discount_updateDiscount` |
| 管理后台 - 折扣数据 | GET | `/admin-api/jh/discount-usage-record/export-excel` | 导出折扣数据 Excel | `DiscountUsageRecord_exportDiscountUsageRecordExcel` |
| 管理后台 - 折扣数据 | GET | `/admin-api/jh/discount-usage-record/get-data` | 获取统计数据 | `DiscountUsageRecord_getDiscountUsageRecordStatisticPage` |
| 管理后台 - 操作日志 | GET | `/admin-api/system/operate-log/export-excel` | 导出操作日志 | `OperateLog_exportOperateLog` |
| 管理后台 - 操作日志 | GET | `/admin-api/system/operate-log/page` | 查看操作日志分页列表 | `OperateLog_pageOperateLog` |
| 管理后台 - 支付页产品推荐 | PUT | `/admin-api/jh/product-payment-recommend/change-rank-num` | 修改排序号 | `ProductPaymentRecommend_updateProductPaymentRecommend` |
| 管理后台 - 支付页产品推荐 | PUT | `/admin-api/jh/product-payment-recommend/change-status` | 修改推荐状态 | `ProductPaymentRecommend_getProductPaymentRecommend` |
| 管理后台 - 支付页产品推荐 | POST | `/admin-api/jh/product-payment-recommend/create` | 创建支付页产品推荐 | `ProductPaymentRecommend_createProductPaymentRecommend` |
| 管理后台 - 支付页产品推荐 | DELETE | `/admin-api/jh/product-payment-recommend/delete` | 删除支付页产品推荐 | `ProductPaymentRecommend_deleteProductPaymentRecommend` |
| 管理后台 - 支付页产品推荐 | DELETE | `/admin-api/jh/product-payment-recommend/delete-list` | 批量删除支付页产品推荐 | `ProductPaymentRecommend_deleteProductPaymentRecommendList` |
| 管理后台 - 支付页产品推荐 | GET | `/admin-api/jh/product-payment-recommend/page` | 获得支付页产品推荐分页 | `ProductPaymentRecommend_getProductPaymentRecommendPage` |
| 管理后台 - 数据源配置 | POST | `/admin-api/infra/data-source-config/create` | 创建数据源配置 | `DataSourceConfig_createDataSourceConfig` |
| 管理后台 - 数据源配置 | DELETE | `/admin-api/infra/data-source-config/delete` | 删除数据源配置 | `DataSourceConfig_deleteDataSourceConfig` |
| 管理后台 - 数据源配置 | DELETE | `/admin-api/infra/data-source-config/delete-list` | 批量删除数据源配置 | `DataSourceConfig_deleteDataSourceConfigList` |
| 管理后台 - 数据源配置 | GET | `/admin-api/infra/data-source-config/get` | 获得数据源配置 | `DataSourceConfig_getDataSourceConfig` |
| 管理后台 - 数据源配置 | GET | `/admin-api/infra/data-source-config/list` | 获得数据源配置列表 | `DataSourceConfig_getDataSourceConfigList` |
| 管理后台 - 数据源配置 | PUT | `/admin-api/infra/data-source-config/update` | 更新数据源配置 | `DataSourceConfig_updateDataSourceConfig` |
| 管理后台 - 文件存储 | POST | `/admin-api/infra/file/create` | 创建文件 | `File_createFile` |
| 管理后台 - 文件存储 | DELETE | `/admin-api/infra/file/delete` | 删除文件 | `File_deleteFile` |
| 管理后台 - 文件存储 | DELETE | `/admin-api/infra/file/delete-list` | 批量删除文件 | `File_deleteFileList` |
| 管理后台 - 文件存储 | GET | `/admin-api/infra/file/page` | 获得文件分页 | `File_getFilePage` |
| 管理后台 - 文件存储 | GET | `/admin-api/infra/file/presigned-url` | 获取文件预签名地址（上传） | `File_getFilePresignedUrl` |
| 管理后台 - 文件存储 | POST | `/admin-api/infra/file/upload` | 上传文件 | `File_uploadFile` |
| 管理后台 - 文件存储 | GET | `/admin-api/infra/file/{configId}/get/**` | 下载文件 | `File_getFileContent` |
| 管理后台 - 文件配置 | POST | `/admin-api/infra/file-config/create` | 创建文件配置 | `FileConfig_createFileConfig` |
| 管理后台 - 文件配置 | DELETE | `/admin-api/infra/file-config/delete` | 删除文件配置 | `FileConfig_deleteFileConfig` |
| 管理后台 - 文件配置 | DELETE | `/admin-api/infra/file-config/delete-list` | 批量删除文件配置 | `FileConfig_deleteFileConfigList` |
| 管理后台 - 文件配置 | GET | `/admin-api/infra/file-config/get` | 获得文件配置 | `FileConfig_getFileConfig` |
| 管理后台 - 文件配置 | GET | `/admin-api/infra/file-config/page` | 获得文件配置分页 | `FileConfig_getFileConfigPage` |
| 管理后台 - 文件配置 | GET | `/admin-api/infra/file-config/test` | 测试文件配置是否正确 | `FileConfig_testFileConfig` |
| 管理后台 - 文件配置 | PUT | `/admin-api/infra/file-config/update` | 更新文件配置 | `FileConfig_updateFileConfig` |
| 管理后台 - 文件配置 | PUT | `/admin-api/infra/file-config/update-master` | 更新文件配置为 Master | `FileConfig_updateFileConfigMaster` |
| 管理后台 - 权限 | POST | `/admin-api/system/permission/assign-role-data-scope` | 赋予角色数据权限 | `Permission_assignRoleDataScope` |
| 管理后台 - 权限 | POST | `/admin-api/system/permission/assign-role-menu` | 赋予角色菜单 | `Permission_assignRoleMenu` |
| 管理后台 - 权限 | POST | `/admin-api/system/permission/assign-user-role` | 赋予用户角色 | `Permission_assignUserRole` |
| 管理后台 - 权限 | GET | `/admin-api/system/permission/list-role-menus` | 获得角色拥有的菜单编号 | `Permission_getRoleMenuList` |
| 管理后台 - 权限 | GET | `/admin-api/system/permission/list-user-roles` | 获得管理员拥有的角色编号列表 | `Permission_listAdminRoles` |
| 管理后台 - 流量详情 | GET | `/admin-api/jh/landing-page-tracker-detail/export-excel` | 导出流量详情 Excel | `LandingPageTrackerDetail_exportLandingPageTrackerDetailExcel` |
| 管理后台 - 流量详情 | GET | `/admin-api/jh/landing-page-tracker-detail/page` | 获得流量详情分页 | `LandingPageTrackerDetail_getLandingPageTrackerDetailPage` |
| 管理后台 - 用户 | POST | `/admin-api/system/user/create` | 新增用户 | `User_createUser` |
| 管理后台 - 用户 | DELETE | `/admin-api/system/user/delete` | 删除用户 | `User_deleteUser` |
| 管理后台 - 用户 | DELETE | `/admin-api/system/user/delete-list` | 批量删除用户 | `User_deleteUserList` |
| 管理后台 - 用户 | GET | `/admin-api/system/user/export-excel` | 导出用户 | `User_exportUserList` |
| 管理后台 - 用户 | GET | `/admin-api/system/user/get` | 获得用户详情 | `User_getUser` |
| 管理后台 - 用户 | GET | `/admin-api/system/user/get-import-template` | 获得导入用户模板 | `User_importTemplate` |
| 管理后台 - 用户 | POST | `/admin-api/system/user/import` | 导入用户 | `User_importExcel` |
| 管理后台 - 用户 | GET | `/admin-api/system/user/list-all-simple` | 获取用户精简信息列表 | `User_getSimpleUserList` |
| 管理后台 - 用户 | GET | `/admin-api/system/user/page` | 获得用户分页列表 | `User_getUserPage` |
| 管理后台 - 用户 | GET | `/admin-api/system/user/reset-fingerprint` | 重置指纹 | `User_resetFingerprint` |
| 管理后台 - 用户 | GET | `/admin-api/system/user/simple-list` | 获取用户精简信息列表 | `User_getSimpleUserList_1` |
| 管理后台 - 用户 | PUT | `/admin-api/system/user/update` | 修改用户 | `User_updateUser` |
| 管理后台 - 用户 | PUT | `/admin-api/system/user/update-password` | 重置用户密码 | `User_updateUserPassword` |
| 管理后台 - 用户 | PUT | `/admin-api/system/user/update-status` | 修改用户状态 | `User_updateUserStatus` |
| 管理后台 - 用户个人中心 | GET | `/admin-api/system/user/profile/get` | 获得登录用户信息 | `UserProfile_getUserProfile` |
| 管理后台 - 用户个人中心 | PUT | `/admin-api/system/user/profile/update` | 修改用户个人信息 | `UserProfile_updateUserProfile` |
| 管理后台 - 用户个人中心 | PUT | `/admin-api/system/user/profile/update-password` | 修改用户个人密码 | `UserProfile_updateUserProfilePassword` |
| 管理后台 - 登录日志 | GET | `/admin-api/system/login-log/export-excel` | 导出登录日志 Excel | `LoginLog_exportLoginLog` |
| 管理后台 - 登录日志 | GET | `/admin-api/system/login-log/page` | 获得登录日志分页列表 | `LoginLog_getLoginLogPage` |
| 管理后台 - 短信回调 | POST | `/admin-api/system/sms/callback/aliyun` | 阿里云短信的回调 | `SmsCallback_receiveAliyunSmsStatus` |
| 管理后台 - 短信回调 | POST | `/admin-api/system/sms/callback/huawei` | 华为云短信的回调 | `SmsCallback_receiveHuaweiSmsStatus` |
| 管理后台 - 短信回调 | POST | `/admin-api/system/sms/callback/qiniu` | 七牛云短信的回调 | `SmsCallback_receiveQiniuSmsStatus` |
| 管理后台 - 短信回调 | POST | `/admin-api/system/sms/callback/tencent` | 腾讯云短信的回调 | `SmsCallback_receiveTencentSmsStatus` |
| 管理后台 - 短信日志 | GET | `/admin-api/system/sms-log/export-excel` | 导出短信日志 Excel | `SmsLog_exportSmsLogExcel` |
| 管理后台 - 短信日志 | GET | `/admin-api/system/sms-log/page` | 获得短信日志分页 | `SmsLog_getSmsLogPage` |
| 管理后台 - 短信模板 | POST | `/admin-api/system/sms-template/create` | 创建短信模板 | `SmsTemplate_createSmsTemplate` |
| 管理后台 - 短信模板 | DELETE | `/admin-api/system/sms-template/delete` | 删除短信模板 | `SmsTemplate_deleteSmsTemplate` |
| 管理后台 - 短信模板 | DELETE | `/admin-api/system/sms-template/delete-list` | 批量删除短信模板 | `SmsTemplate_deleteSmsTemplateList` |
| 管理后台 - 短信模板 | GET | `/admin-api/system/sms-template/export-excel` | 导出短信模板 Excel | `SmsTemplate_exportSmsTemplateExcel` |
| 管理后台 - 短信模板 | GET | `/admin-api/system/sms-template/get` | 获得短信模板 | `SmsTemplate_getSmsTemplate` |
| 管理后台 - 短信模板 | GET | `/admin-api/system/sms-template/page` | 获得短信模板分页 | `SmsTemplate_getSmsTemplatePage` |
| 管理后台 - 短信模板 | POST | `/admin-api/system/sms-template/send-sms` | 发送短信 | `SmsTemplate_sendSms` |
| 管理后台 - 短信模板 | PUT | `/admin-api/system/sms-template/update` | 更新短信模板 | `SmsTemplate_updateSmsTemplate` |
| 管理后台 - 短信渠道 | POST | `/admin-api/system/sms-channel/create` | 创建短信渠道 | `SmsChannel_createSmsChannel` |
| 管理后台 - 短信渠道 | DELETE | `/admin-api/system/sms-channel/delete` | 删除短信渠道 | `SmsChannel_deleteSmsChannel` |
| 管理后台 - 短信渠道 | DELETE | `/admin-api/system/sms-channel/delete-list` | 批量删除短信渠道 | `SmsChannel_deleteSmsChannelList` |
| 管理后台 - 短信渠道 | GET | `/admin-api/system/sms-channel/get` | 获得短信渠道 | `SmsChannel_getSmsChannel` |
| 管理后台 - 短信渠道 | GET | `/admin-api/system/sms-channel/list-all-simple` | 获得短信渠道精简列表 | `SmsChannel_getSimpleSmsChannelList_1` |
| 管理后台 - 短信渠道 | GET | `/admin-api/system/sms-channel/page` | 获得短信渠道分页 | `SmsChannel_getSmsChannelPage` |
| 管理后台 - 短信渠道 | GET | `/admin-api/system/sms-channel/simple-list` | 获得短信渠道精简列表 | `SmsChannel_getSimpleSmsChannelList` |
| 管理后台 - 短信渠道 | PUT | `/admin-api/system/sms-channel/update` | 更新短信渠道 | `SmsChannel_updateSmsChannel` |
| 管理后台 - 示例分类 | POST | `/admin-api/infra/demo02-category/create` | 创建示例分类 | `Demo02Category_createDemo02Category` |
| 管理后台 - 示例分类 | DELETE | `/admin-api/infra/demo02-category/delete` | 删除示例分类 | `Demo02Category_deleteDemo02Category` |
| 管理后台 - 示例分类 | GET | `/admin-api/infra/demo02-category/export-excel` | 导出示例分类 Excel | `Demo02Category_exportDemo02CategoryExcel` |
| 管理后台 - 示例分类 | GET | `/admin-api/infra/demo02-category/get` | 获得示例分类 | `Demo02Category_getDemo02Category` |
| 管理后台 - 示例分类 | GET | `/admin-api/infra/demo02-category/list` | 获得示例分类列表 | `Demo02Category_getDemo02CategoryList` |
| 管理后台 - 示例分类 | PUT | `/admin-api/infra/demo02-category/update` | 更新示例分类 | `Demo02Category_updateDemo02Category` |
| 管理后台 - 示例联系人 | POST | `/admin-api/infra/demo01-contact/create` | 创建示例联系人 | `Demo01Contact_createDemo01Contact` |
| 管理后台 - 示例联系人 | DELETE | `/admin-api/infra/demo01-contact/delete` | 删除示例联系人 | `Demo01Contact_deleteDemo01Contact` |
| 管理后台 - 示例联系人 | DELETE | `/admin-api/infra/demo01-contact/delete-list` | 批量删除示例联系人 | `Demo01Contact_deleteDemo0iContactList` |
| 管理后台 - 示例联系人 | GET | `/admin-api/infra/demo01-contact/export-excel` | 导出示例联系人 Excel | `Demo01Contact_exportDemo01ContactExcel` |
| 管理后台 - 示例联系人 | GET | `/admin-api/infra/demo01-contact/get` | 获得示例联系人 | `Demo01Contact_getDemo01Contact` |
| 管理后台 - 示例联系人 | GET | `/admin-api/infra/demo01-contact/page` | 获得示例联系人分页 | `Demo01Contact_getDemo01ContactPage` |
| 管理后台 - 示例联系人 | PUT | `/admin-api/infra/demo01-contact/update` | 更新示例联系人 | `Demo01Contact_updateDemo01Contact` |
| 管理后台 - 社交客户端 | POST | `/admin-api/system/social-client/create` | 创建社交客户端 | `SocialClient_createSocialClient` |
| 管理后台 - 社交客户端 | DELETE | `/admin-api/system/social-client/delete` | 删除社交客户端 | `SocialClient_deleteSocialClient` |
| 管理后台 - 社交客户端 | DELETE | `/admin-api/system/social-client/delete-list` | 批量删除社交客户端 | `SocialClient_deleteSocialClientList` |
| 管理后台 - 社交客户端 | GET | `/admin-api/system/social-client/get` | 获得社交客户端 | `SocialClient_getSocialClient` |
| 管理后台 - 社交客户端 | GET | `/admin-api/system/social-client/page` | 获得社交客户端分页 | `SocialClient_getSocialClientPage` |
| 管理后台 - 社交客户端 | POST | `/admin-api/system/social-client/send-subscribe-message` | 发送订阅消息 | `SocialClient_sendSubscribeMessage` |
| 管理后台 - 社交客户端 | PUT | `/admin-api/system/social-client/update` | 更新社交客户端 | `SocialClient_updateSocialClient` |
| 管理后台 - 社交用户 | POST | `/admin-api/system/social-user/bind` | 社交绑定，使用 code 授权码 | `SocialUser_socialBind` |
| 管理后台 - 社交用户 | GET | `/admin-api/system/social-user/get` | 获得社交用户 | `SocialUser_getSocialUser` |
| 管理后台 - 社交用户 | GET | `/admin-api/system/social-user/get-bind-list` | 获得绑定社交用户列表 | `SocialUser_getBindSocialUserList` |
| 管理后台 - 社交用户 | GET | `/admin-api/system/social-user/page` | 获得社交用户分页 | `SocialUser_getSocialUserPage` |
| 管理后台 - 社交用户 | DELETE | `/admin-api/system/social-user/unbind` | 取消社交绑定 | `SocialUser_socialUnbind` |
| 管理后台 - 租户 | POST | `/admin-api/system/tenant/create` | 创建租户 | `Tenant_createTenant` |
| 管理后台 - 租户 | DELETE | `/admin-api/system/tenant/delete` | 删除租户 | `Tenant_deleteTenant` |
| 管理后台 - 租户 | DELETE | `/admin-api/system/tenant/delete-list` | 批量删除租户 | `Tenant_deleteTenantList` |
| 管理后台 - 租户 | GET | `/admin-api/system/tenant/export-excel` | 导出租户 Excel | `Tenant_exportTenantExcel` |
| 管理后台 - 租户 | GET | `/admin-api/system/tenant/get` | 获得租户 | `Tenant_getTenant` |
| 管理后台 - 租户 | GET | `/admin-api/system/tenant/get-by-website` | 使用域名，获得租户信息 | `Tenant_getTenantByWebsite` |
| 管理后台 - 租户 | GET | `/admin-api/system/tenant/get-id-by-name` | 使用租户名，获得租户编号 | `Tenant_getTenantIdByName` |
| 管理后台 - 租户 | GET | `/admin-api/system/tenant/page` | 获得租户分页 | `Tenant_getTenantPage` |
| 管理后台 - 租户 | GET | `/admin-api/system/tenant/simple-list` | 获取租户精简信息列表 | `Tenant_getTenantSimpleList` |
| 管理后台 - 租户 | PUT | `/admin-api/system/tenant/update` | 更新租户 | `Tenant_updateTenant` |
| 管理后台 - 租户套餐 | POST | `/admin-api/system/tenant-package/create` | 创建租户套餐 | `TenantPackage_createTenantPackage` |
| 管理后台 - 租户套餐 | DELETE | `/admin-api/system/tenant-package/delete` | 删除租户套餐 | `TenantPackage_deleteTenantPackage` |
| 管理后台 - 租户套餐 | DELETE | `/admin-api/system/tenant-package/delete-list` | 批量删除租户套餐 | `TenantPackage_deleteTenantPackageList` |
| 管理后台 - 租户套餐 | GET | `/admin-api/system/tenant-package/get` | 获得租户套餐 | `TenantPackage_getTenantPackage` |
| 管理后台 - 租户套餐 | GET | `/admin-api/system/tenant-package/get-simple-list` | 获取租户套餐精简信息列表 | `TenantPackage_getTenantPackageList` |
| 管理后台 - 租户套餐 | GET | `/admin-api/system/tenant-package/page` | 获得租户套餐分页 | `TenantPackage_getTenantPackagePage` |
| 管理后台 - 租户套餐 | GET | `/admin-api/system/tenant-package/simple-list` | 获取租户套餐精简信息列表 | `TenantPackage_getTenantPackageList_1` |
| 管理后台 - 租户套餐 | PUT | `/admin-api/system/tenant-package/update` | 更新租户套餐 | `TenantPackage_updateTenantPackage` |
| 管理后台 - 站内信模版 | POST | `/admin-api/system/notify-template/create` | 创建站内信模版 | `NotifyTemplate_createNotifyTemplate` |
| 管理后台 - 站内信模版 | DELETE | `/admin-api/system/notify-template/delete` | 删除站内信模版 | `NotifyTemplate_deleteNotifyTemplate` |
| 管理后台 - 站内信模版 | DELETE | `/admin-api/system/notify-template/delete-list` | 批量删除站内信模版 | `NotifyTemplate_deleteNotifyTemplateList` |
| 管理后台 - 站内信模版 | GET | `/admin-api/system/notify-template/get` | 获得站内信模版 | `NotifyTemplate_getNotifyTemplate` |
| 管理后台 - 站内信模版 | GET | `/admin-api/system/notify-template/page` | 获得站内信模版分页 | `NotifyTemplate_getNotifyTemplatePage` |
| 管理后台 - 站内信模版 | POST | `/admin-api/system/notify-template/send-notify` | 发送站内信 | `NotifyTemplate_sendNotify` |
| 管理后台 - 站内信模版 | PUT | `/admin-api/system/notify-template/update` | 更新站内信模版 | `NotifyTemplate_updateNotifyTemplate` |
| 管理后台 - 联系我们数据 | POST | `/admin-api/jh/contact-us/create` | 创建联系我们数据 | `ContactUs_createContactUs` |
| 管理后台 - 联系我们数据 | DELETE | `/admin-api/jh/contact-us/delete` | 删除联系我们数据 | `ContactUs_deleteContactUs` |
| 管理后台 - 联系我们数据 | DELETE | `/admin-api/jh/contact-us/delete-list` | 批量删除联系我们数据 | `ContactUs_deleteContactUsList` |
| 管理后台 - 联系我们数据 | GET | `/admin-api/jh/contact-us/export-excel` | 导出联系我们数据 Excel | `ContactUs_exportContactUsExcel` |
| 管理后台 - 联系我们数据 | GET | `/admin-api/jh/contact-us/get` | 获得联系我们数据 | `ContactUs_getContactUs` |
| 管理后台 - 联系我们数据 | GET | `/admin-api/jh/contact-us/get-import-template` | 获得导入联系我们数据模板 | `ContactUs_getImportTemplate` |
| 管理后台 - 联系我们数据 | POST | `/admin-api/jh/contact-us/import-excel` | 导入联系我们数据Excel | `ContactUs_importContactUsExcel` |
| 管理后台 - 联系我们数据 | GET | `/admin-api/jh/contact-us/page` | 获得联系我们数据分页 | `ContactUs_getContactUsPage` |
| 管理后台 - 联系我们数据 | PUT | `/admin-api/jh/contact-us/update` | 更新联系我们数据 | `ContactUs_updateContactUs` |
| 管理后台 - 菜单 | POST | `/admin-api/system/menu/create` | 创建菜单 | `Menu_createMenu` |
| 管理后台 - 菜单 | DELETE | `/admin-api/system/menu/delete` | 删除菜单 | `Menu_deleteMenu` |
| 管理后台 - 菜单 | DELETE | `/admin-api/system/menu/delete-list` | 批量删除菜单 | `Menu_deleteMenuList` |
| 管理后台 - 菜单 | GET | `/admin-api/system/menu/get` | 获取菜单信息 | `Menu_getMenu` |
| 管理后台 - 菜单 | GET | `/admin-api/system/menu/list` | 获取菜单列表 | `Menu_getMenuList` |
| 管理后台 - 菜单 | GET | `/admin-api/system/menu/list-all-simple` | 获取菜单精简信息列表 | `Menu_getSimpleMenuList` |
| 管理后台 - 菜单 | GET | `/admin-api/system/menu/simple-list` | 获取菜单精简信息列表 | `Menu_getSimpleMenuList_1` |
| 管理后台 - 菜单 | PUT | `/admin-api/system/menu/update` | 修改菜单 | `Menu_updateMenu` |
| 管理后台 - 角色 | POST | `/admin-api/system/role/create` | 创建角色 | `Role_createRole` |
| 管理后台 - 角色 | DELETE | `/admin-api/system/role/delete` | 删除角色 | `Role_deleteRole` |
| 管理后台 - 角色 | DELETE | `/admin-api/system/role/delete-list` | 批量删除角色 | `Role_deleteRoleList` |
| 管理后台 - 角色 | GET | `/admin-api/system/role/export-excel` | 导出角色 Excel | `Role_export` |
| 管理后台 - 角色 | GET | `/admin-api/system/role/get` | 获得角色信息 | `Role_getRole` |
| 管理后台 - 角色 | GET | `/admin-api/system/role/list-all-simple` | 获取角色精简信息列表 | `Role_getSimpleRoleList` |
| 管理后台 - 角色 | GET | `/admin-api/system/role/page` | 获得角色分页 | `Role_getRolePage` |
| 管理后台 - 角色 | GET | `/admin-api/system/role/simple-list` | 获取角色精简信息列表 | `Role_getSimpleRoleList_1` |
| 管理后台 - 角色 | PUT | `/admin-api/system/role/update` | 修改角色 | `Role_updateRole` |
| 管理后台 - 订单 | PUT | `/admin-api/jh/order/cancel` | 取消订单 | `Order_cancelOrder` |
| 管理后台 - 订单 | GET | `/admin-api/jh/order/count` | 查询各状态订单数量 | `Order_getOrderCount` |
| 管理后台 - 订单 | GET | `/admin-api/jh/order/export-excel` | 导出订单 Excel | `Order_exportOrderExcel` |
| 管理后台 - 订单 | GET | `/admin-api/jh/order/get` | 获得订单 | `Order_getOrder` |
| 管理后台 - 订单 | GET | `/admin-api/jh/order/page` | 获得订单分页 | `Order_getOrderPage` |
| 管理后台 - 订单 | PUT | `/admin-api/jh/order/set-remark` | 设置订单备注 | `Order_updateOrderRemark` |
| 管理后台 - 认证 | GET | `/admin-api/system/auth/get-permission-info` | 获取登录用户的权限信息 | `Auth_getPermissionInfo` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/login` | 使用账号密码登录 | `Auth_login` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/login-dev` | 使用账号密码登录 | `Auth_loginDev` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/logout` | 登出系统 | `Auth_logout` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/refresh-token` | 刷新令牌 | `Auth_refreshToken` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/register` | 注册用户 | `Auth_register` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/reset-password` | 重置密码 | `Auth_resetPassword` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/send-sms-code` | 发送手机验证码 | `Auth_sendLoginSmsCode` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/sms-login` | 使用短信验证码登录 | `Auth_smsLogin` |
| 管理后台 - 认证 | GET | `/admin-api/system/auth/social-auth-redirect` | 社交授权的跳转 | `Auth_socialLogin` |
| 管理后台 - 认证 | POST | `/admin-api/system/auth/social-login` | 社交快捷登录，使用 code 授权码 | `Auth_socialQuickLogin` |
| 管理后台 - 路由 | POST | `/admin-api/jh/route/create` | 创建路由 | `Route_createRoute` |
| 管理后台 - 路由 | DELETE | `/admin-api/jh/route/delete` | 删除路由 | `Route_deleteRoute` |
| 管理后台 - 路由 | DELETE | `/admin-api/jh/route/delete-list` | 批量删除路由 | `Route_deleteRouteList` |
| 管理后台 - 路由 | GET | `/admin-api/jh/route/export-excel` | 导出路由 Excel | `Route_exportRouteExcel` |
| 管理后台 - 路由 | GET | `/admin-api/jh/route/get` | 获得路由 | `Route_getRoute` |
| 管理后台 - 路由 | GET | `/admin-api/jh/route/get-import-template` | 获得导入路由模板 | `Route_getImportTemplate` |
| 管理后台 - 路由 | POST | `/admin-api/jh/route/import-excel` | 导入路由Excel | `Route_importRouteExcel` |
| 管理后台 - 路由 | GET | `/admin-api/jh/route/page` | 获得路由分页 | `Route_getRoutePage` |
| 管理后台 - 路由 | PUT | `/admin-api/jh/route/update` | 更新路由 | `Route_updateRoute` |
| 管理后台 - 运费模板信息 | POST | `/admin-api/jh/shipping-template/create` | 创建运费模板信息 | `ShippingTemplate_createShippingTemplate` |
| 管理后台 - 运费模板信息 | DELETE | `/admin-api/jh/shipping-template/delete` | 删除运费模板信息 | `ShippingTemplate_deleteShippingTemplate` |
| 管理后台 - 运费模板信息 | DELETE | `/admin-api/jh/shipping-template/delete-list` | 批量删除运费模板信息 | `ShippingTemplate_deleteShippingTemplateList` |
| 管理后台 - 运费模板信息 | GET | `/admin-api/jh/shipping-template/get-detail` | ***获得运费模板详情（含规则与子表） | `ShippingTemplate_getShippingTemplateDetail` |
| 管理后台 - 运费模板信息 | GET | `/admin-api/jh/shipping-template/page` | ***获得运费模板信息分页 | `ShippingTemplate_getShippingTemplatePage` |
| 管理后台 - 运费模板信息 | POST | `/admin-api/jh/shipping-template/save-with-children` | 保存运费模板信息（含规则与子表） | `ShippingTemplate_saveShippingTemplateWithChildren` |
| 管理后台 - 运费模板信息 | GET | `/admin-api/jh/shipping-template/shipping-rule/list-by-shipping-template-id` | 获得运费规则列表 | `ShippingTemplate_getShippingRuleListByShippingTemplateId` |
| 管理后台 - 运费模板信息 | PUT | `/admin-api/jh/shipping-template/update` | 更新运费模板信息 | `ShippingTemplate_updateShippingTemplate` |
| 管理后台 - 通知公告 | POST | `/admin-api/system/notice/create` | 创建通知公告 | `Notice_createNotice` |
| 管理后台 - 通知公告 | DELETE | `/admin-api/system/notice/delete` | 删除通知公告 | `Notice_deleteNotice` |
| 管理后台 - 通知公告 | DELETE | `/admin-api/system/notice/delete-list` | 批量删除通知公告 | `Notice_deleteNoticeList` |
| 管理后台 - 通知公告 | GET | `/admin-api/system/notice/get` | 获得通知公告 | `Notice_getNotice` |
| 管理后台 - 通知公告 | GET | `/admin-api/system/notice/page` | 获取通知公告列表 | `Notice_getNoticePage` |
| 管理后台 - 通知公告 | POST | `/admin-api/system/notice/push` | 推送通知公告 | `Notice_push` |
| 管理后台 - 通知公告 | PUT | `/admin-api/system/notice/update` | 修改通知公告 | `Notice_updateNotice` |
| 管理后台 - 邮件日志 | GET | `/admin-api/system/mail-log/get` | 获得邮箱日志 | `MailLog_getMailTemplate` |
| 管理后台 - 邮件日志 | GET | `/admin-api/system/mail-log/page` | 获得邮箱日志分页 | `MailLog_getMailLogPage` |
| 管理后台 - 邮件模版 | POST | `/admin-api/system/mail-template/create` | 创建邮件模版 | `MailTemplate_createMailTemplate` |
| 管理后台 - 邮件模版 | DELETE | `/admin-api/system/mail-template/delete` | 删除邮件模版 | `MailTemplate_deleteMailTemplate` |
| 管理后台 - 邮件模版 | DELETE | `/admin-api/system/mail-template/delete-list` | 批量删除邮件模版 | `MailTemplate_deleteMailTemplateList` |
| 管理后台 - 邮件模版 | GET | `/admin-api/system/mail-template/get` | 获得邮件模版 | `MailTemplate_getMailTemplate` |
| 管理后台 - 邮件模版 | GET | `/admin-api/system/mail-template/list-all-simple` | 获得邮件模版精简列表 | `MailTemplate_getSimpleTemplateList` |
| 管理后台 - 邮件模版 | GET | `/admin-api/system/mail-template/page` | 获得邮件模版分页 | `MailTemplate_getMailTemplatePage` |
| 管理后台 - 邮件模版 | POST | `/admin-api/system/mail-template/send-mail` | 发送邮件 | `MailTemplate_sendMail` |
| 管理后台 - 邮件模版 | GET | `/admin-api/system/mail-template/simple-list` | 获得邮件模版精简列表 | `MailTemplate_getSimpleTemplateList_1` |
| 管理后台 - 邮件模版 | PUT | `/admin-api/system/mail-template/update` | 修改邮件模版 | `MailTemplate_updateMailTemplate` |
| 管理后台 - 邮箱账号 | POST | `/admin-api/system/mail-account/create` | 创建邮箱账号 | `MailAccount_createMailAccount` |
| 管理后台 - 邮箱账号 | DELETE | `/admin-api/system/mail-account/delete` | 删除邮箱账号 | `MailAccount_deleteMailAccount` |
| 管理后台 - 邮箱账号 | DELETE | `/admin-api/system/mail-account/delete-list` | 批量删除邮箱账号 | `MailAccount_deleteMailAccountList` |
| 管理后台 - 邮箱账号 | GET | `/admin-api/system/mail-account/get` | 获得邮箱账号 | `MailAccount_getMailAccount` |
| 管理后台 - 邮箱账号 | GET | `/admin-api/system/mail-account/list-all-simple` | 获得邮箱账号精简列表 | `MailAccount_getSimpleMailAccountList` |
| 管理后台 - 邮箱账号 | GET | `/admin-api/system/mail-account/page` | 获得邮箱账号分页 | `MailAccount_getMailAccountPage` |
| 管理后台 - 邮箱账号 | GET | `/admin-api/system/mail-account/simple-list` | 获得邮箱账号精简列表 | `MailAccount_getSimpleMailAccountList_1` |
| 管理后台 - 邮箱账号 | PUT | `/admin-api/system/mail-account/update` | 修改邮箱账号 | `MailAccount_updateMailAccount` |
| 管理后台 - 部门 | POST | `/admin-api/system/dept/create` | 创建部门 | `Dept_createDept` |
| 管理后台 - 部门 | DELETE | `/admin-api/system/dept/delete` | 删除部门 | `Dept_deleteDept` |
| 管理后台 - 部门 | DELETE | `/admin-api/system/dept/delete-list` | 批量删除部门 | `Dept_deleteDeptList` |
| 管理后台 - 部门 | GET | `/admin-api/system/dept/get` | 获得部门信息 | `Dept_getDept` |
| 管理后台 - 部门 | GET | `/admin-api/system/dept/list` | 获取部门列表 | `Dept_getDeptList` |
| 管理后台 - 部门 | GET | `/admin-api/system/dept/list-all-simple` | 获取部门精简信息列表 | `Dept_getSimpleDeptList` |
| 管理后台 - 部门 | GET | `/admin-api/system/dept/simple-list` | 获取部门精简信息列表 | `Dept_getSimpleDeptList_1` |
| 管理后台 - 部门 | PUT | `/admin-api/system/dept/update` | 更新部门 | `Dept_updateDept` |
| 管理后台 - 链接 | POST | `/admin-api/jh/landing-page-tracker/create` | 创建链接 | `LandingPageTracker_createLandingPageTracker` |
| 管理后台 - 链接 | DELETE | `/admin-api/jh/landing-page-tracker/delete` | 删除链接 | `LandingPageTracker_deleteLandingPageTracker` |
| 管理后台 - 链接 | DELETE | `/admin-api/jh/landing-page-tracker/delete-list` | 批量删除链接 | `LandingPageTracker_deleteLandingPageTrackerList` |
| 管理后台 - 链接 | GET | `/admin-api/jh/landing-page-tracker/export-detail-excel` | 导出引流统计明细 Excel | `LandingPageTracker_exportLandingPageTrackerDetailExcel` |
| 管理后台 - 链接 | GET | `/admin-api/jh/landing-page-tracker/export-excel` | 导出引流统计列表 Excel | `LandingPageTracker_exportLandingPageTrackerExcel` |
| 管理后台 - 链接 | GET | `/admin-api/jh/landing-page-tracker/get` | 获得链接 | `LandingPageTracker_getLandingPageTracker` |
| 管理后台 - 链接 | GET | `/admin-api/jh/landing-page-tracker/page` | 获得链接分页 | `LandingPageTracker_getLandingPageTrackerPage` |
| 管理后台 - 领星订单同步调试 | GET | `/admin-api/admin-api/jh/lingxing-sync/execute` | 手动触发领星订单同步 | `LingXingOrderSync_execute` |
| 管理后台 - 领星订单同步调试 | GET | `/admin-api/admin-api/jh/lingxing-sync/execute/autocompilte` | 手动触发自动完成订单同步 | `LingXingOrderSync_executeAuto` |
| 管理后台 - 领星订单同步调试 | GET | `/admin-api/admin-api/jh/lingxing-sync/execute/paypal-retry` | 手动触发PayPal物流推送补偿任务 | `LingXingOrderSync_executePayPalRetry` |
| 管理后台 - 验证码 | POST | `/admin-api/system/captcha/check` | 校验验证码 | `Captcha_check` |
| 管理后台 - 验证码 | POST | `/admin-api/system/captcha/get` | 获得验证码 | `Captcha_get` |

## 接口详情

## C端 - APP版本

### 1. 获取APP版本列表

- 分组：C端 - APP版本
- 请求方式：`GET`
- 接口路径：`/web-api/jh/web/appversion/page`
- operationId：`WebAppversion_getAppversionPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| storeName | query | 否 | string | 应用商店 | 王五 |
| version | query | 否 | string | 版本号 |  |
| downloadUrl | query | 否 | string | 商城下载地址 | https://www.iocoder.cn |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAppversionRespVO` |

## C端 - FAQ

### 1. 获得FAQ分类树

- 分组：C端 - FAQ
- 请求方式：`GET`
- 接口路径：`/web-api/jh/faq/cate-list`
- operationId：`WebFaq_getFaqCateTree`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| lang | query | 是 | string | 语言 | en |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListFaqCateSimpleRespVO` |

### 2. 获得FAQ列表

- 分组：C端 - FAQ
- 请求方式：`GET`
- 接口路径：`/web-api/jh/faq/list`
- operationId：`WebFaq_getFaqList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| faqCateId | query | 否 | integer | 分类ID | 29870 |
| isHot | query | 否 | integer | 是否热门（0否，1是） | 1 |
| lang | query | 否 | string | 语言 | en |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListFaqRespVO` |

## C端 - FAQ联系我们

### 1. 提交FAQ联系信息

- 分组：C端 - FAQ联系我们
- 请求方式：`POST`
- 接口路径：`/web-api/jh/faq-contact-us/create`
- operationId：`WebFaqContactUs_createFaqContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FaqContactUsCreateReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| name | 姓名 | 是 | string | Tom |
| email | 邮箱 | 是 | string | tom@example.com |
| toyOrderNumber | 玩具订单号 | 是 | string | TOY123456 |
| questionType | 问题类型 | 是 | string | order |
| questionDetail | 问题详情 | 否 | string | Where is my order? |
| files | 图片或视频 | 否 | array[JhFileDO] |  |
| lang | 语言 | 否 | string | en |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

## C端 - blog信息

### 1. 获得blog详情

- 分组：C端 - blog信息
- 请求方式：`GET`
- 接口路径：`/web-api/jh/blog/get-detail`
- operationId：`WebBlog_getBlog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBlogRespVO` |

### 2. 获得blog下一条

- 分组：C端 - blog信息
- 请求方式：`GET`
- 接口路径：`/web-api/jh/blog/get-next`
- operationId：`WebBlog_getBlogNext`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 主键 | 25673 |
| cateId | query | 否 | integer | blog分类 ID 列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBlogRespVO` |

### 3. 获得blog管理分页

- 分组：C端 - blog信息
- 请求方式：`GET`
- 接口路径：`/web-api/jh/blog/page`
- operationId：`WebBlog_getBlogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateId | query | 否 | integer | 分类id |  |
| code | query | 否 | string | 编号 |  |
| title | query | 否 | string | 标题 |  |
| status | query | 否 | integer | 状态 | 1 |
| id | query | 否 | integer | 编号 | 1 |
| creator | query | 否 | integer | 创建者ID |  |
| newTime | query | 否 | string |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultBlogRespVO` |

## C端 - blog分类

### 1. 获得blog分类列表

- 分组：C端 - blog分类
- 请求方式：`GET`
- 接口路径：`/web-api/jh/blog-cate/list`
- operationId：`WebBlogCate_getBlogCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListBlogCateRespVO` |

## C端 - news分类

### 1. 获得news分类列表

- 分组：C端 - news分类
- 请求方式：`GET`
- 接口路径：`/web-api/jh/news-cate/list`
- operationId：`WebNewsCate_getNewsCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListNewsCateRespVO` |

## C端 - news管理

### 1. 获得news详情

- 分组：C端 - news管理
- 请求方式：`GET`
- 接口路径：`/web-api/jh/news/get-detail`
- operationId：`WebNews_getBlog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNewsRespVO` |

### 2. 获得news下一条

- 分组：C端 - news管理
- 请求方式：`GET`
- 接口路径：`/web-api/jh/news/get-next`
- operationId：`WebNews_getBlogNext`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 主键 | 25673 |
| cateId | query | 否 | integer | blog分类 ID 列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNewsRespVO` |

### 3. 获得news管理分页

- 分组：C端 - news管理
- 请求方式：`GET`
- 接口路径：`/web-api/jh/news/page`
- operationId：`WebNews_getBlogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateId | query | 否 | integer | 分类id |  |
| code | query | 否 | string | 编号 |  |
| title | query | 否 | string | 标题 |  |
| status | query | 否 | integer | 状态 | 2 |
| id | query | 否 | integer | 编号 | 1 |
| creator | query | 否 | integer | 创建者ID |  |
| newTime | query | 否 | string |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultNewsRespVO` |

## C端 - 二维码访问统计

### 1. 获取二维码信息

- 分组：C端 - 二维码访问统计
- 请求方式：`GET`
- 接口路径：`/web-api/jh/download-qrcode/get`
- operationId：`WebDownloadQrcode_getByCode`
- 描述：根据code获取二维码的基础信息

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultWebDownloadQrcodeRespVO` |

### 2. 增加二维码访问/点击次数

- 分组：C端 - 二维码访问统计
- 请求方式：`POST`
- 接口路径：`/web-api/jh/download-qrcode/increment`
- operationId：`WebDownloadQrcode_incrementCount`
- 描述：根据code增加对应类型的计数，用于埋点

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`WebDownloadQrcodeIncrementReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| code | 二维码编码 | 是 | string | ABC123 |
| visitCount | 是否增加访问次数 | 否 | boolean |  |
| clickCount | 是否增加总点击次数 | 否 | boolean |  |
| iosClickCount | 是否增加IOS点击次数 | 否 | boolean |  |
| googleClickCount | 是否增加谷歌点击次数 | 否 | boolean |  |
| apkClickCount | 是否增加APK点击次数 | 否 | boolean |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## C端 - 产品

### 1. 产品详情

- 分组：C端 - 产品
- 请求方式：`GET`
- 接口路径：`/web-api/jh/product/get`
- operationId：`WebProduct_getProduct`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| route | query | 是 | string | 产品跳转路由 |  |
| countryCode | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultWebProductRespVO` |

### 2. 获得产品分页

- 分组：C端 - 产品
- 请求方式：`GET`
- 接口路径：`/web-api/jh/product/page`
- operationId：`WebProduct_getProductPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productCateId | query | 是 | integer | 产品分类ID |  |
| countryCode | query | 是 | string | 国家编码 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultWebProductPageRespVO` |

## C端 - 产品分类

### 1. 获得产品分类列表

- 分组：C端 - 产品分类
- 请求方式：`GET`
- 接口路径：`/web-api/jh/product-cate/list`
- operationId：`WebProductCate_getProductCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateType | query | 是 | integer | 类型（普通产品=1，积分产品=2） | 2 |
| status | query | 否 | integer | 状态（1启用，2停用） | 2 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListWebProductCateRespVO` |

## C端 - 产品结算

### 1. 获取积分结算信息

- 分组：C端 - 产品结算
- 请求方式：`GET`
- 接口路径：`/web-api/jh/settlement/points/settlement`
- operationId：`WebSettlement_getProductPointsSettlement`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productSkuId | query | 否 | string | 商品 SKU ID |  |
| num | query | 否 | integer | 商品数量 |  |
| countryCode | query | 否 | string | 国家编码 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultWebProductPointsSettlementRespVO` |

### 2. 纯积分结算提交订单

- 分组：C端 - 产品结算
- 请求方式：`POST`
- 接口路径：`/web-api/jh/settlement/points/submit`
- operationId：`WebSettlement_submitProductPointsSettlement`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`WebProductPointsSettlementSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| productSkuId | 商品 SKU ID | 否 | string |  |
| num | 商品数量 | 否 | integer |  |
| countryCode | 国家编码 | 否 | string |  |
| recipientName | 收件人姓名 | 是 | string |  |
| recipientPhone | 收件人手机 | 是 | string |  |
| provinceState | 省/州 | 否 | string |  |
| city | 市 | 是 | string |  |
| district | 区/县 | 否 | string |  |
| postalCode | 邮编 | 是 | string |  |
| houseNumber | 门牌号 | 否 | string |  |
| address1 | 地址1 | 是 | string |  |
| address2 | 地址2 | 否 | string |  |
| userRemark | 用户备注 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

## C端 - 协议

### 1. 获得协议

- 分组：C端 - 协议
- 请求方式：`GET`
- 接口路径：`/web-api/jh/agreement/get`
- operationId：`WebAgreement_getAgreement`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAgreementRespVO` |

### 2. 获得协议分页

- 分组：C端 - 协议
- 请求方式：`GET`
- 接口路径：`/web-api/jh/agreement/page`
- operationId：`WebAgreement_getAgreementPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| terminal | query | 是 | string | 终端(1web 2app) |  |
| type | query | 是 | integer | 类型（1隐私协议 2用户协议） | 2 |
| lang | query | 是 | string | 语言 (en 英语 de 德语 ja 日语) | en |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAgreementRespVO` |

## C端 - 合作联系

### 1. 提交合作联系信息

- 分组：C端 - 合作联系
- 请求方式：`POST`
- 接口路径：`/web-api/jh/cooperation/create`
- operationId：`WebCooperation_createCooperation`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CooperationCreateReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| name | 姓名 | 是 | string | Tom |
| email | 邮箱 | 是 | string | tom@example.com |
| address | 公司名称或地址 | 是 | string | Berlin |
| cooperationType | 合作类型 | 是 | string | business |
| cooperationDetail | 合作详情 | 否 | string | I want to cooperate with you |
| lang | 语言 | 否 | string | en |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

## C端 - 售后

### 1. 提交售后

- 分组：C端 - 售后
- 请求方式：`POST`
- 接口路径：`/web-api/jh/order-after-sale/create`
- operationId：`WebOrderAfterSale_createOrderAfterSale`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`WebOrderAfterSaleSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| orderId | 订单ID | 是 | integer |  |
| orderItemId | 订单商品ID | 是 | array[integer] |  |
| evidence | 凭证图片或视频 | 是 | array[Evidence] |  |
| email | 申请人邮箱 | 是 | string |  |
| phone | 电话号码 | 否 | string |  |
| productIssues | 产品问题 | 是 | string |  |
| deviceId | 设备ID | 是 | string |  |
| tenantId |  | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 售后详情

- 分组：C端 - 售后
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order-after-sale/get`
- operationId：`WebOrderAfterSale_getOrderAfterSale`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultWebOrderAfterRespVO` |

### 3. 同步oa售后数据

- 分组：C端 - 售后
- 请求方式：`POST`
- 接口路径：`/web-api/jh/order-after-sale/sync-oa`
- operationId：`WebOrderAfterSale_syncOrderAfterSaleFromOA`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OAOrderAfterRespVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| list | 申请人账号 | 否 | array[OAOrderAfterInfo] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 提供给OA接收售后信息变化

- 分组：C端 - 售后
- 请求方式：`POST`
- 接口路径：`/web-api/jh/order-after-sale/update`
- operationId：`WebOrderAfterSale_updateOrderAfterSale`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`array[WebOAOrderAfterReqVO]`

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## C端 - 售后政策

### 1. 获得售后政策

- 分组：C端 - 售后政策
- 请求方式：`GET`
- 接口路径：`/web-api/jh/after-sales-policy/get`
- operationId：`WebAfterSalesPolicy_getAfterSalesPolicy`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAfterSalesPolicyRespVO` |

### 2. 获得售后政策分页

- 分组：C端 - 售后政策
- 请求方式：`GET`
- 接口路径：`/web-api/jh/after-sales-policy/page`
- operationId：`WebAfterSalesPolicy_getAfterSalesPolicyPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| brandId | query | 否 | integer | 品牌ID | 9150 |
| title | query | 否 | string | 标题 |  |
| content | query | 否 | string | 内容 |  |
| lang | query | 否 | string | 语言 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAfterSalesPolicyRespVO` |

## C端 - 售后政策-品牌

### 1. 获得售后政策-品牌

- 分组：C端 - 售后政策-品牌
- 请求方式：`GET`
- 接口路径：`/web-api/jh/after-sales-brand/get`
- operationId：`WebAfterSalesBrand_getAfterSalesBrand`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAfterSalesBrandRespVO` |

### 2. 获得售后政策-品牌分页

- 分组：C端 - 售后政策-品牌
- 请求方式：`GET`
- 接口路径：`/web-api/jh/after-sales-brand/page`
- operationId：`WebAfterSalesBrand_getAfterSalesBrandPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| brandName | query | 否 | string | 品牌名称 | Apple |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAfterSalesBrandRespVO` |

## C端 - 国家信息

### 1. 获取国家列表（启用状态）

- 分组：C端 - 国家信息
- 请求方式：`GET`
- 接口路径：`/web-api/jh/address-country/list`
- operationId：`WebAddressCountry_getCountryList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListWebAddressCountryListRespVO` |

## C端 - 埋点

### 1. 创建埋点记录

- 分组：C端 - 埋点
- 请求方式：`POST`
- 接口路径：`/web-api/jh/event-tracking/create`
- operationId：`WebEventTracking_createEventTracking`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`EventTrackingSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 自增主键，全局唯一标识 | 否 | integer | 15213 |
| eventName | 事件名称（如 login/click_order） | 是 | string | login |
| customerId | 登录用户唯一 ID | 否 | string | 6548 |
| ip | 客户端 IP 地址（支持 IPv4/IPv6） | 否 | string |  |
| anonymousId | 匿名用户唯一标识（未登录用户） | 否 | string | 22457 |
| sessionId | 会话标识（追踪单次会话行为） | 否 | string | 10867 |
| pageUrl | 完整访问 URL（含参数） | 否 | string | https://www.iocoder.cn |
| pagePath | 不含参数的页面路径 | 否 | string |  |
| pageType | 页面分类（如商品详情页） | 否 | string | 1 |
| referrer | 上一跳网址（用户进入当前页的前一页） | 否 | string |  |
| sourceChannel | 来源分类（如抖音/快手） | 否 | string |  |
| country | 国家代码（如 CN/US） | 否 | string |  |
| deviceType | 设备类型（限定为 mobile/desktop/tablet） | 否 | string | 2 |
| deviceId | 设备唯一 ID（如 IMEI/IDFA） | 否 | string | 949 |
| browser | 浏览器名称（如 Chrome/Safari） | 否 | string |  |
| os | 操作系统（如 iOS/Android） | 否 | string |  |
| locale | 访问语言（如 zh-CN/en-US） | 否 | string |  |
| utmSource | UTM 来源（如广告投放渠道） | 否 | string |  |
| utmAccount | UTM 账号来源 | 否 | string | 5452 |
| utmMedium | UTM 渠道/推广类型（如 email/social） | 否 | string |  |
| utmCampaign | UTM 活动标识（如 618 大促） | 否 | string |  |
| utmContent | UTM 内容标识（如广告创意） | 否 | string |  |
| campaignId | 内部活动 ID | 否 | string | 28818 |
| screenWidth | 屏幕宽度 | 否 | integer | 1920 |
| pageTitle | 页面标题 | 否 | string | Home Page |
| isEffective | 是否有效 | 否 | boolean | True |
| stayDuration | 停留时长（毫秒） | 否 | integer | 5000 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

## C端 - 基础数据-说明（售后/运费说明，售后问题）

### 1. 获得基础数据-说明

- 分组：C端 - 基础数据-说明（售后/运费说明，售后问题）
- 请求方式：`GET`
- 接口路径：`/web-api/jh/article/get`
- operationId：`WebArticle_getArticle`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultArticleRespVO` |

### 2. 获得基础数据-说明分页

- 分组：C端 - 基础数据-说明（售后/运费说明，售后问题）
- 请求方式：`GET`
- 接口路径：`/web-api/jh/article/page`
- operationId：`WebArticle_getArticlePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| articleType | query | 是 | string | 说明类型（数据字典配置） | about_us |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultArticleRespVO` |

## C端 - 我的订单

### 1. 取消订单

- 分组：C端 - 我的订单
- 请求方式：`PUT`
- 接口路径：`/web-api/jh/order/cancel`
- operationId：`ClientOrder_cancelOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OrderCancelReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 是 | integer | 1316 |
| cancelRemark | 取消订单备注 | 是 | string | 随便 |
| userId | 用户id | 否 | integer |  |
| itemDOList |  | 否 | array[OrderItemDO] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 捕获订单

- 分组：C端 - 我的订单
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order/capture`
- operationId：`ClientOrder_captureOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| paypalOrderId | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultCaptureRespVO` |

### 3. 重新计算运费和总价

- 分组：C端 - 我的订单
- 请求方式：`POST`
- 接口路径：`/web-api/jh/order/change-shipping-amount`
- operationId：`ClientOrder_changeShippingAmount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ShippingAmountReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| paypalOrderId | 支付订单号 | 是 | string |  |
| address | 地址 | 是 | AddressExtra |  |
| userId |  | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultShippingAmountRespVO` |

### 4. 查询各状态订单数量

- 分组：C端 - 我的订单
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order/count`
- operationId：`ClientOrder_getOrderCount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOrderCountRespVO` |

### 5. 创建订单

- 分组：C端 - 我的订单
- 请求方式：`POST`
- 接口路径：`/web-api/jh/order/creat`
- operationId：`ClientOrder_creatOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OrderCreatReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| customerId | 用户id | 否 | integer |  |
| userEmail | 用户邮箱 | 否 | string |  |
| orderType | 订单类型 | 是 | integer |  |
| isAnon | 是否匿名 | 是 | integer |  |
| orderNo | 订单号 | 否 | string |  |
| source | 订单来源：cart.购物车、product.单个产品 | 是 | string |  |
| status | 订单状态: 订单生成=created, 待发货=pending, 已发货待揽收=waiting_for_pickup, 部分发货=partial_shipped, 已发货=shipped, 售后中=after_sales, 交易完成=completed, 交易关闭=closed | 是 | string |  |
| couponCode | 优惠券码 | 否 | string |  |
| couponName | 优惠券名称 | 否 | string |  |
| discountId | 折扣id | 否 | integer |  |
| couponDiscountRate | 优惠券折扣率 | 否 | number |  |
| totalAmount | 订单总金额 | 是 | number |  |
| discountAmount | 优惠金额 | 是 | number |  |
| usePoints | 使用积分 | 是 | integer |  |
| shippingAmount | 运费 | 是 | number |  |
| actualAmount | 实际支付金额 | 是 | number |  |
| paymentTime | 支付时间 | 否 | string |  |
| deliverTime | 发货时间 | 否 | string |  |
| applyAftersaleTime | 申请售后时间 | 否 | string |  |
| returnTime | 申请退款时间 | 否 | string |  |
| completeTime | 完成时间（退款完成时间、订单完成时间） | 否 | string |  |
| userRemark | 用户备注 | 否 | string |  |
| sellerRemark | 商家备注 | 否 | string |  |
| cancelRemark | 取消订单备注 | 否 | string |  |
| paypalOrderId | paypal-订单ID | 否 | string |  |
| paypalSelfUrl | paypal-self链接 | 否 | string |  |
| paypalApproveUrl | paypal-approve链接 | 否 | string |  |
| paypalUpdateUrl | paypal-update链接 | 否 | string |  |
| paypalCaptureUrl | paypal-capture链接 | 否 | string |  |
| paypalStatus | paypal-状态 | 否 | string |  |
| lingxingGlobalOrderNo | 领星多平台订单编码 | 否 | string |  |
| lingxingOrderMessage | 领星平台订单提示 | 否 | string |  |
| deviceId | 设备ID | 是 | string |  |
| deptId | 部门ID | 否 | integer |  |
| userId | 用户id | 否 | integer |  |
| currencyCode | 币种编码 | 是 | string |  |
| paypalCaptureId | paypal捕获id | 否 | string |  |
| orderShipping | 订单运输信息 | 否 | OrderShippingDO |  |
| items | 订单商品 | 是 | array[OrderCreatItemReqVO] | 随便 |
| joyHubToken | joyHubToken | 否 | string |  |
| countryCode | 国家代码 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOrderDO` |

### 6. 导出订单 Excel

- 分组：C端 - 我的订单
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order/export-excel`
- operationId：`ClientOrder_exportOrderExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| isAnon | query | 否 | integer | 订单类型 | （游客支付=1，登录支付=2） |
| orderNo | query | 否 | string | 订单号 |  |
| statusList | query | 否 | array[string] | 订单状态 | 2 |
| productName | query | 否 | string | 商品名称 |  |
| userId | query | 否 | integer | 用户id |  |
| ids | query | 否 | array[integer] |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 获得订单

- 分组：C端 - 我的订单
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order/get`
- operationId：`ClientOrder_getOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOrderRespVO` |

### 8. 支付成功页订单详情产品信息

- 分组：C端 - 我的订单
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order/order-item`
- operationId：`ClientOrder_getOrderItemList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| orderId | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListOrderItemRespVO` |

### 9. 获得订单分页

- 分组：C端 - 我的订单
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order/page`
- operationId：`ClientOrder_getOrderPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| isAnon | query | 否 | integer | 订单类型 | （游客支付=1，登录支付=2） |
| orderNo | query | 否 | string | 订单号 |  |
| statusList | query | 否 | array[string] | 订单状态 | 2 |
| productName | query | 否 | string | 商品名称 |  |
| userId | query | 否 | integer | 用户id |  |
| ids | query | 否 | array[integer] |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultOrderRespVO` |

### 10. 设置订单备注

- 分组：C端 - 我的订单
- 请求方式：`PUT`
- 接口路径：`/web-api/jh/order/set-remark`
- operationId：`ClientOrder_updateOrderRemark`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OrderSetRemarkReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 是 | integer | 1316 |
| sellerRemark | 商家备注 | 是 | string |  |
| userId | 用户id | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 11. 查询状态列表

- 分组：C端 - 我的订单
- 请求方式：`GET`
- 接口路径：`/web-api/jh/order/status`
- operationId：`ClientOrder_getStatus`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListOrderStatusRespVO` |

## C端 - 支付页产品推荐

### 1. 获得支付页产品推荐分页

- 分组：C端 - 支付页产品推荐
- 请求方式：`GET`
- 接口路径：`/web-api/jh/product-payment-recommend/page`
- operationId：`WebProductPaymentRecommend_getProductPaymentRecommendPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultWebProductPaymentRecommendRespVO` |

## C端 - 文件存储

### 1. 创建文件

- 分组：C端 - 文件存储
- 请求方式：`POST`
- 接口路径：`/web-api/infra/file/create`
- operationId：`AppFile_createFile`
- 描述：模式二：前端上传文件：配合 presigned-url 接口，记录上传了上传的文件

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FileCreateReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| configId | 文件配置编号 | 是 | integer | 11 |
| path | 文件路径 | 是 | string | yudao.jpg |
| name | 原文件名 | 是 | string | yudao.jpg |
| url | 文件 URL | 是 | string | https://www.iocoder.cn/yudao.jpg |
| type | 文件 MIME 类型 | 否 | string | application/octet-stream |
| size | 文件大小 | 是 | integer | 2048 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 获取文件预签名地址（上传）

- 分组：C端 - 文件存储
- 请求方式：`GET`
- 接口路径：`/web-api/infra/file/presigned-url`
- operationId：`AppFile_getFilePresignedUrl`
- 描述：模式二：前端上传文件：用于前端直接上传七牛、阿里云 OSS 等文件存储器

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 是 | string | 文件名称 |  |
| directory | query | 否 | string | 文件目录 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFilePresignedUrlRespVO` |

### 3. 上传文件

- 分组：C端 - 文件存储
- 请求方式：`POST`
- 接口路径：`/web-api/infra/file/upload`
- operationId：`AppFile_uploadFile`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| directory | query | 否 | string | 文件目录 | XXX/YYY |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

## C端 - 点赞记录

### 1. 创建点赞记录

- 分组：C端 - 点赞记录
- 请求方式：`POST`
- 接口路径：`/web-api/jh/like-info/create`
- operationId：`LikeInfo_createLikeInfo`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`LikeInfoSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 26674 |
| type | 点赞数据类型1-new,2-blog | 是 | integer | 2 |
| dataId | 被点赞的数据id | 是 | integer | 13077 |
| deviceId | 点赞设备ID | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 取消点赞

- 分组：C端 - 点赞记录
- 请求方式：`POST`
- 接口路径：`/web-api/jh/like-info/delete`
- operationId：`LikeInfo_deleteLikeInfo`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`LikeInfoSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 26674 |
| type | 点赞数据类型1-new,2-blog | 是 | integer | 2 |
| dataId | 被点赞的数据id | 是 | integer | 13077 |
| deviceId | 点赞设备ID | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 获得点赞记录

- 分组：C端 - 点赞记录
- 请求方式：`GET`
- 接口路径：`/web-api/jh/like-info/get`
- operationId：`LikeInfo_getLikeInfo`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLikeInfoRespVO` |

### 4. 获得点赞记录分页

- 分组：C端 - 点赞记录
- 请求方式：`GET`
- 接口路径：`/web-api/jh/like-info/page`
- operationId：`LikeInfo_getLikeInfoPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | query | 否 | integer | 点赞数据类型new,blog | 2 |
| typeText | query | 否 | string | 点赞数据类型new,blog |  |
| dataId | query | 否 | integer | 被点赞的数据id | 16557 |
| dataCode | query | 否 | string | 被点赞的数据编码 |  |
| deviceId | query | 否 | string | 点赞设备ID | 1035 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 30926 |
| userId | query | 否 | integer | 权限用户ID | 9582 |
| custId | query | 否 | integer | 点赞app用户id | 20240 |
| nickName | query | 否 | string | 点赞app用户名称 | 李四 |
| email | query | 否 | string | 点赞app用户邮箱 |  |
| headImg | query | 否 | string | 点赞头像图片 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultLikeInfoRespVO` |

## C端 - 用户

### 1. 查询当前用户积分

- 分组：C端 - 用户
- 请求方式：`GET`
- 接口路径：`/web-api/jh/client/get/point`
- operationId：`WebClient_getPoint`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultUserPoint` |

## C端 - 积分结算

### 1. 积分商品检测计算积分价格

- 分组：C端 - 积分结算
- 请求方式：`POST`
- 接口路径：`/web-api/jh/settle_points/estimated-calculation`
- operationId：`WebSettlePoints_estimatedCalculation`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productSkuId | query | 否 | string | 商品 SKU ID |  |
| num | query | 否 | integer | 商品数量 |  |
| countryCode | query | 否 | string | 国家编码 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultWebProductPointsSettlementRespVO` |

## C端 - 购物车

### 1. 购物车计算

- 分组：C端 - 购物车
- 请求方式：`POST`
- 接口路径：`/web-api/jh/shopping-cart/calculate`
- operationId：`WebShoppingCart_calculate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CalculateParam`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| couponCode | 优惠券码 | 否 | string |  |
| countryCode | 国家编码-不为空时表示所有商品国家编码一致 | 否 | string |  |
| isAnon | 是否匿名(前端页面不需要传) | 否 | integer |  |
| joyhubToken | C端token(前端不需要传) | 否 | string |  |
| productItems | 商品详情(登录用户前端页面不需要传) | 否 | array[CalculateItemParam] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultCalculateResult` |

### 2. 单独计算运费

- 分组：C端 - 购物车
- 请求方式：`POST`
- 接口路径：`/web-api/jh/shopping-cart/calculate-shippingcost`
- operationId：`WebShoppingCart_calculateShippingcost`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CalculateShippingcostReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| productList | 产品list | 是 | array[ShoppingCartItemSaveReqVo] |  |
| currencyCode | 国家 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultCalculateShippingcostRespVO` |

### 3. 检测购物车产品列表数据

- 分组：C端 - 购物车
- 请求方式：`POST`
- 接口路径：`/web-api/jh/shopping-cart/check`
- operationId：`WebShoppingCart_checkShoppingCart`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ShoppingCartSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| deviceId | 设备ID | 否 | string |  |
| products | 商品信息列表 | 否 | array[ShoppingCartItemSaveReqVo] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultCheckResult` |

### 4. 创建购物车

- 分组：C端 - 购物车
- 请求方式：`POST`
- 接口路径：`/web-api/jh/shopping-cart/create`
- operationId：`WebShoppingCart_createShoppingCart`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ShoppingCartSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| deviceId | 设备ID | 否 | string |  |
| products | 商品信息列表 | 否 | array[ShoppingCartItemSaveReqVo] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 刪除

- 分组：C端 - 购物车
- 请求方式：`DELETE`
- 接口路径：`/web-api/jh/shopping-cart/delete-list`
- operationId：`WebShoppingCart_deleteBlog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | integer | ids |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 6. 获得购物车列表

- 分组：C端 - 购物车
- 请求方式：`GET`
- 接口路径：`/web-api/jh/shopping-cart/list`
- operationId：`WebShoppingCart_getShoppingCart`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListShoppingCartRespVO` |

### 7. 更新购物车产品数量

- 分组：C端 - 购物车
- 请求方式：`POST`
- 接口路径：`/web-api/jh/shopping-cart/update`
- operationId：`WebShoppingCart_updateShoppingCart`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ShoppingCartItemSaveReqVo`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 购物车详情id | 否 | integer |  |
| productSkuId | 商品skuid | 是 | string | 3644 |
| num | 购买数量 | 是 | integer |  |
| countryCode | 国家编码 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## c端 - Banner信息

### 1. 获得Banner管理

- 分组：c端 - Banner信息
- 请求方式：`GET`
- 接口路径：`/web-api/jh/banner/get`
- operationId：`WebBanner_getBanner`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBannerRespVO` |

### 2. 获得Banner管理分页

- 分组：c端 - Banner信息
- 请求方式：`GET`
- 接口路径：`/web-api/jh/banner/page`
- operationId：`WebBanner_getBannerPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| position | query | 否 | string | 位置，不传则获取所有位置 | HOME_TOP |
| title | query | 否 | string | 标题（模糊查询） | joy |
| subTitle | query | 否 | string | 副标题（模糊查询） | hub |
| platform | query | 是 | integer | 适用平台(1PC 2手机) | 1 |
| lang | query | 是 | string | 语言(en 英语 de 德语 ja 日语) | en |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultBannerRespVO` |

## default-controller

### 1. Default_ai404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/ai/**`
- operationId：`Default_ai404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. Default_ai404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/ai/**`
- operationId：`Default_ai404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. Default_ai404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/ai/**`
- operationId：`Default_ai404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. Default_ai404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/ai/**`
- operationId：`Default_ai404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. Default_ai404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/ai/**`
- operationId：`Default_ai404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 6. Default_ai404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/ai/**`
- operationId：`Default_ai404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 7. Default_ai404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/ai/**`
- operationId：`Default_ai404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 8. Default_bpm404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/bpm/**`
- operationId：`Default_bpm404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 9. Default_bpm404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/bpm/**`
- operationId：`Default_bpm404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 10. Default_bpm404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/bpm/**`
- operationId：`Default_bpm404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 11. Default_bpm404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/bpm/**`
- operationId：`Default_bpm404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 12. Default_bpm404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/bpm/**`
- operationId：`Default_bpm404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 13. Default_bpm404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/bpm/**`
- operationId：`Default_bpm404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 14. Default_bpm404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/bpm/**`
- operationId：`Default_bpm404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 15. Default_crm404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/crm/**`
- operationId：`Default_crm404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 16. Default_crm404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/crm/**`
- operationId：`Default_crm404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 17. Default_crm404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/crm/**`
- operationId：`Default_crm404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 18. Default_crm404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/crm/**`
- operationId：`Default_crm404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 19. Default_crm404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/crm/**`
- operationId：`Default_crm404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 20. Default_crm404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/crm/**`
- operationId：`Default_crm404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 21. Default_crm404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/crm/**`
- operationId：`Default_crm404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 22. Default_erp404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/erp/**`
- operationId：`Default_erp404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 23. Default_erp404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/erp/**`
- operationId：`Default_erp404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 24. Default_erp404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/erp/**`
- operationId：`Default_erp404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 25. Default_erp404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/erp/**`
- operationId：`Default_erp404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 26. Default_erp404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/erp/**`
- operationId：`Default_erp404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 27. Default_erp404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/erp/**`
- operationId：`Default_erp404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 28. Default_erp404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/erp/**`
- operationId：`Default_erp404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 29. Default_iot404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/iot/**`
- operationId：`Default_iot404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 30. Default_iot404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/iot/**`
- operationId：`Default_iot404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 31. Default_iot404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/iot/**`
- operationId：`Default_iot404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 32. Default_iot404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/iot/**`
- operationId：`Default_iot404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 33. Default_iot404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/iot/**`
- operationId：`Default_iot404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 34. Default_iot404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/iot/**`
- operationId：`Default_iot404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 35. Default_iot404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/iot/**`
- operationId：`Default_iot404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 36. Default_mp404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/mp/**`
- operationId：`Default_mp404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 37. Default_mp404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/mp/**`
- operationId：`Default_mp404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 38. Default_mp404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/mp/**`
- operationId：`Default_mp404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 39. Default_mp404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/mp/**`
- operationId：`Default_mp404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 40. Default_mp404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/mp/**`
- operationId：`Default_mp404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 41. Default_mp404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/mp/**`
- operationId：`Default_mp404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 42. Default_mp404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/mp/**`
- operationId：`Default_mp404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 43. Default_pay404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/pay/**`
- operationId：`Default_pay404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 44. Default_pay404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/pay/**`
- operationId：`Default_pay404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 45. Default_pay404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/pay/**`
- operationId：`Default_pay404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 46. Default_pay404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/pay/**`
- operationId：`Default_pay404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 47. Default_pay404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/pay/**`
- operationId：`Default_pay404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 48. Default_pay404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/pay/**`
- operationId：`Default_pay404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 49. Default_pay404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/pay/**`
- operationId：`Default_pay404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 50. Default_mall404_17

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/product/**`
- operationId：`Default_mall404_17`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 51. Default_mall404_14

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/product/**`
- operationId：`Default_mall404_14`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 52. Default_mall404_19

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/product/**`
- operationId：`Default_mall404_19`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 53. Default_mall404_20

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/product/**`
- operationId：`Default_mall404_20`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 54. Default_mall404_18

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/product/**`
- operationId：`Default_mall404_18`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 55. Default_mall404_15

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/product/**`
- operationId：`Default_mall404_15`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 56. Default_mall404_16

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/product/**`
- operationId：`Default_mall404_16`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 57. Default_mall404_10

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/promotion/**`
- operationId：`Default_mall404_10`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 58. Default_mall404_7

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/promotion/**`
- operationId：`Default_mall404_7`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 59. Default_mall404_12

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/promotion/**`
- operationId：`Default_mall404_12`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 60. Default_mall404_13

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/promotion/**`
- operationId：`Default_mall404_13`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 61. Default_mall404_11

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/promotion/**`
- operationId：`Default_mall404_11`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 62. Default_mall404_8

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/promotion/**`
- operationId：`Default_mall404_8`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 63. Default_mall404_9

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/promotion/**`
- operationId：`Default_mall404_9`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 64. Default_report404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/report/**`
- operationId：`Default_report404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 65. Default_report404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/report/**`
- operationId：`Default_report404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 66. Default_report404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/report/**`
- operationId：`Default_report404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 67. Default_report404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/report/**`
- operationId：`Default_report404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 68. Default_report404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/report/**`
- operationId：`Default_report404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 69. Default_report404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/report/**`
- operationId：`Default_report404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 70. Default_report404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/report/**`
- operationId：`Default_report404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 71. Default_mall404_3

- 分组：default-controller
- 请求方式：`DELETE`
- 接口路径：`/admin-api/trade/**`
- operationId：`Default_mall404_3`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 72. Default_mall404

- 分组：default-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/trade/**`
- operationId：`Default_mall404`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 73. Default_mall404_5

- 分组：default-controller
- 请求方式：`HEAD`
- 接口路径：`/admin-api/trade/**`
- operationId：`Default_mall404_5`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 74. Default_mall404_6

- 分组：default-controller
- 请求方式：`OPTIONS`
- 接口路径：`/admin-api/trade/**`
- operationId：`Default_mall404_6`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 75. Default_mall404_4

- 分组：default-controller
- 请求方式：`PATCH`
- 接口路径：`/admin-api/trade/**`
- operationId：`Default_mall404_4`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 76. Default_mall404_1

- 分组：default-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/trade/**`
- operationId：`Default_mall404_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 77. Default_mall404_2

- 分组：default-controller
- 请求方式：`PUT`
- 接口路径：`/admin-api/trade/**`
- operationId：`Default_mall404_2`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## pay-pal-payment-controller

### 1. PayPalPayment_cancel

- 分组：pay-pal-payment-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/cancel`
- operationId：`PayPalPayment_cancel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `string` |

### 2. PayPalPayment_captureOrder

- 分组：pay-pal-payment-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/capture-order`
- operationId：`PayPalPayment_captureOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| orderId | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `object` |

### 3. PayPalPayment_createOrder

- 分组：pay-pal-payment-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/paypal/create-order`
- operationId：`PayPalPayment_createOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`PaymentRequest`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| amount |  | 否 | number |  |
| currency |  | 否 | string |  |
| description |  | 否 | string |  |
| outTradeNo |  | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `object` |

### 4. PayPalPayment_getOrder

- 分组：pay-pal-payment-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/get-order`
- operationId：`PayPalPayment_getOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| orderId | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `object` |

### 5. PayPalPayment_getRefund

- 分组：pay-pal-payment-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/get-refund`
- operationId：`PayPalPayment_getRefund`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| refundId | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `object` |

### 6. PayPalPayment_refundCapturedPayment

- 分组：pay-pal-payment-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/paypal/refund-captured-payment`
- operationId：`PayPalPayment_refundCapturedPayment`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`RefundCapturedPaymentRequest`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| captureId |  | 否 | string |  |
| currencyCode |  | 否 | string |  |
| value |  | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `object` |

### 7. PayPalPayment_searchTransaction

- 分组：pay-pal-payment-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/paypal/search-transaction`
- operationId：`PayPalPayment_searchTransaction`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SearchTransactionRequest`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| startDate |  | 否 | string |  |
| endDate |  | 否 | string |  |
| fields |  | 否 | string |  |
| pageSize |  | 否 | integer |  |
| page |  | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `object` |

### 8. PayPalPayment_success

- 分组：pay-pal-payment-controller
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/success`
- operationId：`PayPalPayment_success`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| token | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `string` |

### 9. PayPalPayment_trackOrder

- 分组：pay-pal-payment-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/paypal/track-order`
- operationId：`PayPalPayment_trackOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`TrackRequest`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| orderId |  | 否 | string |  |
| captureId |  | 否 | string |  |
| trackingNumber |  | 否 | string |  |
| carrier |  | 否 | string |  |
| carrierNameOther |  | 否 | string |  |
| notifyPayer |  | 否 | boolean |  |
| items |  | 否 | array[OrderTrackerItem] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `object` |

## pay-pal-webhook-controller

### 1. PayPalWebhook_receivePayPalWebhook

- 分组：pay-pal-webhook-controller
- 请求方式：`POST`
- 接口路径：`/admin-api/paypal/webhook/payment`
- operationId：`PayPalWebhook_receivePayPalWebhook`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| PAYPAL-TRANSMISSION-ID | header | 是 | string |  |  |
| PAYPAL-TRANSMISSION-TIME | header | 是 | string |  |  |
| PAYPAL-TRANSMISSION-SIG | header | 是 | string |  |  |
| PAYPAL-CERT-URL | header | 是 | string |  |  |
| PAYPAL-AUTH-ALGO | header | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`string`

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `string` |

## 用户 App - 地区

### 1. 获得地区树

- 分组：用户 App - 地区
- 请求方式：`GET`
- 接口路径：`/app-api/system/area/tree`
- operationId：`AppArea_getAreaTree`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListAppAreaNodeRespVO` |

## 用户 App - 字典数据

### 1. 根据字典类型查询字典数据信息

- 分组：用户 App - 字典数据
- 请求方式：`GET`
- 接口路径：`/app-api/system/dict-data/type`
- operationId：`AppDictData_getDictDataListByType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | query | 是 | string | 字典类型 | common_status |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListAppDictDataRespVO` |

## 用户 App - 租户

### 1. 使用域名，获得租户信息

- 分组：用户 App - 租户
- 请求方式：`GET`
- 接口路径：`/app-api/system/tenant/get-by-website`
- operationId：`AppTenant_getTenantByWebsite`
- 描述：根据用户的域名，获得租户信息

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| website | query | 是 | string | 域名 | www.iocoder.cn |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAppTenantRespVO` |

## 管理后台 - API 访问日志

### 1. 导出API 访问日志 Excel

- 分组：管理后台 - API 访问日志
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/api-access-log/export-excel`
- operationId：`ApiAccessLog_exportApiAccessLogExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 666 |
| userType | query | 否 | integer | 用户类型 | 2 |
| applicationName | query | 否 | string | 应用名 | dashboard |
| requestUrl | query | 否 | string | 请求地址，模糊匹配 | /xxx/yyy |
| beginTime | query | 否 | array[string] | 开始时间 | [2022-07-01 00:00:00, 2022-07-01 23:59:59] |
| duration | query | 否 | integer | 执行时长,大于等于，单位：毫秒 | 100 |
| resultCode | query | 否 | integer | 结果码 | 0 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获得API 访问日志分页

- 分组：管理后台 - API 访问日志
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/api-access-log/page`
- operationId：`ApiAccessLog_getApiAccessLogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 666 |
| userType | query | 否 | integer | 用户类型 | 2 |
| applicationName | query | 否 | string | 应用名 | dashboard |
| requestUrl | query | 否 | string | 请求地址，模糊匹配 | /xxx/yyy |
| beginTime | query | 否 | array[string] | 开始时间 | [2022-07-01 00:00:00, 2022-07-01 23:59:59] |
| duration | query | 否 | integer | 执行时长,大于等于，单位：毫秒 | 100 |
| resultCode | query | 否 | integer | 结果码 | 0 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultApiAccessLogRespVO` |

## 管理后台 - API 错误日志

### 1. 导出 API 错误日志 Excel

- 分组：管理后台 - API 错误日志
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/api-error-log/export-excel`
- operationId：`ApiErrorLog_exportApiErrorLogExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 666 |
| userType | query | 否 | integer | 用户类型 | 1 |
| applicationName | query | 否 | string | 应用名 | dashboard |
| requestUrl | query | 否 | string | 请求地址 | /xx/yy |
| exceptionTime | query | 否 | array[string] | 异常发生时间 |  |
| processStatus | query | 否 | integer | 处理状态 | 0 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获得 API 错误日志分页

- 分组：管理后台 - API 错误日志
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/api-error-log/page`
- operationId：`ApiErrorLog_getApiErrorLogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 666 |
| userType | query | 否 | integer | 用户类型 | 1 |
| applicationName | query | 否 | string | 应用名 | dashboard |
| requestUrl | query | 否 | string | 请求地址 | /xx/yy |
| exceptionTime | query | 否 | array[string] | 异常发生时间 |  |
| processStatus | query | 否 | integer | 处理状态 | 0 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultApiErrorLogRespVO` |

### 3. 更新 API 错误日志的状态

- 分组：管理后台 - API 错误日志
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/api-error-log/update-status`
- operationId：`ApiErrorLog_updateApiErrorLogProcess`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| processStatus | query | 是 | integer | 处理状态 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - Banner管理

### 1. 创建Banner管理

- 分组：管理后台 - Banner管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/banner/create`
- operationId：`Banner_createBanner`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`BannerSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 13589 |
| position | 位置 | 是 | string |  |
| title | 标题 | 否 | string |  |
| subTitle | 副标题 | 否 | string |  |
| image | 图片 | 是 | BannerImageDO | {'url': 'https://www.toendi.com/static/image/cd94c191561c4a37a04c78fca2913851.webp', 'name': 'Toendi Joyhub vibrator heater Black Friday promotion for warm and pleasurable experiences', 'mime_type': 'image/webp'} |
| link | 链接 | 否 | string |  |
| platform | 适用平台(1PC 2手机) | 是 | integer |  |
| lang | 语言(en 英语 de 德语 ja 日语) | 是 | string |  |
| rankNum | 排序号 | 是 | integer |  |
| type | 类型 | 是 | string |  |
| status | 状态 | 是 | integer | 2 |
| intervalTime | 轮播时间(秒) | 是 | integer |  |
| coverImage | 缩略图 | 否 | ProductImageDO |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除Banner管理

- 分组：管理后台 - Banner管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/banner/delete`
- operationId：`Banner_deleteBanner`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除Banner管理

- 分组：管理后台 - Banner管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/banner/delete-list`
- operationId：`Banner_deleteBannerList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出Banner管理 Excel

- 分组：管理后台 - Banner管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/banner/export-excel`
- operationId：`Banner_exportBannerExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| position | query | 否 | string | 位置 |  |
| title | query | 否 | string | 标题 |  |
| subTitle | query | 否 | string | 副标题 |  |
| platform | query | 否 | integer | 适用平台(1PC 2手机) |  |
| lang | query | 否 | string | 语言(en 英语 de 德语 ja 日语) |  |
| type | query | 否 | string | 类型 |  |
| status | query | 否 | integer | 状态 | 2 |
| intervalTime | query | 否 | integer | 轮播时间(秒) |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得Banner管理

- 分组：管理后台 - Banner管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/banner/get`
- operationId：`Banner_getBanner`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBannerRespVO` |

### 6. 获得导入Banner管理模板

- 分组：管理后台 - Banner管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/banner/get-import-template`
- operationId：`Banner_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入Banner管理Excel

- 分组：管理后台 - Banner管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/banner/import-excel`
- operationId：`Banner_importBannerExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBannerImportRespVO` |

### 8. 获得Banner管理分页

- 分组：管理后台 - Banner管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/banner/page`
- operationId：`Banner_getBannerPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| position | query | 否 | string | 位置 |  |
| title | query | 否 | string | 标题 |  |
| subTitle | query | 否 | string | 副标题 |  |
| platform | query | 否 | integer | 适用平台(1PC 2手机) |  |
| lang | query | 否 | string | 语言(en 英语 de 德语 ja 日语) |  |
| type | query | 否 | string | 类型 |  |
| status | query | 否 | integer | 状态 | 2 |
| intervalTime | query | 否 | integer | 轮播时间(秒) |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultBannerRespVO` |

### 9. 更新Banner管理

- 分组：管理后台 - Banner管理
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/banner/update`
- operationId：`Banner_updateBanner`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`BannerSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 13589 |
| position | 位置 | 是 | string |  |
| title | 标题 | 否 | string |  |
| subTitle | 副标题 | 否 | string |  |
| image | 图片 | 是 | BannerImageDO | {'url': 'https://www.toendi.com/static/image/cd94c191561c4a37a04c78fca2913851.webp', 'name': 'Toendi Joyhub vibrator heater Black Friday promotion for warm and pleasurable experiences', 'mime_type': 'image/webp'} |
| link | 链接 | 否 | string |  |
| platform | 适用平台(1PC 2手机) | 是 | integer |  |
| lang | 语言(en 英语 de 德语 ja 日语) | 是 | string |  |
| rankNum | 排序号 | 是 | integer |  |
| type | 类型 | 是 | string |  |
| status | 状态 | 是 | integer | 2 |
| intervalTime | 轮播时间(秒) | 是 | integer |  |
| coverImage | 缩略图 | 否 | ProductImageDO |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - FAQ分类

### 1. 创建FAQ分类

- 分组：管理后台 - FAQ分类
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/faq-cate/create`
- operationId：`FaqCate_createFaqCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FaqCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 9867 |
| pid | 父分类ID | 是 | integer | 12768 |
| title | 分类 | 是 | string |  |
| status | 状态 (1正常 2停用) | 否 | integer | 1 |
| rankNum | 排序号 | 是 | integer |  |
| lang | 语言 (en 英语 de 德语 ja 日语) | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除FAQ分类

- 分组：管理后台 - FAQ分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/faq-cate/delete`
- operationId：`FaqCate_deleteFaqCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 导出FAQ分类 Excel

- 分组：管理后台 - FAQ分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-cate/export-excel`
- operationId：`FaqCate_exportFaqCateExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pid | query | 否 | integer | 父分类ID | 12768 |
| title | query | 否 | string | 分类 |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 1 |
| rankNum | query | 否 | integer | 排序号 |  |
| lang | query | 否 | string | 语言 (en 英语 de 德语 ja 日语) |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 6711 |
| userId | query | 否 | integer | 权限用户ID | 4173 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 4. 获得FAQ分类

- 分组：管理后台 - FAQ分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-cate/get`
- operationId：`FaqCate_getFaqCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFaqCateRespVO` |

### 5. 获得导入FAQ分类模板

- 分组：管理后台 - FAQ分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-cate/get-import-template`
- operationId：`FaqCate_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 6. 导入FAQ分类Excel

- 分组：管理后台 - FAQ分类
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/faq-cate/import-excel`
- operationId：`FaqCate_importFaqCateExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFaqCateImportRespVO` |

### 7. 获得FAQ分类列表

- 分组：管理后台 - FAQ分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-cate/list`
- operationId：`FaqCate_getFaqCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pid | query | 否 | integer | 父分类ID | 12768 |
| title | query | 否 | string | 分类 |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 1 |
| rankNum | query | 否 | integer | 排序号 |  |
| lang | query | 否 | string | 语言 (en 英语 de 德语 ja 日语) |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 6711 |
| userId | query | 否 | integer | 权限用户ID | 4173 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListFaqCateRespVO` |

### 8. 更新FAQ分类

- 分组：管理后台 - FAQ分类
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/faq-cate/update`
- operationId：`FaqCate_updateFaqCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FaqCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 9867 |
| pid | 父分类ID | 是 | integer | 12768 |
| title | 分类 | 是 | string |  |
| status | 状态 (1正常 2停用) | 否 | integer | 1 |
| rankNum | 排序号 | 是 | integer |  |
| lang | 语言 (en 英语 de 德语 ja 日语) | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - FAQ数据

### 1. 获得FAQ分类下拉列表

- 分组：管理后台 - FAQ数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq/cate-list`
- operationId：`Faq_getFaqCateList`
- 描述：仅返回正常的叶子分类

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListFaqCateSimpleRespVO` |

### 2. 创建FAQ数据

- 分组：管理后台 - FAQ数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/faq/create`
- operationId：`Faq_createFaq`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FaqSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 6362 |
| faqCateId | 分类ID | 是 | integer | 29870 |
| question | 常见问题 | 是 | string |  |
| answer | 回答 | 是 | string |  |
| isHot | 是否热门（0否，1是） | 是 | integer |  |
| status | 状态 (1正常 2停用) | 否 | integer | 2 |
| rankNum | 排序号 | 是 | integer |  |
| lang | 语言 (en 英语 de 德语 ja 日语) | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 3. 删除FAQ数据

- 分组：管理后台 - FAQ数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/faq/delete`
- operationId：`Faq_deleteFaq`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 批量删除FAQ数据

- 分组：管理后台 - FAQ数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/faq/delete-list`
- operationId：`Faq_deleteFaqList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 导出FAQ数据 Excel

- 分组：管理后台 - FAQ数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq/export-excel`
- operationId：`Faq_exportFaqExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| faqCateId | query | 否 | integer | 分类ID | 29870 |
| question | query | 否 | string | 常见问题 |  |
| answer | query | 否 | string | 回答 |  |
| isHot | query | 否 | integer | 是否热门（0否，1是） |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 2 |
| rankNum | query | 否 | integer | 排序号 |  |
| lang | query | 否 | string | 语言 (en 英语 de 德语 ja 日语) |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 29922 |
| userId | query | 否 | integer | 权限用户ID | 11637 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 6. 获得FAQ数据

- 分组：管理后台 - FAQ数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq/get`
- operationId：`Faq_getFaq`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFaqRespVO` |

### 7. 获得导入FAQ数据模板

- 分组：管理后台 - FAQ数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq/get-import-template`
- operationId：`Faq_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 8. 导入FAQ数据Excel

- 分组：管理后台 - FAQ数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/faq/import-excel`
- operationId：`Faq_importFaqExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFaqImportRespVO` |

### 9. 获得FAQ数据分页

- 分组：管理后台 - FAQ数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq/page`
- operationId：`Faq_getFaqPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| faqCateId | query | 否 | integer | 分类ID | 29870 |
| question | query | 否 | string | 常见问题 |  |
| answer | query | 否 | string | 回答 |  |
| isHot | query | 否 | integer | 是否热门（0否，1是） |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 2 |
| rankNum | query | 否 | integer | 排序号 |  |
| lang | query | 否 | string | 语言 (en 英语 de 德语 ja 日语) |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 29922 |
| userId | query | 否 | integer | 权限用户ID | 11637 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultFaqRespVO` |

### 10. 更新FAQ数据

- 分组：管理后台 - FAQ数据
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/faq/update`
- operationId：`Faq_updateFaq`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FaqSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 6362 |
| faqCateId | 分类ID | 是 | integer | 29870 |
| question | 常见问题 | 是 | string |  |
| answer | 回答 | 是 | string |  |
| isHot | 是否热门（0否，1是） | 是 | integer |  |
| status | 状态 (1正常 2停用) | 否 | integer | 2 |
| rankNum | 排序号 | 是 | integer |  |
| lang | 语言 (en 英语 de 德语 ja 日语) | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - FAQ联系数据

### 1. 创建FAQ联系数据

- 分组：管理后台 - FAQ联系数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/faq-contact-us/create`
- operationId：`FaqContactUs_createFaqContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FaqContactUsSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 24733 |
| name | 姓名 | 是 | string | 芋艿 |
| email | 邮箱 | 是 | string |  |
| toyOrderNumber | 玩具订单号 | 是 | string |  |
| questionType | 问题类型 | 是 | string | 1 |
| questionDetail | 详情 | 否 | string |  |
| files | 图片或视频 | 否 | array[JhFileDO] |  |
| lang | 语言 | 是 | string |  |
| ip | IP地址 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除FAQ联系数据

- 分组：管理后台 - FAQ联系数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/faq-contact-us/delete`
- operationId：`FaqContactUs_deleteFaqContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除FAQ联系数据

- 分组：管理后台 - FAQ联系数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/faq-contact-us/delete-list`
- operationId：`FaqContactUs_deleteFaqContactUsList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出FAQ联系数据 Excel

- 分组：管理后台 - FAQ联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-contact-us/export-excel`
- operationId：`FaqContactUs_exportFaqContactUsExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 姓名 | 芋艿 |
| email | query | 否 | string | 邮箱 |  |
| toyOrderNumber | query | 否 | string | 玩具订单号 |  |
| ids | query | 否 | array[integer] | ids |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得FAQ联系数据

- 分组：管理后台 - FAQ联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-contact-us/get`
- operationId：`FaqContactUs_getFaqContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFaqContactUsRespVO` |

### 6. 获得导入FAQ联系数据模板

- 分组：管理后台 - FAQ联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-contact-us/get-import-template`
- operationId：`FaqContactUs_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入FAQ联系数据Excel

- 分组：管理后台 - FAQ联系数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/faq-contact-us/import-excel`
- operationId：`FaqContactUs_importFaqContactUsExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFaqContactUsImportRespVO` |

### 8. 获得FAQ联系数据分页

- 分组：管理后台 - FAQ联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/faq-contact-us/page`
- operationId：`FaqContactUs_getFaqContactUsPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 姓名 | 芋艿 |
| email | query | 否 | string | 邮箱 |  |
| toyOrderNumber | query | 否 | string | 玩具订单号 |  |
| ids | query | 否 | array[integer] | ids |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultFaqContactUsRespVO` |

### 9. 更新FAQ联系数据

- 分组：管理后台 - FAQ联系数据
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/faq-contact-us/update`
- operationId：`FaqContactUs_updateFaqContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FaqContactUsSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 24733 |
| name | 姓名 | 是 | string | 芋艿 |
| email | 邮箱 | 是 | string |  |
| toyOrderNumber | 玩具订单号 | 是 | string |  |
| questionType | 问题类型 | 是 | string | 1 |
| questionDetail | 详情 | 否 | string |  |
| files | 图片或视频 | 否 | array[JhFileDO] |  |
| lang | 语言 | 是 | string |  |
| ip | IP地址 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - LX 亚马逊FBA货件详情

### 1. 创建LX 亚马逊FBA货件详情

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`POST`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/create`
- operationId：`LxFbaInboundShipmentDetail_createFbaInboundShipmentDetail`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`LxFbaInboundShipmentDetailSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 唯一ID | 是 | integer | 5515 |
| inboundPlanId | STA任务编号 | 否 | string | 10387 |
| alphaCode | 承运方式 | 否 | string |  |
| amazonReferenceId | 关联号 | 否 | string | 28173 |
| endDate | 送达时段-结束时间 | 否 | string |  |
| inboundRegion | 入库区域 | 否 | string |  |
| itemCount | 商品总数 | 否 | integer | 2784 |
| itemList | 商品信息列表 | 否 |  |  |
| pickUpId | 提货单号 | 否 | string | 19381 |
| sendAddress | 发货地址 | 否 |  |  |
| shippingTime | 发货日期 | 否 | string |  |
| shipmentConfirmationId | 货件单号 | 否 | string | 31329 |
| shipmentName | 货件名称 | 否 | string | 王五 |
| shippingAddress | 收货地址 | 否 |  |  |
| shippingMode | 货件类型 | 否 | string |  |
| shippingSolution | 承运人 | 否 | string |  |
| sid | 店铺ID | 否 | integer | 14347 |
| startDate | 送达时段-开始时间 | 否 | string |  |
| status | 货件状态 | 否 | string | 1 |
| trackingNumberList | 追踪编号列表 | 否 |  |  |
| warehouseId | 物流中心编码 | 否 | string | 16629 |
| erpSyncStatus | 同步状态 (本地字段) | 否 | integer | 1 |
| userId | 权限用户ID | 是 | integer | 17868 |
| deptId | 权限部门ID | 是 | integer | 31940 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除LX 亚马逊FBA货件详情

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`DELETE`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/delete`
- operationId：`LxFbaInboundShipmentDetail_deleteFbaInboundShipmentDetail`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除LX 亚马逊FBA货件详情

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`DELETE`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/delete-list`
- operationId：`LxFbaInboundShipmentDetail_deleteFbaInboundShipmentDetailList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出LX 亚马逊FBA货件详情 Excel

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/export-excel`
- operationId：`LxFbaInboundShipmentDetail_exportFbaInboundShipmentDetailExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| inboundPlanId | query | 否 | string | STA任务编号 | 10387 |
| alphaCode | query | 否 | string | 承运方式 |  |
| amazonReferenceId | query | 否 | string | 关联号 | 28173 |
| endDate | query | 否 | array[string] | 送达时段-结束时间 |  |
| inboundRegion | query | 否 | string | 入库区域 |  |
| itemCount | query | 否 | integer | 商品总数 | 2784 |
| itemList | query | 否 | object | 商品信息列表 |  |
| pickUpId | query | 否 | string | 提货单号 | 19381 |
| sendAddress | query | 否 | object | 发货地址 |  |
| shippingTime | query | 否 | array[string] | 发货日期 |  |
| shipmentConfirmationId | query | 否 | string | 货件单号 | 31329 |
| shipmentName | query | 否 | string | 货件名称 | 王五 |
| shippingAddress | query | 否 | object | 收货地址 |  |
| shippingMode | query | 否 | string | 货件类型 |  |
| shippingSolution | query | 否 | string | 承运人 |  |
| sid | query | 否 | integer | 店铺ID | 14347 |
| startDate | query | 否 | array[string] | 送达时段-开始时间 |  |
| status | query | 否 | string | 货件状态 | 1 |
| trackingNumberList | query | 否 | object | 追踪编号列表 |  |
| warehouseId | query | 否 | string | 物流中心编码 | 16629 |
| erpSyncStatus | query | 否 | integer | 同步状态 (本地字段) | 1 |
| createTime | query | 否 | array[string] | 系统创建时间 |  |
| userId | query | 否 | integer | 权限用户ID | 17868 |
| deptId | query | 否 | integer | 权限部门ID | 31940 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得LX 亚马逊FBA货件详情

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/get`
- operationId：`LxFbaInboundShipmentDetail_getFbaInboundShipmentDetail`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLxFbaInboundShipmentDetailRespVO` |

### 6. 获得导入LX 亚马逊FBA货件详情模板

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/get-import-template`
- operationId：`LxFbaInboundShipmentDetail_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入LX 亚马逊FBA货件详情Excel

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`POST`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/import-excel`
- operationId：`LxFbaInboundShipmentDetail_importFbaInboundShipmentDetailExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLxFbaInboundShipmentDetailImportRespVO` |

### 8. 获得LX 亚马逊FBA货件详情分页

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/page`
- operationId：`LxFbaInboundShipmentDetail_getFbaInboundShipmentDetailPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| inboundPlanId | query | 否 | string | STA任务编号 | 10387 |
| alphaCode | query | 否 | string | 承运方式 |  |
| amazonReferenceId | query | 否 | string | 关联号 | 28173 |
| endDate | query | 否 | array[string] | 送达时段-结束时间 |  |
| inboundRegion | query | 否 | string | 入库区域 |  |
| itemCount | query | 否 | integer | 商品总数 | 2784 |
| itemList | query | 否 | object | 商品信息列表 |  |
| pickUpId | query | 否 | string | 提货单号 | 19381 |
| sendAddress | query | 否 | object | 发货地址 |  |
| shippingTime | query | 否 | array[string] | 发货日期 |  |
| shipmentConfirmationId | query | 否 | string | 货件单号 | 31329 |
| shipmentName | query | 否 | string | 货件名称 | 王五 |
| shippingAddress | query | 否 | object | 收货地址 |  |
| shippingMode | query | 否 | string | 货件类型 |  |
| shippingSolution | query | 否 | string | 承运人 |  |
| sid | query | 否 | integer | 店铺ID | 14347 |
| startDate | query | 否 | array[string] | 送达时段-开始时间 |  |
| status | query | 否 | string | 货件状态 | 1 |
| trackingNumberList | query | 否 | object | 追踪编号列表 |  |
| warehouseId | query | 否 | string | 物流中心编码 | 16629 |
| erpSyncStatus | query | 否 | integer | 同步状态 (本地字段) | 1 |
| createTime | query | 否 | array[string] | 系统创建时间 |  |
| userId | query | 否 | integer | 权限用户ID | 17868 |
| deptId | query | 否 | integer | 权限部门ID | 31940 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultLxFbaInboundShipmentDetailRespVO` |

### 9. 更新LX 亚马逊FBA货件详情

- 分组：管理后台 - LX 亚马逊FBA货件详情
- 请求方式：`PUT`
- 接口路径：`/admin-api/lx/fba-inbound-shipment-detail/update`
- operationId：`LxFbaInboundShipmentDetail_updateFbaInboundShipmentDetail`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`LxFbaInboundShipmentDetailSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 唯一ID | 是 | integer | 5515 |
| inboundPlanId | STA任务编号 | 否 | string | 10387 |
| alphaCode | 承运方式 | 否 | string |  |
| amazonReferenceId | 关联号 | 否 | string | 28173 |
| endDate | 送达时段-结束时间 | 否 | string |  |
| inboundRegion | 入库区域 | 否 | string |  |
| itemCount | 商品总数 | 否 | integer | 2784 |
| itemList | 商品信息列表 | 否 |  |  |
| pickUpId | 提货单号 | 否 | string | 19381 |
| sendAddress | 发货地址 | 否 |  |  |
| shippingTime | 发货日期 | 否 | string |  |
| shipmentConfirmationId | 货件单号 | 否 | string | 31329 |
| shipmentName | 货件名称 | 否 | string | 王五 |
| shippingAddress | 收货地址 | 否 |  |  |
| shippingMode | 货件类型 | 否 | string |  |
| shippingSolution | 承运人 | 否 | string |  |
| sid | 店铺ID | 否 | integer | 14347 |
| startDate | 送达时段-开始时间 | 否 | string |  |
| status | 货件状态 | 否 | string | 1 |
| trackingNumberList | 追踪编号列表 | 否 |  |  |
| warehouseId | 物流中心编码 | 否 | string | 16629 |
| erpSyncStatus | 同步状态 (本地字段) | 否 | integer | 1 |
| userId | 权限用户ID | 是 | integer | 17868 |
| deptId | 权限部门ID | 是 | integer | 31940 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - LX 亚马逊店铺信息

### 1. 创建LX 亚马逊店铺信息

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`POST`
- 接口路径：`/admin-api/lx/amazon-shop/create`
- operationId：`LxAmazonShop_createAmazonShop`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`LxAmazonShopSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 25866 |
| sid | 店铺ID(领星唯一标识) | 是 | integer | 23553 |
| mid | 站点ID | 否 | integer | 16304 |
| sellerAccountId | 店铺账号ID | 否 | integer | 18795 |
| hasAdsSetting | 是否授权广告：0否, 1是 | 否 | integer |  |
| status | 店铺状态：0停用, 1正常, 2授权异常, 3欠费 | 否 | integer | 1 |
| erpSyncStatus | 同步状态：0未同步, 1已同步, 2异常 | 否 | integer | 2 |
| name | 店铺名 | 否 | string | 王五 |
| sellerId | 亚马逊店铺ID(Seller ID) | 否 | string | 5978 |
| accountName | 店铺账户名称 | 否 | string | 王五 |
| region | 站点简称 | 否 | string |  |
| country | 国家名称 | 否 | string |  |
| marketplaceId | 亚马逊市场ID | 否 | string | 21231 |
| userId | 权限用户ID | 是 | integer | 5873 |
| deptId | 权限部门ID | 是 | integer | 13529 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除LX 亚马逊店铺信息

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`DELETE`
- 接口路径：`/admin-api/lx/amazon-shop/delete`
- operationId：`LxAmazonShop_deleteAmazonShop`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除LX 亚马逊店铺信息

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`DELETE`
- 接口路径：`/admin-api/lx/amazon-shop/delete-list`
- operationId：`LxAmazonShop_deleteAmazonShopList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出LX 亚马逊店铺信息 Excel

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/amazon-shop/export-excel`
- operationId：`LxAmazonShop_exportAmazonShopExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| sid | query | 否 | integer | 店铺ID(领星唯一标识) | 23553 |
| mid | query | 否 | integer | 站点ID | 16304 |
| sellerAccountId | query | 否 | integer | 店铺账号ID | 18795 |
| hasAdsSetting | query | 否 | integer | 是否授权广告：0否, 1是 |  |
| status | query | 否 | integer | 店铺状态：0停用, 1正常, 2授权异常, 3欠费 | 1 |
| erpSyncStatus | query | 否 | integer | 同步状态：0未同步, 1已同步, 2异常 | 2 |
| name | query | 否 | string | 店铺名 | 王五 |
| sellerId | query | 否 | string | 亚马逊店铺ID(Seller ID) | 5978 |
| accountName | query | 否 | string | 店铺账户名称 | 王五 |
| region | query | 否 | string | 站点简称 |  |
| country | query | 否 | string | 国家名称 |  |
| marketplaceId | query | 否 | string | 亚马逊市场ID | 21231 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| userId | query | 否 | integer | 权限用户ID | 5873 |
| deptId | query | 否 | integer | 权限部门ID | 13529 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得LX 亚马逊店铺信息

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/amazon-shop/get`
- operationId：`LxAmazonShop_getAmazonShop`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLxAmazonShopRespVO` |

### 6. 获得导入LX 亚马逊店铺信息模板

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/amazon-shop/get-import-template`
- operationId：`LxAmazonShop_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入LX 亚马逊店铺信息Excel

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`POST`
- 接口路径：`/admin-api/lx/amazon-shop/import-excel`
- operationId：`LxAmazonShop_importAmazonShopExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLxAmazonShopImportRespVO` |

### 8. 获得LX 亚马逊店铺信息分页

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`GET`
- 接口路径：`/admin-api/lx/amazon-shop/page`
- operationId：`LxAmazonShop_getAmazonShopPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| sid | query | 否 | integer | 店铺ID(领星唯一标识) | 23553 |
| mid | query | 否 | integer | 站点ID | 16304 |
| sellerAccountId | query | 否 | integer | 店铺账号ID | 18795 |
| hasAdsSetting | query | 否 | integer | 是否授权广告：0否, 1是 |  |
| status | query | 否 | integer | 店铺状态：0停用, 1正常, 2授权异常, 3欠费 | 1 |
| erpSyncStatus | query | 否 | integer | 同步状态：0未同步, 1已同步, 2异常 | 2 |
| name | query | 否 | string | 店铺名 | 王五 |
| sellerId | query | 否 | string | 亚马逊店铺ID(Seller ID) | 5978 |
| accountName | query | 否 | string | 店铺账户名称 | 王五 |
| region | query | 否 | string | 站点简称 |  |
| country | query | 否 | string | 国家名称 |  |
| marketplaceId | query | 否 | string | 亚马逊市场ID | 21231 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| userId | query | 否 | integer | 权限用户ID | 5873 |
| deptId | query | 否 | integer | 权限部门ID | 13529 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultLxAmazonShopRespVO` |

### 9. 更新LX 亚马逊店铺信息

- 分组：管理后台 - LX 亚马逊店铺信息
- 请求方式：`PUT`
- 接口路径：`/admin-api/lx/amazon-shop/update`
- operationId：`LxAmazonShop_updateAmazonShop`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`LxAmazonShopSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 25866 |
| sid | 店铺ID(领星唯一标识) | 是 | integer | 23553 |
| mid | 站点ID | 否 | integer | 16304 |
| sellerAccountId | 店铺账号ID | 否 | integer | 18795 |
| hasAdsSetting | 是否授权广告：0否, 1是 | 否 | integer |  |
| status | 店铺状态：0停用, 1正常, 2授权异常, 3欠费 | 否 | integer | 1 |
| erpSyncStatus | 同步状态：0未同步, 1已同步, 2异常 | 否 | integer | 2 |
| name | 店铺名 | 否 | string | 王五 |
| sellerId | 亚马逊店铺ID(Seller ID) | 否 | string | 5978 |
| accountName | 店铺账户名称 | 否 | string | 王五 |
| region | 站点简称 | 否 | string |  |
| country | 国家名称 | 否 | string |  |
| marketplaceId | 亚马逊市场ID | 否 | string | 21231 |
| userId | 权限用户ID | 是 | integer | 5873 |
| deptId | 权限部门ID | 是 | integer | 13529 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - OAuth2 客户端

### 1. 创建 OAuth2 客户端

- 分组：管理后台 - OAuth2 客户端
- 请求方式：`POST`
- 接口路径：`/admin-api/system/oauth2-client/create`
- operationId：`OAuth2Client_createOAuth2Client`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OAuth2ClientSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| clientId | 客户端编号 | 是 | string | tudou |
| secret | 客户端密钥 | 是 | string | fan |
| name | 应用名 | 是 | string | 土豆 |
| logo | 应用图标 | 是 | string | https://www.iocoder.cn/xx.png |
| description | 应用描述 | 否 | string | 我是一个应用 |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| accessTokenValiditySeconds | 访问令牌的有效期 | 是 | integer | 8640 |
| refreshTokenValiditySeconds | 刷新令牌的有效期 | 是 | integer | 8640000 |
| redirectUris | 可重定向的 URI 地址 | 是 | array[string] | https://www.iocoder.cn |
| authorizedGrantTypes | 授权类型，参见 OAuth2GrantTypeEnum 枚举 | 是 | array[string] | password |
| scopes | 授权范围 | 否 | array[string] | user_info |
| autoApproveScopes | 自动通过的授权范围 | 否 | array[string] | user_info |
| authorities | 权限 | 否 | array[string] | system:user:query |
| resourceIds | 资源 | 否 | array[string] | 1024 |
| additionalInformation | 附加信息 | 否 | string | {yunai: true} |
| additionalInformationJson |  | 否 | boolean |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除 OAuth2 客户端

- 分组：管理后台 - OAuth2 客户端
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/oauth2-client/delete`
- operationId：`OAuth2Client_deleteOAuth2Client`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除 OAuth2 客户端

- 分组：管理后台 - OAuth2 客户端
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/oauth2-client/delete-list`
- operationId：`OAuth2Client_deleteOAuth2ClientList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得 OAuth2 客户端

- 分组：管理后台 - OAuth2 客户端
- 请求方式：`GET`
- 接口路径：`/admin-api/system/oauth2-client/get`
- operationId：`OAuth2Client_getOAuth2Client`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOAuth2ClientRespVO` |

### 5. 获得 OAuth2 客户端分页

- 分组：管理后台 - OAuth2 客户端
- 请求方式：`GET`
- 接口路径：`/admin-api/system/oauth2-client/page`
- operationId：`OAuth2Client_getOAuth2ClientPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 应用名，模糊匹配 | 土豆 |
| status | query | 否 | integer | 状态，参见 CommonStatusEnum 枚举 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultOAuth2ClientRespVO` |

### 6. 更新 OAuth2 客户端

- 分组：管理后台 - OAuth2 客户端
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/oauth2-client/update`
- operationId：`OAuth2Client_updateOAuth2Client`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OAuth2ClientSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| clientId | 客户端编号 | 是 | string | tudou |
| secret | 客户端密钥 | 是 | string | fan |
| name | 应用名 | 是 | string | 土豆 |
| logo | 应用图标 | 是 | string | https://www.iocoder.cn/xx.png |
| description | 应用描述 | 否 | string | 我是一个应用 |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| accessTokenValiditySeconds | 访问令牌的有效期 | 是 | integer | 8640 |
| refreshTokenValiditySeconds | 刷新令牌的有效期 | 是 | integer | 8640000 |
| redirectUris | 可重定向的 URI 地址 | 是 | array[string] | https://www.iocoder.cn |
| authorizedGrantTypes | 授权类型，参见 OAuth2GrantTypeEnum 枚举 | 是 | array[string] | password |
| scopes | 授权范围 | 否 | array[string] | user_info |
| autoApproveScopes | 自动通过的授权范围 | 否 | array[string] | user_info |
| authorities | 权限 | 否 | array[string] | system:user:query |
| resourceIds | 资源 | 否 | array[string] | 1024 |
| additionalInformation | 附加信息 | 否 | string | {yunai: true} |
| additionalInformationJson |  | 否 | boolean |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - OAuth2.0 令牌

### 1. 删除访问令牌

- 分组：管理后台 - OAuth2.0 令牌
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/oauth2-token/delete`
- operationId：`OAuth2Token_deleteAccessToken`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| accessToken | query | 是 | string | 访问令牌 | tudou |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 批量删除访问令牌

- 分组：管理后台 - OAuth2.0 令牌
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/oauth2-token/delete-list`
- operationId：`OAuth2Token_deleteAccessTokenList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| accessTokens | query | 是 | array[string] | 访问令牌数组 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 获得访问令牌分页

- 分组：管理后台 - OAuth2.0 令牌
- 请求方式：`GET`
- 接口路径：`/admin-api/system/oauth2-token/page`
- operationId：`OAuth2Token_getAccessTokenPage`
- 描述：只返回有效期内的

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 是 | integer | 用户编号 | 666 |
| userType | query | 是 | integer | 用户类型，参见 UserTypeEnum 枚举 | 2 |
| clientId | query | 是 | string | 客户端编号 | 2 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultOAuth2AccessTokenRespVO` |

## 管理后台 - OAuth2.0 授权

### 1. 获得授权信息

- 分组：管理后台 - OAuth2.0 授权
- 请求方式：`GET`
- 接口路径：`/admin-api/system/oauth2/authorize`
- operationId：`OAuth2Open_authorize`
- 描述：适合 code 授权码模式，或者 implicit 简化模式；在 sso.vue 单点登录界面被【获取】调用

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| clientId | query | 是 | string | 客户端编号 | tudou |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOAuth2OpenAuthorizeInfoRespVO` |

### 2. 申请授权

- 分组：管理后台 - OAuth2.0 授权
- 请求方式：`POST`
- 接口路径：`/admin-api/system/oauth2/authorize`
- operationId：`OAuth2Open_approveOrDeny`
- 描述：适合 code 授权码模式，或者 implicit 简化模式；在 sso.vue 单点登录界面被【提交】调用

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| response_type | query | 是 | string | 响应类型 | code |
| client_id | query | 是 | string | 客户端编号 | tudou |
| scope | query | 否 | string | 授权范围 | userinfo.read |
| redirect_uri | query | 是 | string | 重定向 URI | https://www.iocoder.cn |
| auto_approve | query | 是 | boolean | 用户是否接受 | True |
| state | query | 否 | string |  | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 3. 校验访问令牌

- 分组：管理后台 - OAuth2.0 授权
- 请求方式：`POST`
- 接口路径：`/admin-api/system/oauth2/check-token`
- operationId：`OAuth2Open_checkToken`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| token | query | 是 | string | 访问令牌 | biu |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOAuth2OpenCheckTokenRespVO` |

### 4. 删除访问令牌

- 分组：管理后台 - OAuth2.0 授权
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/oauth2/token`
- operationId：`OAuth2Open_revokeToken`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| token | query | 是 | string | 访问令牌 | biu |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 获得访问令牌

- 分组：管理后台 - OAuth2.0 授权
- 请求方式：`POST`
- 接口路径：`/admin-api/system/oauth2/token`
- operationId：`OAuth2Open_postAccessToken`
- 描述：适合 code 授权码模式，或者 implicit 简化模式；在 sso.vue 单点登录界面被【获取】调用

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| grant_type | query | 是 | string | 授权类型 | code |
| code | query | 否 | string | 授权范围 | userinfo.read |
| redirect_uri | query | 否 | string | 重定向 URI | https://www.iocoder.cn |
| state | query | 否 | string | 状态 | 1 |
| username | query | 否 | string |  | tudou |
| password | query | 否 | string |  | cai |
| scope | query | 否 | string |  | user_info |
| refresh_token | query | 否 | string |  | 123424233 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOAuth2OpenAccessTokenRespVO` |

## 管理后台 - OAuth2.0 用户

### 1. 获得用户基本信息

- 分组：管理后台 - OAuth2.0 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/oauth2/user/get`
- operationId：`OAuth2User_getUserInfo`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOAuth2UserInfoRespVO` |

### 2. 更新用户基本信息

- 分组：管理后台 - OAuth2.0 用户
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/oauth2/user/update`
- operationId：`OAuth2User_updateUserInfo`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OAuth2UserUpdateReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| nickname | 用户昵称 | 是 | string | 芋艿 |
| email | 用户邮箱 | 否 | string | yudao@iocoder.cn |
| mobile | 手机号码 | 否 | string | 15601691300 |
| sex | 用户性别，参见 SexEnum 枚举类 | 否 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - PayPal Webhook 幂等表（防重复处理）

### 1. 创建PayPal Webhook 幂等表（防重复处理）

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`POST`
- 接口路径：`/admin-api/paypal/webhook-idempotent/create`
- operationId：`WebhookIdempotent_createWebhookIdempotent`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`WebhookIdempotentSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 是 | integer | 13577 |
| webhookEventId | PayPal Webhook 事件ID（WH-xxx） | 是 | string | 28160 |
| eventVersion | 事件版本 | 是 | string |  |
| createTime | PayPal 事件创建时间（UTC） | 是 | string |  |
| resourceType | 资源类型（如capture） | 是 | string | 1 |
| resourceVersion | 资源版本 | 是 | string |  |
| eventType | 事件类型（如PAYMENT.CAPTURE.COMPLETED） | 是 | string | 2 |
| summary | 事件摘要描述 | 是 | string |  |
| resource | 核心交易数据（JSON格式） | 否 |  |  |
| links | Webhook 相关链接（JSON格式） | 否 |  |  |
| resourceId | PayPal 扣款ID/资源ID | 否 | string | 30853 |
| invoiceId | 商户订单号（对应jh_order.order_no） | 否 | string | 28059 |
| status | 处理状态：1-已接收 2-处理成功 3-处理失败 | 是 | integer | 2 |
| createAt | 记录创建时间 | 是 | string |  |
| updateAt | 记录更新时间 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除PayPal Webhook 幂等表（防重复处理）

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`DELETE`
- 接口路径：`/admin-api/paypal/webhook-idempotent/delete`
- operationId：`WebhookIdempotent_deleteWebhookIdempotent`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除PayPal Webhook 幂等表（防重复处理）

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`DELETE`
- 接口路径：`/admin-api/paypal/webhook-idempotent/delete-list`
- operationId：`WebhookIdempotent_deleteWebhookIdempotentList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出PayPal Webhook 幂等表（防重复处理） Excel

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/webhook-idempotent/export-excel`
- operationId：`WebhookIdempotent_exportWebhookIdempotentExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| webhookEventId | query | 否 | string | PayPal Webhook 事件ID（WH-xxx） | 28160 |
| eventVersion | query | 否 | string | 事件版本 |  |
| createTime | query | 否 | array[string] | PayPal 事件创建时间（UTC） |  |
| resourceType | query | 否 | string | 资源类型（如capture） | 1 |
| resourceVersion | query | 否 | string | 资源版本 |  |
| eventType | query | 否 | string | 事件类型（如PAYMENT.CAPTURE.COMPLETED） | 2 |
| summary | query | 否 | string | 事件摘要描述 |  |
| resource | query | 否 | object | 核心交易数据（JSON格式） |  |
| links | query | 否 | object | Webhook 相关链接（JSON格式） |  |
| resourceId | query | 否 | string | PayPal 扣款ID/资源ID | 30853 |
| invoiceId | query | 否 | string | 商户订单号（对应jh_order.order_no） | 28059 |
| status | query | 否 | integer | 处理状态：1-已接收 2-处理成功 3-处理失败 | 2 |
| createAt | query | 否 | string | 记录创建时间 |  |
| updateAt | query | 否 | string | 记录更新时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得PayPal Webhook 幂等表（防重复处理）

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/webhook-idempotent/get`
- operationId：`WebhookIdempotent_getWebhookIdempotent`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultWebhookIdempotentRespVO` |

### 6. 获得导入PayPal Webhook 幂等表（防重复处理）模板

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/webhook-idempotent/get-import-template`
- operationId：`WebhookIdempotent_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入PayPal Webhook 幂等表（防重复处理）Excel

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`POST`
- 接口路径：`/admin-api/paypal/webhook-idempotent/import-excel`
- operationId：`WebhookIdempotent_importWebhookIdempotentExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultWebhookIdempotentImportRespVO` |

### 8. 获得PayPal Webhook 幂等表（防重复处理）分页

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`GET`
- 接口路径：`/admin-api/paypal/webhook-idempotent/page`
- operationId：`WebhookIdempotent_getWebhookIdempotentPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| webhookEventId | query | 否 | string | PayPal Webhook 事件ID（WH-xxx） | 28160 |
| eventVersion | query | 否 | string | 事件版本 |  |
| createTime | query | 否 | array[string] | PayPal 事件创建时间（UTC） |  |
| resourceType | query | 否 | string | 资源类型（如capture） | 1 |
| resourceVersion | query | 否 | string | 资源版本 |  |
| eventType | query | 否 | string | 事件类型（如PAYMENT.CAPTURE.COMPLETED） | 2 |
| summary | query | 否 | string | 事件摘要描述 |  |
| resource | query | 否 | object | 核心交易数据（JSON格式） |  |
| links | query | 否 | object | Webhook 相关链接（JSON格式） |  |
| resourceId | query | 否 | string | PayPal 扣款ID/资源ID | 30853 |
| invoiceId | query | 否 | string | 商户订单号（对应jh_order.order_no） | 28059 |
| status | query | 否 | integer | 处理状态：1-已接收 2-处理成功 3-处理失败 | 2 |
| createAt | query | 否 | string | 记录创建时间 |  |
| updateAt | query | 否 | string | 记录更新时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultWebhookIdempotentRespVO` |

### 9. 更新PayPal Webhook 幂等表（防重复处理）

- 分组：管理后台 - PayPal Webhook 幂等表（防重复处理）
- 请求方式：`PUT`
- 接口路径：`/admin-api/paypal/webhook-idempotent/update`
- operationId：`WebhookIdempotent_updateWebhookIdempotent`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`WebhookIdempotentSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 是 | integer | 13577 |
| webhookEventId | PayPal Webhook 事件ID（WH-xxx） | 是 | string | 28160 |
| eventVersion | 事件版本 | 是 | string |  |
| createTime | PayPal 事件创建时间（UTC） | 是 | string |  |
| resourceType | 资源类型（如capture） | 是 | string | 1 |
| resourceVersion | 资源版本 | 是 | string |  |
| eventType | 事件类型（如PAYMENT.CAPTURE.COMPLETED） | 是 | string | 2 |
| summary | 事件摘要描述 | 是 | string |  |
| resource | 核心交易数据（JSON格式） | 否 |  |  |
| links | Webhook 相关链接（JSON格式） | 否 |  |  |
| resourceId | PayPal 扣款ID/资源ID | 否 | string | 30853 |
| invoiceId | 商户订单号（对应jh_order.order_no） | 否 | string | 28059 |
| status | 处理状态：1-已接收 2-处理成功 3-处理失败 | 是 | integer | 2 |
| createAt | 记录创建时间 | 是 | string |  |
| updateAt | 记录更新时间 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - Redis 监控

### 1. 获得 Redis 监控信息

- 分组：管理后台 - Redis 监控
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/redis/get-monitor-info`
- operationId：`Redis_getRedisMonitorInfo`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultRedisMonitorRespVO` |

## 管理后台 - app版本号管理

### 1. 创建app版本号管理

- 分组：管理后台 - app版本号管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/appversion/create`
- operationId：`Appversion_createAppversion`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AppversionSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 9413 |
| storeName | 应用商店 | 是 | string | 王五 |
| version | 版本号 | 是 | string |  |
| downloadUrl | 商城下载地址 | 是 | string | https://www.iocoder.cn |
| isOn | 是否上架（1是，2否） | 是 | integer |  |
| status | 状态 (1正常 2停用) | 否 | integer | 2 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除app版本号管理

- 分组：管理后台 - app版本号管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/appversion/delete`
- operationId：`Appversion_deleteAppversion`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除app版本号管理

- 分组：管理后台 - app版本号管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/appversion/delete-list`
- operationId：`Appversion_deleteAppversionList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出app版本号管理 Excel

- 分组：管理后台 - app版本号管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/appversion/export-excel`
- operationId：`Appversion_exportAppversionExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| storeName | query | 否 | string | 应用商店 | 王五 |
| version | query | 否 | string | 版本号 |  |
| downloadUrl | query | 否 | string | 商城下载地址 | https://www.iocoder.cn |
| isOn | query | 否 | integer | 是否上架（1是，2否） |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 2 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 26004 |
| userId | query | 否 | integer | 权限用户ID | 14739 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得app版本号管理

- 分组：管理后台 - app版本号管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/appversion/get`
- operationId：`Appversion_getAppversion`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAppversionRespVO` |

### 6. 获得导入app版本号管理模板

- 分组：管理后台 - app版本号管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/appversion/get-import-template`
- operationId：`Appversion_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入app版本号管理Excel

- 分组：管理后台 - app版本号管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/appversion/import-excel`
- operationId：`Appversion_importAppversionExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAppversionImportRespVO` |

### 8. 获得app版本号管理分页

- 分组：管理后台 - app版本号管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/appversion/page`
- operationId：`Appversion_getAppversionPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| storeName | query | 否 | string | 应用商店 | 王五 |
| version | query | 否 | string | 版本号 |  |
| downloadUrl | query | 否 | string | 商城下载地址 | https://www.iocoder.cn |
| isOn | query | 否 | integer | 是否上架（1是，2否） |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 2 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 26004 |
| userId | query | 否 | integer | 权限用户ID | 14739 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAppversionRespVO` |

### 9. 更新app版本号管理

- 分组：管理后台 - app版本号管理
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/appversion/update`
- operationId：`Appversion_updateAppversion`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AppversionSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 9413 |
| storeName | 应用商店 | 是 | string | 王五 |
| version | 版本号 | 是 | string |  |
| downloadUrl | 商城下载地址 | 是 | string | https://www.iocoder.cn |
| isOn | 是否上架（1是，2否） | 是 | integer |  |
| status | 状态 (1正常 2停用) | 否 | integer | 2 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - blog分类

### 1. 创建blog分类

- 分组：管理后台 - blog分类
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/blog-cate/create`
- operationId：`BlogCate_createBlogCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`BlogCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 25736 |
| name | 分类名称 | 是 | string | 李四 |
| coverImage | 缩略图 | 否 | ProductImageDO |  |
| status | 状态 | 否 | integer | 1 |
| rankNum | 排序 | 否 | integer |  |
| route | 路由 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除blog分类

- 分组：管理后台 - blog分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/blog-cate/delete`
- operationId：`BlogCate_deleteBlogCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除blog分类

- 分组：管理后台 - blog分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/blog-cate/delete-list`
- operationId：`BlogCate_deleteBlogCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出blog分类 Excel

- 分组：管理后台 - blog分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog-cate/export-excel`
- operationId：`BlogCate_exportBlogCateExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 分类名称 | 李四 |
| status | query | 否 | integer | 状态 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得blog分类

- 分组：管理后台 - blog分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog-cate/get`
- operationId：`BlogCate_getBlogCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBlogCateRespVO` |

### 6. 获得导入blog分类模板

- 分组：管理后台 - blog分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog-cate/get-import-template`
- operationId：`BlogCate_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入blog分类Excel

- 分组：管理后台 - blog分类
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/blog-cate/import-excel`
- operationId：`BlogCate_importBlogCateExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBlogCateImportRespVO` |

### 8. 获得blog分类分页

- 分组：管理后台 - blog分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog-cate/page`
- operationId：`BlogCate_getBlogCatePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 分类名称 | 李四 |
| status | query | 否 | integer | 状态 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultBlogCateRespVO` |

### 9. 更新blog分类

- 分组：管理后台 - blog分类
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/blog-cate/update`
- operationId：`BlogCate_updateBlogCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`BlogCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 25736 |
| name | 分类名称 | 是 | string | 李四 |
| coverImage | 缩略图 | 否 | ProductImageDO |  |
| status | 状态 | 否 | integer | 1 |
| rankNum | 排序 | 否 | integer |  |
| route | 路由 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - blog管理

### 1. 获得blog分类列表

- 分组：管理后台 - blog管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog/blog-cate-relation/list-by-blog-id`
- operationId：`Blog_getBlogCateRelationListByBlogId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| blogId | query | 是 | integer | 博客ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListBlogCateRelationDO` |

### 2. 创建blog管理

- 分组：管理后台 - blog管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/blog/create`
- operationId：`Blog_createBlog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`BlogSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 25673 |
| code | 编号 | 否 | string |  |
| title | 标题 | 是 | string |  |
| coverImage | 缩略图 | 是 | ProductImageDO |  |
| status | 状态 | 否 | integer | 1 |
| content | 页面内容 | 是 | string |  |
| rankNum | 排序 | 否 | integer |  |
| seoTitle | SEO标题 | 否 | string |  |
| seoKeyword | SEO关键词 | 否 | string |  |
| seoDescription | SEO描述 | 否 | string | 你猜 |
| likesNum | 点赞数 | 否 | integer | 0 |
| cateIds | blog分类 ID 列表 | 否 | array[integer] |  |
| route | 路由 | 否 | string |  |
| publishTime | 发布时间 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 3. 删除blog管理

- 分组：管理后台 - blog管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/blog/delete`
- operationId：`Blog_deleteBlog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 批量删除blog管理

- 分组：管理后台 - blog管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/blog/delete-list`
- operationId：`Blog_deleteBlogList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 导出blog管理 Excel

- 分组：管理后台 - blog管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog/export-excel`
- operationId：`Blog_exportBlogExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateId | query | 否 | integer | 分类id |  |
| code | query | 否 | string | 编号 |  |
| title | query | 否 | string | 标题 |  |
| status | query | 否 | integer | 状态 | 1 |
| id | query | 否 | integer | 编号 | 1 |
| creator | query | 否 | integer | 创建者ID |  |
| newTime | query | 否 | string |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 6. 获得blog管理

- 分组：管理后台 - blog管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog/get`
- operationId：`Blog_getBlog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBlogRespVO` |

### 7. 获得导入blog管理模板

- 分组：管理后台 - blog管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog/get-import-template`
- operationId：`Blog_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 8. 导入blog管理Excel

- 分组：管理后台 - blog管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/blog/import-excel`
- operationId：`Blog_importBlogExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBlogImportRespVO` |

### 9. 获得blog管理分页

- 分组：管理后台 - blog管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/blog/page`
- operationId：`Blog_getBlogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateId | query | 否 | integer | 分类id |  |
| code | query | 否 | string | 编号 |  |
| title | query | 否 | string | 标题 |  |
| status | query | 否 | integer | 状态 | 1 |
| id | query | 否 | integer | 编号 | 1 |
| creator | query | 否 | integer | 创建者ID |  |
| newTime | query | 否 | string |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultBlogRespVO` |

### 10. 更新blog管理

- 分组：管理后台 - blog管理
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/blog/update`
- operationId：`Blog_updateBlog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`BlogSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 25673 |
| code | 编号 | 否 | string |  |
| title | 标题 | 是 | string |  |
| coverImage | 缩略图 | 是 | ProductImageDO |  |
| status | 状态 | 否 | integer | 1 |
| content | 页面内容 | 是 | string |  |
| rankNum | 排序 | 否 | integer |  |
| seoTitle | SEO标题 | 否 | string |  |
| seoKeyword | SEO关键词 | 否 | string |  |
| seoDescription | SEO描述 | 否 | string | 你猜 |
| likesNum | 点赞数 | 否 | integer | 0 |
| cateIds | blog分类 ID 列表 | 否 | array[integer] |  |
| route | 路由 | 否 | string |  |
| publishTime | 发布时间 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - news分类

### 1. 创建news分类

- 分组：管理后台 - news分类
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/news-cate/create`
- operationId：`NewsCate_createNewsCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NewsCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 2718 |
| name | 分类名称 | 是 | string | 李四 |
| coverImage | 缩略图 | 否 | ProductImageDO |  |
| status | 状态 | 否 | integer | 1 |
| rankNum | 排序 | 否 | integer |  |
| route | 路由 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除news分类

- 分组：管理后台 - news分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/news-cate/delete`
- operationId：`NewsCate_deleteNewsCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除news分类

- 分组：管理后台 - news分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/news-cate/delete-list`
- operationId：`NewsCate_deleteNewsCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出news分类 Excel

- 分组：管理后台 - news分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news-cate/export-excel`
- operationId：`NewsCate_exportNewsCateExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 分类名称 | 李四 |
| status | query | 否 | integer | 状态 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得news分类

- 分组：管理后台 - news分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news-cate/get`
- operationId：`NewsCate_getNewsCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNewsCateRespVO` |

### 6. 获得导入news分类模板

- 分组：管理后台 - news分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news-cate/get-import-template`
- operationId：`NewsCate_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入news分类Excel

- 分组：管理后台 - news分类
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/news-cate/import-excel`
- operationId：`NewsCate_importNewsCateExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNewsCateImportRespVO` |

### 8. 获得news分类分页

- 分组：管理后台 - news分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news-cate/page`
- operationId：`NewsCate_getNewsCatePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 分类名称 | 李四 |
| status | query | 否 | integer | 状态 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultNewsCateRespVO` |

### 9. 更新news分类

- 分组：管理后台 - news分类
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/news-cate/update`
- operationId：`NewsCate_updateNewsCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NewsCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 2718 |
| name | 分类名称 | 是 | string | 李四 |
| coverImage | 缩略图 | 否 | ProductImageDO |  |
| status | 状态 | 否 | integer | 1 |
| rankNum | 排序 | 否 | integer |  |
| route | 路由 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - news管理

### 1. 创建news管理

- 分组：管理后台 - news管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/news/create`
- operationId：`News_createNews`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NewsSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 2771 |
| code | 编号 | 否 | string |  |
| title | 标题 | 是 | string |  |
| coverImage | 缩略图 | 是 | ProductImageDO |  |
| status | 状态 | 否 | integer | 2 |
| content | PC页面内容 | 是 | string |  |
| rankNum | 排序 | 否 | integer |  |
| seoTitle | SEO标题 | 否 | string |  |
| seoKeyword | SEO关键词 | 否 | string |  |
| seoDescription | SEO描述 | 否 | string | 你猜 |
| likesNum | 点赞数 | 否 | integer | 0 |
| cateIds | news分类 ID 列表 | 否 | array[integer] |  |
| route | 路由 | 否 | string |  |
| publishTime | 发布时间 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除news管理

- 分组：管理后台 - news管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/news/delete`
- operationId：`News_deleteNews`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除news管理

- 分组：管理后台 - news管理
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/news/delete-list`
- operationId：`News_deleteNewsList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出news管理 Excel

- 分组：管理后台 - news管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news/export-excel`
- operationId：`News_exportNewsExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateId | query | 否 | integer | 分类id |  |
| code | query | 否 | string | 编号 |  |
| title | query | 否 | string | 标题 |  |
| status | query | 否 | integer | 状态 | 2 |
| id | query | 否 | integer | 编号 | 1 |
| creator | query | 否 | integer | 创建者ID |  |
| newTime | query | 否 | string |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得news管理

- 分组：管理后台 - news管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news/get`
- operationId：`News_getNews`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNewsRespVO` |

### 6. 获得导入news管理模板

- 分组：管理后台 - news管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news/get-import-template`
- operationId：`News_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入news管理Excel

- 分组：管理后台 - news管理
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/news/import-excel`
- operationId：`News_importNewsExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNewsImportRespVO` |

### 8. 获得news分类关联列表

- 分组：管理后台 - news管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news/news-cate-relation/list-by-news-id`
- operationId：`News_getNewsCateRelationListByNewsId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| newsId | query | 是 | integer | 新闻ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListNewsCateRelationDO` |

### 9. 获得news管理分页

- 分组：管理后台 - news管理
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/news/page`
- operationId：`News_getNewsPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateId | query | 否 | integer | 分类id |  |
| code | query | 否 | string | 编号 |  |
| title | query | 否 | string | 标题 |  |
| status | query | 否 | integer | 状态 | 2 |
| id | query | 否 | integer | 编号 | 1 |
| creator | query | 否 | integer | 创建者ID |  |
| newTime | query | 否 | string |  |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultNewsRespVO` |

### 10. 更新news管理

- 分组：管理后台 - news管理
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/news/update`
- operationId：`News_updateNews`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NewsSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 2771 |
| code | 编号 | 否 | string |  |
| title | 标题 | 是 | string |  |
| coverImage | 缩略图 | 是 | ProductImageDO |  |
| status | 状态 | 否 | integer | 2 |
| content | PC页面内容 | 是 | string |  |
| rankNum | 排序 | 否 | integer |  |
| seoTitle | SEO标题 | 否 | string |  |
| seoKeyword | SEO关键词 | 否 | string |  |
| seoDescription | SEO描述 | 否 | string | 你猜 |
| likesNum | 点赞数 | 否 | integer | 0 |
| cateIds | news分类 ID 列表 | 否 | array[integer] |  |
| route | 路由 | 否 | string |  |
| publishTime | 发布时间 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 二维码

### 1. 创建二维码

- 分组：管理后台 - 二维码
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/download-qrcode/create`
- operationId：`DownloadQrcode_createDownloadQrcode`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DownloadQrcodeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 28763 |
| title | 标题 | 是 | string |  |
| status | 状态 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除二维码

- 分组：管理后台 - 二维码
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/download-qrcode/delete`
- operationId：`DownloadQrcode_deleteDownloadQrcode`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除二维码

- 分组：管理后台 - 二维码
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/download-qrcode/delete-list`
- operationId：`DownloadQrcode_deleteDownloadQrcodeList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出二维码 Excel

- 分组：管理后台 - 二维码
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/download-qrcode/export-excel`
- operationId：`DownloadQrcode_exportDownloadQrcodeExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| title | query | 否 | string | 标题 |  |
| creator | query | 否 | string | 创建者 |  |
| updater | query | 否 | string | 更新者 |  |
| visitCountOper1 | query | 否 | string | 访问次数操作符1 |  |
| visitCountOper2 | query | 否 | string | 访问次数操作符2 |  |
| visitCount1 | query | 否 | integer | 访问次数起始值 |  |
| visitCount2 | query | 否 | integer | 访问次数到达值 |  |
| clickCountOper1 | query | 否 | string | 总点击次数操作符1 |  |
| clickCountOper2 | query | 否 | string | 总点击次数操作符2 |  |
| clickCount1 | query | 否 | integer | 总点击次数起始值 |  |
| clickCount2 | query | 否 | integer | 总点击次数到达值 |  |
| iosClickCountOper1 | query | 否 | string | IOS点击次数操作符1 |  |
| iosClickCountOper2 | query | 否 | string | IOS点击次数操作符2 |  |
| iosClickCount1 | query | 否 | integer | IOS点击次数起始值 |  |
| iosClickCount2 | query | 否 | integer | IOS点击次数到达值 |  |
| googleClickCountOper1 | query | 否 | string | 谷歌点击次数操作符1 |  |
| googleClickCountOper2 | query | 否 | string | 谷歌点击次数操作符2 |  |
| googleClickCount1 | query | 否 | integer | 谷歌点击次数起始值 |  |
| googleClickCount2 | query | 否 | integer | 谷歌点击次数到达值 |  |
| apkClickCountOper1 | query | 否 | string | APK点击次数操作符1 |  |
| apkClickCountOper2 | query | 否 | string | APK点击次数操作符2 |  |
| apkClickCount1 | query | 否 | integer | APK点击次数起始值 |  |
| apkClickCount2 | query | 否 | integer | APK点击次数到达值 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得二维码

- 分组：管理后台 - 二维码
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/download-qrcode/get`
- operationId：`DownloadQrcode_getDownloadQrcode`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDownloadQrcodeRespVO` |

### 6. 获得导入二维码模板

- 分组：管理后台 - 二维码
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/download-qrcode/get-import-template`
- operationId：`DownloadQrcode_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入二维码Excel

- 分组：管理后台 - 二维码
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/download-qrcode/import-excel`
- operationId：`DownloadQrcode_importDownloadQrcodeExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDownloadQrcodeImportRespVO` |

### 8. 获得二维码分页（含统计）

- 分组：管理后台 - 二维码
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/download-qrcode/page`
- operationId：`DownloadQrcode_getDownloadQrcodePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| title | query | 否 | string | 标题 |  |
| creator | query | 否 | string | 创建者 |  |
| updater | query | 否 | string | 更新者 |  |
| visitCountOper1 | query | 否 | string | 访问次数操作符1 |  |
| visitCountOper2 | query | 否 | string | 访问次数操作符2 |  |
| visitCount1 | query | 否 | integer | 访问次数起始值 |  |
| visitCount2 | query | 否 | integer | 访问次数到达值 |  |
| clickCountOper1 | query | 否 | string | 总点击次数操作符1 |  |
| clickCountOper2 | query | 否 | string | 总点击次数操作符2 |  |
| clickCount1 | query | 否 | integer | 总点击次数起始值 |  |
| clickCount2 | query | 否 | integer | 总点击次数到达值 |  |
| iosClickCountOper1 | query | 否 | string | IOS点击次数操作符1 |  |
| iosClickCountOper2 | query | 否 | string | IOS点击次数操作符2 |  |
| iosClickCount1 | query | 否 | integer | IOS点击次数起始值 |  |
| iosClickCount2 | query | 否 | integer | IOS点击次数到达值 |  |
| googleClickCountOper1 | query | 否 | string | 谷歌点击次数操作符1 |  |
| googleClickCountOper2 | query | 否 | string | 谷歌点击次数操作符2 |  |
| googleClickCount1 | query | 否 | integer | 谷歌点击次数起始值 |  |
| googleClickCount2 | query | 否 | integer | 谷歌点击次数到达值 |  |
| apkClickCountOper1 | query | 否 | string | APK点击次数操作符1 |  |
| apkClickCountOper2 | query | 否 | string | APK点击次数操作符2 |  |
| apkClickCount1 | query | 否 | integer | APK点击次数起始值 |  |
| apkClickCount2 | query | 否 | integer | APK点击次数到达值 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDownloadQrcodePageRespVO` |

### 9. 更新二维码

- 分组：管理后台 - 二维码
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/download-qrcode/update`
- operationId：`DownloadQrcode_updateDownloadQrcode`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DownloadQrcodeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 28763 |
| title | 标题 | 是 | string |  |
| status | 状态 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 产品

### 1. 批量上下架产品

- 分组：管理后台 - 产品
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product/change-status`
- operationId：`Product_updateProductStatus`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductChangeStatusReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| ids | 产品ID | 是 | array[integer] | 17510 |
| status | 状态 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 创建产品

- 分组：管理后台 - 产品
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/product/create`
- operationId：`Product_createProduct`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 17510 |
| productType | 产品类型（普通产品=1，积分产品=2） | 否 | integer | 2 |
| productName | 产品名称 | 是 | string | 王五 |
| productCateId | 产品分类 | 是 | integer | 17525 |
| shippingTemplateId | 运费模板ID | 是 | integer | 6786 |
| route | 跳转路由 | 是 | string |  |
| intro | 产品简介 | 是 | string | 你说的对 |
| rankNum | 序号 | 否 | integer |  |
| status | 状态（1上架，2下架） | 是 | integer | 1 |
| seoTitle | SEO标题 | 否 | string |  |
| seoKeyword | SEO关键词 | 否 | string |  |
| seoDescription | SEO描述 | 否 | string | 你说的对 |
| singleUserExchangeLimit | 单用户兑换次数限制 | 否 | integer |  |
| singleProductExchangeLimit | 单次兑换数量限制 | 否 | integer |  |
| productAttrs | 产品规格类型关联列表 | 是 | array[ProductAttrReqVO] |  |
| productSkus | 产品规格列表 | 是 | array[ProductSkuSaveReqVO] |  |
| productDetails | 产品详情列表 | 否 | array[ProductDetailSaveReqVO] |  |
| brandId | 品牌id | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 3. 删除产品

- 分组：管理后台 - 产品
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product/delete`
- operationId：`Product_deleteProduct`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 批量删除产品

- 分组：管理后台 - 产品
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product/delete-list`
- operationId：`Product_deleteProductList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 获得产品

- 分组：管理后台 - 产品
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product/get`
- operationId：`Product_getProduct`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultProductRespVO` |

### 6. 获得产品分页

- 分组：管理后台 - 产品
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product/page`
- operationId：`Product_getProductPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | query | 否 | string | 产品编码 |  |
| productType | query | 否 | integer | 产品类型（普通产品=1，积分产品=2） | 2 |
| productName | query | 否 | string | 产品名称 | 王五 |
| productCateIdList | query | 否 | array[integer] | 产品分类ID列表（查询多个产品分类） | 17525 |
| productCateId | query | 否 | integer | 产品分类ID（查询单个产品分类） |  |
| status | query | 否 | integer | 状态 | 1 |
| ids | query | 否 | array[integer] | 产品ID列表 |  |
| shippingTemplateIds | query | 否 | array[integer] | 运费模板 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultProductPageRespVO` |

### 7. 获得产品规格类型关联列表

- 分组：管理后台 - 产品
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product/product-attr/list-by-product-id`
- operationId：`Product_getProductAttrListByProductId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productId | query | 是 | integer | 产品ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListProductAttrDO` |

### 8. 获得产品详情列表

- 分组：管理后台 - 产品
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product/product-detail/list-by-product-id`
- operationId：`Product_getProductDetailListByProductId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productId | query | 是 | integer | 产品ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListProductDetailDO` |

### 9. 获得产品规格列表

- 分组：管理后台 - 产品
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product/product-sku/list-by-product-id`
- operationId：`Product_getProductSkuListByProductId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productId | query | 是 | integer | 产品ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListProductSkuDO` |

### 10. 获得产品及规格列表-优惠券中使用

- 分组：管理后台 - 产品
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product/product/sku-list`
- operationId：`Product_getProductSkuList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | query | 否 | string | 产品编码 |  |
| productName | query | 否 | string | 产品名称 |  |
| skuNo | query | 否 | string | 产品SKU |  |
| productType | query | 否 | integer | 产品类型（普通产品=1，积分产品=2） | 2 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultProductSkuRespVO` |

### 11. 更新产品

- 分组：管理后台 - 产品
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product/update`
- operationId：`Product_updateProduct`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 17510 |
| productType | 产品类型（普通产品=1，积分产品=2） | 否 | integer | 2 |
| productName | 产品名称 | 是 | string | 王五 |
| productCateId | 产品分类 | 是 | integer | 17525 |
| shippingTemplateId | 运费模板ID | 是 | integer | 6786 |
| route | 跳转路由 | 是 | string |  |
| intro | 产品简介 | 是 | string | 你说的对 |
| rankNum | 序号 | 否 | integer |  |
| status | 状态（1上架，2下架） | 是 | integer | 1 |
| seoTitle | SEO标题 | 否 | string |  |
| seoKeyword | SEO关键词 | 否 | string |  |
| seoDescription | SEO描述 | 否 | string | 你说的对 |
| singleUserExchangeLimit | 单用户兑换次数限制 | 否 | integer |  |
| singleProductExchangeLimit | 单次兑换数量限制 | 否 | integer |  |
| productAttrs | 产品规格类型关联列表 | 是 | array[ProductAttrReqVO] |  |
| productSkus | 产品规格列表 | 是 | array[ProductSkuSaveReqVO] |  |
| productDetails | 产品详情列表 | 否 | array[ProductDetailSaveReqVO] |  |
| brandId | 品牌id | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 产品分类

### 1. 修改产品分类启用/停用状态

- 分组：管理后台 - 产品分类
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product-cate/change-status`
- operationId：`ProductCate_updateProductCateStatus`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductCateUpdateStatusReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 17391 |
| status | 状态（1启用，2停用） | 是 | integer | 2 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 创建产品分类

- 分组：管理后台 - 产品分类
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/product-cate/create`
- operationId：`ProductCate_createProductCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 17391 |
| cateType | 类型（普通产品=1，积分产品=2） | 否 | integer | 2 |
| cateName | 产品分类名称 | 是 | string | 赵六 |
| status | 状态 | 是 | integer | 2 |
| rankNum | 排序 | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 3. 删除产品分类

- 分组：管理后台 - 产品分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-cate/delete`
- operationId：`ProductCate_deleteProductCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 批量删除产品分类

- 分组：管理后台 - 产品分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-cate/delete-list`
- operationId：`ProductCate_deleteProductCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 获得产品分类

- 分组：管理后台 - 产品分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product-cate/get`
- operationId：`ProductCate_getProductCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultProductCateSingleRespVO` |

### 6. 获得产品分类分页

- 分组：管理后台 - 产品分类
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product-cate/page`
- operationId：`ProductCate_getProductCatePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| cateType | query | 否 | integer | 类型 | 2 |
| cateName | query | 否 | string | 产品分类名称 | 赵六 |
| status | query | 否 | integer | 状态 | 2 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultProductCateRespVO` |

### 7. 更新产品分类

- 分组：管理后台 - 产品分类
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product-cate/update`
- operationId：`ProductCate_updateProductCate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductCateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 17391 |
| cateType | 类型（普通产品=1，积分产品=2） | 否 | integer | 2 |
| cateName | 产品分类名称 | 是 | string | 赵六 |
| status | 状态 | 是 | integer | 2 |
| rankNum | 排序 | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 产品属性

### 1. 启用/停用产品属性状态

- 分组：管理后台 - 产品属性
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product-attr-type/change-status`
- operationId：`ProductAttrType_updateProductAttrTypeStatus`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductAttrTypeChangeStatusReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 5850 |
| status | 状态 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 创建产品属性

- 分组：管理后台 - 产品属性
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/product-attr-type/create`
- operationId：`ProductAttrType_createProductAttrType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductAttrTypeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 5850 |
| type | 属性类型：1-颜色属性（有色卡），2-普通属性 | 是 | integer | 2 |
| name | 属性名称 | 是 | string | 王五 |
| status | 状态 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 你说的对 |
| rankNum | 排序号 | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 3. 删除产品属性

- 分组：管理后台 - 产品属性
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-attr-type/delete`
- operationId：`ProductAttrType_deleteProductAttrType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 批量删除产品属性

- 分组：管理后台 - 产品属性
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-attr-type/delete-list`
- operationId：`ProductAttrType_deleteProductAttrTypeList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 获得产品属性

- 分组：管理后台 - 产品属性
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product-attr-type/get`
- operationId：`ProductAttrType_getProductAttrType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultProductAttrTypeRespVO` |

### 6. 获得产品属性分页

- 分组：管理后台 - 产品属性
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product-attr-type/page`
- operationId：`ProductAttrType_getProductAttrTypePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | query | 否 | integer | 属性类型 | 2 |
| name | query | 否 | string | 属性名称 | 王五 |
| status | query | 否 | integer | 状态 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultProductAttrTypeRespVO` |

### 7. 更新产品属性

- 分组：管理后台 - 产品属性
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product-attr-type/update`
- operationId：`ProductAttrType_updateProductAttrType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductAttrTypeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 5850 |
| type | 属性类型：1-颜色属性（有色卡），2-普通属性 | 是 | integer | 2 |
| name | 属性名称 | 是 | string | 王五 |
| status | 状态 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 你说的对 |
| rankNum | 排序号 | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 产品属性值

### 1. 创建产品属性值

- 分组：管理后台 - 产品属性值
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/product-attr-data/create`
- operationId：`ProductAttrData_createProductAttrData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductAttrDataSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 26147 |
| productAttrTypeId | 关联产品属性表的主键ID | 是 | integer | 28627 |
| attrValue | 属性值名称 | 是 | string |  |
| color | 色卡 | 否 | array[string] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除产品属性值

- 分组：管理后台 - 产品属性值
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-attr-data/delete`
- operationId：`ProductAttrData_deleteProductAttrData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除产品属性值

- 分组：管理后台 - 产品属性值
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-attr-data/delete-list`
- operationId：`ProductAttrData_deleteProductAttrDataList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得产品属性值

- 分组：管理后台 - 产品属性值
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product-attr-data/get`
- operationId：`ProductAttrData_getProductAttrData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultProductAttrDataRespVO` |

### 5. 获得产品属性值分页

- 分组：管理后台 - 产品属性值
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product-attr-data/page`
- operationId：`ProductAttrData_getProductAttrDataPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productAttrTypeId | query | 否 | integer | 关联产品属性表的主键ID | 28627 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultProductAttrDataRespVO` |

### 6. 更新产品属性值

- 分组：管理后台 - 产品属性值
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product-attr-data/update`
- operationId：`ProductAttrData_updateProductAttrData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductAttrDataSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 26147 |
| productAttrTypeId | 关联产品属性表的主键ID | 是 | integer | 28627 |
| attrValue | 属性值名称 | 是 | string |  |
| color | 色卡 | 否 | array[string] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 代码生成器

### 1. 基于数据库的表结构，创建代码生成器的表和字段定义

- 分组：管理后台 - 代码生成器
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/codegen/create-list`
- operationId：`Codegen_createCodegenList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CodegenCreateListReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| dataSourceConfigId | 数据源配置的编号 | 是 | integer | 1 |
| tableNames | 表名数组 | 是 | array[string] | [1, 2, 3] |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListLong` |

### 2. 获得数据库自带的表定义列表

- 分组：管理后台 - 代码生成器
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/codegen/db/table/list`
- operationId：`Codegen_getDatabaseTableList`
- 描述：会过滤掉已经导入 Codegen 的表

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| dataSourceConfigId | query | 是 | integer | 数据源配置的编号 | 1 |
| name | query | 否 | string | 表名，模糊匹配 | yudao |
| comment | query | 否 | string | 描述，模糊匹配 | 芋道 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDatabaseTableRespVO` |

### 3. 删除数据库的表和字段定义

- 分组：管理后台 - 代码生成器
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/codegen/delete`
- operationId：`Codegen_deleteCodegen`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tableId | query | 是 | integer | 表编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 批量删除数据库的表和字段定义

- 分组：管理后台 - 代码生成器
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/codegen/delete-list`
- operationId：`Codegen_deleteCodegenList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tableIds | query | 是 | array[integer] | 表编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 获得表和字段的明细

- 分组：管理后台 - 代码生成器
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/codegen/detail`
- operationId：`Codegen_getCodegenDetail`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tableId | query | 是 | integer | 表编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultCodegenDetailRespVO` |

### 6. 下载生成代码

- 分组：管理后台 - 代码生成器
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/codegen/download`
- operationId：`Codegen_downloadCodegen`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tableId | query | 是 | integer | 表编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 预览生成代码

- 分组：管理后台 - 代码生成器
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/codegen/preview`
- operationId：`Codegen_previewCodegen`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tableId | query | 是 | integer | 表编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListCodegenPreviewRespVO` |

### 8. 基于数据库的表结构，同步数据库的表和字段定义

- 分组：管理后台 - 代码生成器
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/codegen/sync-from-db`
- operationId：`Codegen_syncCodegenFromDB`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tableId | query | 是 | integer | 表编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 9. 获得表定义列表

- 分组：管理后台 - 代码生成器
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/codegen/table/list`
- operationId：`Codegen_getCodegenTableList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| dataSourceConfigId | query | 是 | integer | 数据源配置的编号 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListCodegenTableRespVO` |

### 10. 获得表定义分页

- 分组：管理后台 - 代码生成器
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/codegen/table/page`
- operationId：`Codegen_getCodegenTablePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tableName | query | 否 | string | 表名称，模糊匹配 | yudao |
| tableComment | query | 否 | string | 表描述，模糊匹配 | 芋道 |
| className | query | 否 | string | 实体，模糊匹配 | Yudao |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultCodegenTableRespVO` |

### 11. 更新数据库的表和字段定义

- 分组：管理后台 - 代码生成器
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/codegen/update`
- operationId：`Codegen_updateCodegen`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CodegenUpdateReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| table |  | 是 | CodegenTableSaveReqVO |  |
| columns |  | 是 | array[CodegenColumnSaveReqVO] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 协议

### 1. 创建协议

- 分组：管理后台 - 协议
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/agreement/create`
- operationId：`Agreement_createAgreement`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AgreementSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 11878 |
| terminal | 终端(1web 2app) | 是 | string |  |
| type | 类型（1隐私协议 2用户协议） | 是 | integer | 2 |
| title | 标题 | 是 | string |  |
| content | 内容 | 是 | string |  |
| status | 状态 (1正常 2停用) | 否 | integer | 2 |
| lang | 语言 (en 英语 de 德语 ja 日语) | 是 | string |  |
| rankNum | 排序号 | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除协议

- 分组：管理后台 - 协议
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/agreement/delete`
- operationId：`Agreement_deleteAgreement`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除协议

- 分组：管理后台 - 协议
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/agreement/delete-list`
- operationId：`Agreement_deleteAgreementList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出协议 Excel

- 分组：管理后台 - 协议
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/agreement/export-excel`
- operationId：`Agreement_exportAgreementExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| terminal | query | 否 | string | 终端(1web 2app) |  |
| type | query | 否 | integer | 类型（1隐私协议 2用户协议） | 2 |
| title | query | 否 | string | 标题 |  |
| content | query | 否 | string | 内容 |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 2 |
| lang | query | 否 | string | 语言 (en 英语 de 德语 ja 日语) |  |
| rankNum | query | 否 | integer | 排序号 |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 3044 |
| userId | query | 否 | integer | 权限用户ID | 25518 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得协议

- 分组：管理后台 - 协议
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/agreement/get`
- operationId：`Agreement_getAgreement`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAgreementRespVO` |

### 6. 获得导入协议模板

- 分组：管理后台 - 协议
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/agreement/get-import-template`
- operationId：`Agreement_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入协议Excel

- 分组：管理后台 - 协议
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/agreement/import-excel`
- operationId：`Agreement_importAgreementExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAgreementImportRespVO` |

### 8. 获得协议分页

- 分组：管理后台 - 协议
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/agreement/page`
- operationId：`Agreement_getAgreementPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| terminal | query | 否 | string | 终端(1web 2app) |  |
| type | query | 否 | integer | 类型（1隐私协议 2用户协议） | 2 |
| title | query | 否 | string | 标题 |  |
| content | query | 否 | string | 内容 |  |
| status | query | 否 | integer | 状态 (1正常 2停用) | 2 |
| lang | query | 否 | string | 语言 (en 英语 de 德语 ja 日语) |  |
| rankNum | query | 否 | integer | 排序号 |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 3044 |
| userId | query | 否 | integer | 权限用户ID | 25518 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAgreementRespVO` |

### 9. 更新协议

- 分组：管理后台 - 协议
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/agreement/update`
- operationId：`Agreement_updateAgreement`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AgreementSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 11878 |
| terminal | 终端(1web 2app) | 是 | string |  |
| type | 类型（1隐私协议 2用户协议） | 是 | integer | 2 |
| title | 标题 | 是 | string |  |
| content | 内容 | 是 | string |  |
| status | 状态 (1正常 2停用) | 否 | integer | 2 |
| lang | 语言 (en 英语 de 德语 ja 日语) | 是 | string |  |
| rankNum | 排序号 | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 参数配置

### 1. 创建参数配置

- 分组：管理后台 - 参数配置
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/config/create`
- operationId：`Config_createConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ConfigSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 参数配置序号 | 否 | integer | 1024 |
| category | 参数分组 | 是 | string | biz |
| name | 参数名称 | 是 | string | 数据库名 |
| key | 参数键名 | 是 | string | yunai.db.username |
| value | 参数键值 | 是 | string | 1024 |
| visible | 是否可见 | 是 | boolean | True |
| remark | 备注 | 否 | string | 备注一下很帅气！ |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除参数配置

- 分组：管理后台 - 参数配置
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/config/delete`
- operationId：`Config_deleteConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除参数配置

- 分组：管理后台 - 参数配置
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/config/delete-list`
- operationId：`Config_deleteConfigList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出参数配置

- 分组：管理后台 - 参数配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/config/export-excel`
- operationId：`Config_exportConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 数据源名称，模糊匹配 | 名称 |
| key | query | 否 | string | 参数键名，模糊匹配 | yunai.db.username |
| type | query | 否 | integer | 参数类型，参见 SysConfigTypeEnum 枚举 | 1 |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得参数配置

- 分组：管理后台 - 参数配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/config/get`
- operationId：`Config_getConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultConfigRespVO` |

### 6. 根据参数键名查询参数值

- 分组：管理后台 - 参数配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/config/get-value-by-key`
- operationId：`Config_getConfigKey`
- 描述：不可见的配置，不允许返回给前端

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| key | query | 是 | string | 参数键 | yunai.biz.username |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 7. 获取参数配置分页

- 分组：管理后台 - 参数配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/config/page`
- operationId：`Config_getConfigPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 数据源名称，模糊匹配 | 名称 |
| key | query | 否 | string | 参数键名，模糊匹配 | yunai.db.username |
| type | query | 否 | integer | 参数类型，参见 SysConfigTypeEnum 枚举 | 1 |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultConfigRespVO` |

### 8. 修改参数配置

- 分组：管理后台 - 参数配置
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/config/update`
- operationId：`Config_updateConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ConfigSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 参数配置序号 | 否 | integer | 1024 |
| category | 参数分组 | 是 | string | biz |
| name | 参数名称 | 是 | string | 数据库名 |
| key | 参数键名 | 是 | string | yunai.db.username |
| value | 参数键值 | 是 | string | 1024 |
| visible | 是否可见 | 是 | boolean | True |
| remark | 备注 | 否 | string | 备注一下很帅气！ |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 合作联系数据

### 1. 创建合作联系数据

- 分组：管理后台 - 合作联系数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/cooperation/create`
- operationId：`Cooperation_createCooperation`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CooperationSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 22204 |
| name | 姓名 | 是 | string | 芋艿 |
| email | 邮箱 | 是 | string |  |
| address | 公司名称或地址 | 是 | string |  |
| cooperationType | 合作类型 | 是 | string | 2 |
| cooperationDetail | 合作详情 | 否 | string |  |
| lang | 语言 | 是 | string |  |
| ip | IP | 是 | string |  |
| requestStatus | APP接口同步状态 | 是 | integer | 1 |
| requestResult | 请求结果 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除合作联系数据

- 分组：管理后台 - 合作联系数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/cooperation/delete`
- operationId：`Cooperation_deleteCooperation`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除合作联系数据

- 分组：管理后台 - 合作联系数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/cooperation/delete-list`
- operationId：`Cooperation_deleteCooperationList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出合作联系数据 Excel

- 分组：管理后台 - 合作联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/cooperation/export-excel`
- operationId：`Cooperation_exportCooperationExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 姓名 | 芋艿 |
| email | query | 否 | string | 邮箱 |  |
| address | query | 否 | string | 公司名称或地址 |  |
| cooperationType | query | 否 | string | 合作类型 | 2 |
| createTime | query | 否 | array[string] | 提交时间 |  |
| requestStatus | query | 否 | integer | APP接口同步状态 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得合作联系数据

- 分组：管理后台 - 合作联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/cooperation/get`
- operationId：`Cooperation_getCooperation`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultCooperationRespVO` |

### 6. 获得导入合作联系数据模板

- 分组：管理后台 - 合作联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/cooperation/get-import-template`
- operationId：`Cooperation_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入合作联系数据Excel

- 分组：管理后台 - 合作联系数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/cooperation/import-excel`
- operationId：`Cooperation_importCooperationExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultCooperationImportRespVO` |

### 8. 获得合作联系数据分页

- 分组：管理后台 - 合作联系数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/cooperation/page`
- operationId：`Cooperation_getCooperationPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 姓名 | 芋艿 |
| email | query | 否 | string | 邮箱 |  |
| address | query | 否 | string | 公司名称或地址 |  |
| cooperationType | query | 否 | string | 合作类型 | 2 |
| createTime | query | 否 | array[string] | 提交时间 |  |
| requestStatus | query | 否 | integer | APP接口同步状态 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultCooperationRespVO` |

### 9. 更新合作联系数据

- 分组：管理后台 - 合作联系数据
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/cooperation/update`
- operationId：`Cooperation_updateCooperation`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CooperationSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 22204 |
| name | 姓名 | 是 | string | 芋艿 |
| email | 邮箱 | 是 | string |  |
| address | 公司名称或地址 | 是 | string |  |
| cooperationType | 合作类型 | 是 | string | 2 |
| cooperationDetail | 合作详情 | 否 | string |  |
| lang | 语言 | 是 | string |  |
| ip | IP | 是 | string |  |
| requestStatus | APP接口同步状态 | 是 | integer | 1 |
| requestResult | 请求结果 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 售后

### 1. 导出售后 Excel

- 分组：管理后台 - 售后
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/order-after-sale/export-excel`
- operationId：`OrderAfterSale_exportOrderAfterSaleExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 否 | array[integer] | 集合ID |  |
| afterSaleMessageId | query | 否 | integer | 售后信息ID | 31115 |
| afterSalesOrderNo | query | 否 | string | 售后单号 |  |
| oaReferenceNo | query | 否 | string | OA通讯编号 |  |
| serviceOrderNo | query | 否 | string | 咨询订单号 |  |
| country | query | 否 | string | 国家 |  |
| status | query | 否 | integer | 售后状态 | 1 |
| afterSalesSolution | query | 否 | integer | 售后方案 |  |
| oaStatus | query | 否 | integer | oa售后状态 | 1 |
| oaAfterSalesId | query | 否 | integer | oa售后Id |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获得售后

- 分组：管理后台 - 售后
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/order-after-sale/get`
- operationId：`OrderAfterSale_getOrderAfterSale`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer |  |  |
| orderId | query | 是 |  | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOrderAfterSaleRespVO` |

### 3. 获得售后分页

- 分组：管理后台 - 售后
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/order-after-sale/page`
- operationId：`OrderAfterSale_getOrderAfterSalePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 否 | array[integer] | 集合ID |  |
| afterSaleMessageId | query | 否 | integer | 售后信息ID | 31115 |
| afterSalesOrderNo | query | 否 | string | 售后单号 |  |
| oaReferenceNo | query | 否 | string | OA通讯编号 |  |
| serviceOrderNo | query | 否 | string | 咨询订单号 |  |
| country | query | 否 | string | 国家 |  |
| status | query | 否 | integer | 售后状态 | 1 |
| afterSalesSolution | query | 否 | integer | 售后方案 |  |
| oaStatus | query | 否 | integer | oa售后状态 | 1 |
| oaAfterSalesId | query | 否 | integer | oa售后Id |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultOrderAfterSaleDO` |

## 管理后台 - 售后政策

### 1. 创建售后政策

- 分组：管理后台 - 售后政策
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/after-sales-policy/create`
- operationId：`AfterSalesPolicy_createAfterSalesPolicy`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AfterSalesPolicySaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 14586 |
| brandId | 品牌ID | 是 | integer | 9150 |
| title | 标题 | 是 | string |  |
| content | 内容 | 是 | string |  |
| status | 状态 | 否 | integer | 2 |
| lang | 语言 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除售后政策

- 分组：管理后台 - 售后政策
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/after-sales-policy/delete`
- operationId：`AfterSalesPolicy_deleteAfterSalesPolicy`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除售后政策

- 分组：管理后台 - 售后政策
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/after-sales-policy/delete-list`
- operationId：`AfterSalesPolicy_deleteAfterSalesPolicyList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出售后政策 Excel

- 分组：管理后台 - 售后政策
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-policy/export-excel`
- operationId：`AfterSalesPolicy_exportAfterSalesPolicyExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| brandId | query | 否 | integer | 品牌ID | 9150 |
| title | query | 否 | string | 标题 |  |
| content | query | 否 | string | 内容 |  |
| status | query | 否 | integer | 状态 | 2 |
| lang | query | 否 | string | 语言 |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 17093 |
| userId | query | 否 | integer | 权限用户ID | 758 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得售后政策

- 分组：管理后台 - 售后政策
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-policy/get`
- operationId：`AfterSalesPolicy_getAfterSalesPolicy`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAfterSalesPolicyRespVO` |

### 6. 获得导入售后政策模板

- 分组：管理后台 - 售后政策
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-policy/get-import-template`
- operationId：`AfterSalesPolicy_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入售后政策Excel

- 分组：管理后台 - 售后政策
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/after-sales-policy/import-excel`
- operationId：`AfterSalesPolicy_importAfterSalesPolicyExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAfterSalesPolicyImportRespVO` |

### 8. 获得售后政策分页

- 分组：管理后台 - 售后政策
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-policy/page`
- operationId：`AfterSalesPolicy_getAfterSalesPolicyPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| brandId | query | 否 | integer | 品牌ID | 9150 |
| title | query | 否 | string | 标题 |  |
| content | query | 否 | string | 内容 |  |
| status | query | 否 | integer | 状态 | 2 |
| lang | query | 否 | string | 语言 |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 17093 |
| userId | query | 否 | integer | 权限用户ID | 758 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAfterSalesPolicyRespVO` |

### 9. 更新售后政策

- 分组：管理后台 - 售后政策
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/after-sales-policy/update`
- operationId：`AfterSalesPolicy_updateAfterSalesPolicy`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AfterSalesPolicySaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 14586 |
| brandId | 品牌ID | 是 | integer | 9150 |
| title | 标题 | 是 | string |  |
| content | 内容 | 是 | string |  |
| status | 状态 | 否 | integer | 2 |
| lang | 语言 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 售后政策-品牌

### 1. 创建售后政策-品牌

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/after-sales-brand/create`
- operationId：`AfterSalesBrand_createAfterSalesBrand`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AfterSalesBrandSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 25519 |
| brandName | 品牌名称 | 是 | string | 赵六 |
| status | 状态 | 否 | integer | 2 |
| rankNum | 排序号 | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除售后政策-品牌

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/after-sales-brand/delete`
- operationId：`AfterSalesBrand_deleteAfterSalesBrand`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除售后政策-品牌

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/after-sales-brand/delete-list`
- operationId：`AfterSalesBrand_deleteAfterSalesBrandList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出售后政策-品牌 Excel

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-brand/export-excel`
- operationId：`AfterSalesBrand_exportAfterSalesBrandExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| brandName | query | 否 | string | 品牌名称 | 赵六 |
| status | query | 否 | integer | 状态 | 2 |
| rankNum | query | 否 | integer | 排序号 |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 17576 |
| userId | query | 否 | integer | 权限用户ID | 13390 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得售后政策-品牌

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-brand/get`
- operationId：`AfterSalesBrand_getAfterSalesBrand`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAfterSalesBrandRespVO` |

### 6. 获得导入售后政策-品牌模板

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-brand/get-import-template`
- operationId：`AfterSalesBrand_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入售后政策-品牌Excel

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/after-sales-brand/import-excel`
- operationId：`AfterSalesBrand_importAfterSalesBrandExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAfterSalesBrandImportRespVO` |

### 8. 获得可用的品牌列表

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-brand/list-available`
- operationId：`AfterSalesBrand_getAvailableBrandList`
- 描述：获取所有状态为启用(status=1)的品牌列表，用于前端在新增售后政策时选择品牌。
返回结果按排序号(rankNum)升序、ID降序排列。
已软删除的品牌不会出现在列表中。

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListAfterSalesBrandRespVO` |

### 9. 获得售后政策-品牌分页

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/after-sales-brand/page`
- operationId：`AfterSalesBrand_getAfterSalesBrandPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| brandName | query | 否 | string | 品牌名称 | 赵六 |
| status | query | 否 | integer | 状态 | 2 |
| rankNum | query | 否 | integer | 排序号 |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 17576 |
| userId | query | 否 | integer | 权限用户ID | 13390 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAfterSalesBrandRespVO` |

### 10. 更新售后政策-品牌

- 分组：管理后台 - 售后政策-品牌
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/after-sales-brand/update`
- operationId：`AfterSalesBrand_updateAfterSalesBrand`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AfterSalesBrandSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 25519 |
| brandName | 品牌名称 | 是 | string | 赵六 |
| status | 状态 | 否 | integer | 2 |
| rankNum | 排序号 | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 国家信息

### 1. 创建国家信息

- 分组：管理后台 - 国家信息
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/address-country/create`
- operationId：`AddressCountry_createAddressCountry`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AddressCountrySaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 4792 |
| lingxingCountryCode | 领星国家代码 | 否 | string |  |
| paypalCountryCode | paypal国家代码 | 否 | string |  |
| nameEn | 英文名 | 否 | string |  |
| nameCn | 中文名 | 否 | string |  |
| status | 是否支持(1是 2否) | 是 | integer | 2 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除国家信息

- 分组：管理后台 - 国家信息
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/address-country/delete`
- operationId：`AddressCountry_deleteAddressCountry`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除国家信息

- 分组：管理后台 - 国家信息
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/address-country/delete-list`
- operationId：`AddressCountry_deleteAddressCountryList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出国家信息 Excel

- 分组：管理后台 - 国家信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/address-country/export-excel`
- operationId：`AddressCountry_exportAddressCountryExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| lingxingCountryCode | query | 否 | string | 领星国家代码 |  |
| paypalCountryCode | query | 否 | string | paypal国家代码 |  |
| nameEn | query | 否 | string | 英文名 |  |
| nameCn | query | 否 | string | 中文名 |  |
| status | query | 否 | integer | 是否支持(1是 2否) | 2 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 11472 |
| userId | query | 否 | integer | 权限用户ID | 25927 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得国家信息

- 分组：管理后台 - 国家信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/address-country/get`
- operationId：`AddressCountry_getAddressCountry`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAddressCountryRespVO` |

### 6. 获得导入国家信息模板

- 分组：管理后台 - 国家信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/address-country/get-import-template`
- operationId：`AddressCountry_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入国家信息Excel

- 分组：管理后台 - 国家信息
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/address-country/import-excel`
- operationId：`AddressCountry_importAddressCountryExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAddressCountryImportRespVO` |

### 8. 获得运费规则国家下拉选项（弃用）

- 分组：管理后台 - 国家信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/address-country/options-for-shipping`
- operationId：`AddressCountry_getOptionsForShipping`
- 描述：获取所有状态为启用(status=1)的国家列表，用于前端在新增运费规则时选择国家。
且排除在同一运费模板下已配置的国家。同时配置一个国家在一个模板的不同规则下会报错


#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| shippingTemplateId | query | 是 | integer |  |  |
| shippingRuleId | query | 否 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListAddressCountrySimpleRespVO` |

### 9. 获得国家信息分页

- 分组：管理后台 - 国家信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/address-country/page`
- operationId：`AddressCountry_getAddressCountryPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| lingxingCountryCode | query | 否 | string | 领星国家代码 |  |
| paypalCountryCode | query | 否 | string | paypal国家代码 |  |
| nameEn | query | 否 | string | 英文名 |  |
| nameCn | query | 否 | string | 中文名 |  |
| status | query | 否 | integer | 是否支持(1是 2否) | 2 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 11472 |
| userId | query | 否 | integer | 权限用户ID | 25927 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultAddressCountryRespVO` |

### 10. 更新国家信息

- 分组：管理后台 - 国家信息
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/address-country/update`
- operationId：`AddressCountry_updateAddressCountry`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AddressCountrySaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 4792 |
| lingxingCountryCode | 领星国家代码 | 否 | string |  |
| paypalCountryCode | paypal国家代码 | 否 | string |  |
| nameEn | 英文名 | 否 | string |  |
| nameCn | 中文名 | 否 | string |  |
| status | 是否支持(1是 2否) | 是 | integer | 2 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 11. 批量更新国家信息状态

- 分组：管理后台 - 国家信息
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/address-country/update-status-list`
- operationId：`AddressCountry_updateAddressCountryStatusList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] |  |  |
| status | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 地区

### 1. 获得 IP 对应的地区名

- 分组：管理后台 - 地区
- 请求方式：`GET`
- 接口路径：`/admin-api/system/area/get-by-ip`
- operationId：`Area_getAreaByIp`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ip | query | 是 | string | IP |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 2. 获得地区树

- 分组：管理后台 - 地区
- 请求方式：`GET`
- 接口路径：`/admin-api/system/area/tree`
- operationId：`Area_getAreaTree`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListAreaNodeRespVO` |

## 管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)

### 1. 创建基础数据-说明

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/article/create`
- operationId：`Article_createArticle`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ArticleSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 29288 |
| title | 标题 | 是 | string |  |
| articleType | 说明类型（数据字典配置） | 是 | string | 2 |
| content | 内容 | 是 | string |  |
| status | 状态 | 否 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除基础数据-说明

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/article/delete`
- operationId：`Article_deleteArticle`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除基础数据-说明

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/article/delete-list`
- operationId：`Article_deleteArticleList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出基础数据-说明 Excel

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/article/export-excel`
- operationId：`Article_exportArticleExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| title | query | 否 | string | 标题 |  |
| articleType | query | 否 | string | 说明类型（数据字典配置） | 2 |
| content | query | 否 | string | 内容 |  |
| status | query | 否 | integer | 状态 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 30831 |
| userId | query | 否 | integer | 权限用户ID | 10123 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得基础数据-说明

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/article/get`
- operationId：`Article_getArticle`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultArticleRespVO` |

### 6. 获得导入基础数据-说明模板

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/article/get-import-template`
- operationId：`Article_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入基础数据-说明Excel

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/article/import-excel`
- operationId：`Article_importArticleExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultArticleImportRespVO` |

### 8. 获得基础数据-说明分页

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/article/page`
- operationId：`Article_getArticlePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| title | query | 否 | string | 标题 |  |
| articleType | query | 否 | string | 说明类型（数据字典配置） | 2 |
| content | query | 否 | string | 内容 |  |
| status | query | 否 | integer | 状态 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 30831 |
| userId | query | 否 | integer | 权限用户ID | 10123 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultArticleRespVO` |

### 9. 更新基础数据-说明

- 分组：管理后台 - 基础数据-说明(售后说明，运费说明，售后问题等)
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/article/update`
- operationId：`Article_updateArticle`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ArticleSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 29288 |
| title | 标题 | 是 | string |  |
| articleType | 说明类型（数据字典配置） | 是 | string | 2 |
| content | 内容 | 是 | string |  |
| status | 状态 | 否 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 字典数据

### 1. 新增字典数据

- 分组：管理后台 - 字典数据
- 请求方式：`POST`
- 接口路径：`/admin-api/system/dict-data/create`
- operationId：`DictData_createDictData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DictDataSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 字典数据编号 | 否 | integer | 1024 |
| sort | 显示顺序 | 是 | integer | 1024 |
| label | 字典标签 | 是 | string | 芋道 |
| value | 字典值 | 是 | string | iocoder |
| dictType | 字典类型 | 是 | string | sys_common_sex |
| status | 状态,见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| colorType | 颜色类型,default、primary、success、info、warning、danger | 否 | string | default |
| cssClass | css 样式 | 否 | string | btn-visible |
| remark | 备注 | 否 | string | 我是一个角色 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除字典数据

- 分组：管理后台 - 字典数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/dict-data/delete`
- operationId：`DictData_deleteDictData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除字典数据

- 分组：管理后台 - 字典数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/dict-data/delete-list`
- operationId：`DictData_deleteDictDataList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出字典数据

- 分组：管理后台 - 字典数据
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-data/export-excel`
- operationId：`DictData_export`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| label | query | 否 | string | 字典标签 | 芋道 |
| dictType | query | 否 | string | 字典类型，模糊匹配 | sys_common_sex |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. /查询字典数据详细

- 分组：管理后台 - 字典数据
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-data/get`
- operationId：`DictData_getDictData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDictDataRespVO` |

### 6. 获得全部字典数据列表

- 分组：管理后台 - 字典数据
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-data/list-all-simple`
- operationId：`DictData_getSimpleDictDataList`
- 描述：一般用于管理后台缓存字典数据在本地

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDictDataSimpleRespVO` |

### 7. 获得字典类型的分页

- 分组：管理后台 - 字典数据
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-data/page`
- operationId：`DictData_getDictTypePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| label | query | 否 | string | 字典标签 | 芋道 |
| dictType | query | 否 | string | 字典类型，模糊匹配 | sys_common_sex |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDictDataRespVO` |

### 8. 获得全部字典数据列表

- 分组：管理后台 - 字典数据
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-data/simple-list`
- operationId：`DictData_getSimpleDictDataList_1`
- 描述：一般用于管理后台缓存字典数据在本地

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDictDataSimpleRespVO` |

### 9. 修改字典数据

- 分组：管理后台 - 字典数据
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/dict-data/update`
- operationId：`DictData_updateDictData`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DictDataSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 字典数据编号 | 否 | integer | 1024 |
| sort | 显示顺序 | 是 | integer | 1024 |
| label | 字典标签 | 是 | string | 芋道 |
| value | 字典值 | 是 | string | iocoder |
| dictType | 字典类型 | 是 | string | sys_common_sex |
| status | 状态,见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| colorType | 颜色类型,default、primary、success、info、warning、danger | 否 | string | default |
| cssClass | css 样式 | 否 | string | btn-visible |
| remark | 备注 | 否 | string | 我是一个角色 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 字典类型

### 1. 创建字典类型

- 分组：管理后台 - 字典类型
- 请求方式：`POST`
- 接口路径：`/admin-api/system/dict-type/create`
- operationId：`DictType_createDictType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DictTypeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 字典类型编号 | 否 | integer | 1024 |
| name | 字典名称 | 是 | string | 性别 |
| type | 字典类型 | 是 | string | sys_common_sex |
| status | 状态，参见 CommonStatusEnum 枚举类 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 快乐的备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除字典类型

- 分组：管理后台 - 字典类型
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/dict-type/delete`
- operationId：`DictType_deleteDictType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除字典类型

- 分组：管理后台 - 字典类型
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/dict-type/delete-list`
- operationId：`DictType_deleteDictTypeList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出数据类型

- 分组：管理后台 - 字典类型
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-type/export-excel`
- operationId：`DictType_export`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 字典类型名称，模糊匹配 | 芋道 |
| type | query | 否 | string | 字典类型，模糊匹配 | sys_common_sex |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. /查询字典类型详细

- 分组：管理后台 - 字典类型
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-type/get`
- operationId：`DictType_getDictType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDictTypeRespVO` |

### 6. 获得全部字典类型列表

- 分组：管理后台 - 字典类型
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-type/list-all-simple`
- operationId：`DictType_getSimpleDictTypeList`
- 描述：包括开启 + 禁用的字典类型，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDictTypeSimpleRespVO` |

### 7. 获得字典类型的分页列表

- 分组：管理后台 - 字典类型
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-type/page`
- operationId：`DictType_pageDictTypes`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 字典类型名称，模糊匹配 | 芋道 |
| type | query | 否 | string | 字典类型，模糊匹配 | sys_common_sex |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDictTypeRespVO` |

### 8. 获得全部字典类型列表

- 分组：管理后台 - 字典类型
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dict-type/simple-list`
- operationId：`DictType_getSimpleDictTypeList_1`
- 描述：包括开启 + 禁用的字典类型，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDictTypeSimpleRespVO` |

### 9. 修改字典类型

- 分组：管理后台 - 字典类型
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/dict-type/update`
- operationId：`DictType_updateDictType`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DictTypeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 字典类型编号 | 否 | integer | 1024 |
| name | 字典名称 | 是 | string | 性别 |
| type | 字典类型 | 是 | string | sys_common_sex |
| status | 状态，参见 CommonStatusEnum 枚举类 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 快乐的备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 学生

### 1. 创建学生

- 分组：管理后台 - 学生
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/demo03-student-erp/create`
- operationId：`Demo03StudentErp_createDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03StudentErpSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 8525 |
| name | 名字 | 是 | string | 芋艿 |
| sex | 性别 | 是 | integer |  |
| birthday | 出生日期 | 是 | string |  |
| description | 简介 | 是 | string | 随便 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除学生

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-erp/delete`
- operationId：`Demo03StudentErp_deleteDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除学生

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-erp/delete-list`
- operationId：`Demo03StudentErp_deleteDemo03StudentList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 创建学生课程

- 分组：管理后台 - 学生
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-course/create`
- operationId：`Demo03StudentErp_createDemo03Course`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03CourseDO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| createTime |  | 否 | string |  |
| updateTime |  | 否 | string |  |
| creator |  | 否 | string |  |
| updater |  | 否 | string |  |
| deleted |  | 否 | boolean |  |
| id |  | 否 | integer |  |
| studentId |  | 否 | integer |  |
| name |  | 否 | string |  |
| score |  | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 5. 删除学生课程

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-course/delete`
- operationId：`Demo03StudentErp_deleteDemo03Course`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 6. 批量删除学生课程

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-course/delete-list`
- operationId：`Demo03StudentErp_deleteDemo03CourseList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 7. 获得学生课程

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-course/get`
- operationId：`Demo03StudentErp_getDemo03Course`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo03CourseDO` |

### 8. 获得学生课程分页

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-course/page`
- operationId：`Demo03StudentErp_getDemo03CoursePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| studentId | query | 是 | integer | 学生编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDemo03CourseDO` |

### 9. 更新学生课程

- 分组：管理后台 - 学生
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-course/update`
- operationId：`Demo03StudentErp_updateDemo03Course`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03CourseDO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| createTime |  | 否 | string |  |
| updateTime |  | 否 | string |  |
| creator |  | 否 | string |  |
| updater |  | 否 | string |  |
| deleted |  | 否 | boolean |  |
| id |  | 否 | integer |  |
| studentId |  | 否 | integer |  |
| name |  | 否 | string |  |
| score |  | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 10. 创建学生班级

- 分组：管理后台 - 学生
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-grade/create`
- operationId：`Demo03StudentErp_createDemo03Grade`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03GradeDO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| createTime |  | 否 | string |  |
| updateTime |  | 否 | string |  |
| creator |  | 否 | string |  |
| updater |  | 否 | string |  |
| deleted |  | 否 | boolean |  |
| id |  | 否 | integer |  |
| studentId |  | 否 | integer |  |
| name |  | 否 | string |  |
| teacher |  | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 11. 删除学生班级

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-grade/delete`
- operationId：`Demo03StudentErp_deleteDemo03Grade`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 12. 批量删除学生班级

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-grade/delete-list`
- operationId：`Demo03StudentErp_deleteDemo03GradeList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 13. 获得学生班级

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-grade/get`
- operationId：`Demo03StudentErp_getDemo03Grade`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo03GradeDO` |

### 14. 获得学生班级分页

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-grade/page`
- operationId：`Demo03StudentErp_getDemo03GradePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| studentId | query | 是 | integer | 学生编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDemo03GradeDO` |

### 15. 更新学生班级

- 分组：管理后台 - 学生
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/demo03-student-erp/demo03-grade/update`
- operationId：`Demo03StudentErp_updateDemo03Grade`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03GradeDO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| createTime |  | 否 | string |  |
| updateTime |  | 否 | string |  |
| creator |  | 否 | string |  |
| updater |  | 否 | string |  |
| deleted |  | 否 | boolean |  |
| id |  | 否 | integer |  |
| studentId |  | 否 | integer |  |
| name |  | 否 | string |  |
| teacher |  | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 16. 导出学生 Excel

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-erp/export-excel`
- operationId：`Demo03StudentErp_exportDemo03StudentExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| sex | query | 否 | integer | 性别 |  |
| description | query | 否 | string | 简介 | 随便 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 17. 获得学生

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-erp/get`
- operationId：`Demo03StudentErp_getDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo03StudentErpRespVO` |

### 18. 获得学生分页

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-erp/page`
- operationId：`Demo03StudentErp_getDemo03StudentPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| sex | query | 否 | integer | 性别 |  |
| description | query | 否 | string | 简介 | 随便 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDemo03StudentErpRespVO` |

### 19. 更新学生

- 分组：管理后台 - 学生
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/demo03-student-erp/update`
- operationId：`Demo03StudentErp_updateDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03StudentErpSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 8525 |
| name | 名字 | 是 | string | 芋艿 |
| sex | 性别 | 是 | integer |  |
| birthday | 出生日期 | 是 | string |  |
| description | 简介 | 是 | string | 随便 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 20. 创建学生

- 分组：管理后台 - 学生
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/demo03-student-inner/create`
- operationId：`Demo03StudentInner_createDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03StudentInnerSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 8525 |
| name | 名字 | 是 | string | 芋艿 |
| sex | 性别 | 是 | integer |  |
| birthday | 出生日期 | 是 | string |  |
| description | 简介 | 是 | string | 随便 |
| demo03Courses | 学生课程列表 | 否 | array[Demo03CourseDO] |  |
| demo03Grade | 学生班级 | 否 | Demo03GradeDO |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 21. 删除学生

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-inner/delete`
- operationId：`Demo03StudentInner_deleteDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 22. 批量删除学生

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-inner/delete-list`
- operationId：`Demo03StudentInner_deleteDemo03StudentList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 23. 获得学生课程列表

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-inner/demo03-course/list-by-student-id`
- operationId：`Demo03StudentInner_getDemo03CourseListByStudentId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| studentId | query | 是 | integer | 学生编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDemo03CourseDO` |

### 24. 获得学生班级

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-inner/demo03-grade/get-by-student-id`
- operationId：`Demo03StudentInner_getDemo03GradeByStudentId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| studentId | query | 是 | integer | 学生编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo03GradeDO` |

### 25. 导出学生 Excel

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-inner/export-excel`
- operationId：`Demo03StudentInner_exportDemo03StudentExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| sex | query | 否 | integer | 性别 |  |
| description | query | 否 | string | 简介 | 随便 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 26. 获得学生

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-inner/get`
- operationId：`Demo03StudentInner_getDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo03StudentInnerRespVO` |

### 27. 获得学生分页

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-inner/page`
- operationId：`Demo03StudentInner_getDemo03StudentPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| sex | query | 否 | integer | 性别 |  |
| description | query | 否 | string | 简介 | 随便 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDemo03StudentInnerRespVO` |

### 28. 更新学生

- 分组：管理后台 - 学生
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/demo03-student-inner/update`
- operationId：`Demo03StudentInner_updateDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03StudentInnerSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 8525 |
| name | 名字 | 是 | string | 芋艿 |
| sex | 性别 | 是 | integer |  |
| birthday | 出生日期 | 是 | string |  |
| description | 简介 | 是 | string | 随便 |
| demo03Courses | 学生课程列表 | 否 | array[Demo03CourseDO] |  |
| demo03Grade | 学生班级 | 否 | Demo03GradeDO |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 29. 创建学生

- 分组：管理后台 - 学生
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/demo03-student-normal/create`
- operationId：`Demo03StudentNormal_createDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03StudentNormalSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 8525 |
| name | 名字 | 是 | string | 芋艿 |
| sex | 性别 | 是 | integer |  |
| birthday | 出生日期 | 是 | string |  |
| description | 简介 | 是 | string | 随便 |
| demo03Courses | 学生课程列表 | 否 | array[Demo03CourseDO] |  |
| demo03Grade | 学生班级 | 否 | Demo03GradeDO |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 30. 删除学生

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-normal/delete`
- operationId：`Demo03StudentNormal_deleteDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 31. 批量删除学生

- 分组：管理后台 - 学生
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo03-student-normal/delete-list`
- operationId：`Demo03StudentNormal_deleteDemo03StudentList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 32. 获得学生课程列表

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-normal/demo03-course/list-by-student-id`
- operationId：`Demo03StudentNormal_getDemo03CourseListByStudentId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| studentId | query | 是 | integer | 学生编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDemo03CourseDO` |

### 33. 获得学生班级

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-normal/demo03-grade/get-by-student-id`
- operationId：`Demo03StudentNormal_getDemo03GradeByStudentId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| studentId | query | 是 | integer | 学生编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo03GradeDO` |

### 34. 导出学生 Excel

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-normal/export-excel`
- operationId：`Demo03StudentNormal_exportDemo03StudentExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| sex | query | 否 | integer | 性别 |  |
| description | query | 否 | string | 简介 | 随便 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 35. 获得学生

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-normal/get`
- operationId：`Demo03StudentNormal_getDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo03StudentNormalRespVO` |

### 36. 获得学生分页

- 分组：管理后台 - 学生
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo03-student-normal/page`
- operationId：`Demo03StudentNormal_getDemo03StudentPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| sex | query | 否 | integer | 性别 |  |
| description | query | 否 | string | 简介 | 随便 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDemo03StudentNormalRespVO` |

### 37. 更新学生

- 分组：管理后台 - 学生
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/demo03-student-normal/update`
- operationId：`Demo03StudentNormal_updateDemo03Student`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo03StudentNormalSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 8525 |
| name | 名字 | 是 | string | 芋艿 |
| sex | 性别 | 是 | integer |  |
| birthday | 出生日期 | 是 | string |  |
| description | 简介 | 是 | string | 随便 |
| demo03Courses | 学生课程列表 | 否 | array[Demo03CourseDO] |  |
| demo03Grade | 学生班级 | 否 | Demo03GradeDO |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 定时任务

### 1. 创建定时任务

- 分组：管理后台 - 定时任务
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/job/create`
- operationId：`Job_createJob`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`JobSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 任务编号 | 否 | integer | 1024 |
| name | 任务名称 | 是 | string | 测试任务 |
| handlerName | 处理器的名字 | 是 | string | sysUserSessionTimeoutJob |
| handlerParam | 处理器的参数 | 否 | string | yudao |
| cronExpression | CRON 表达式 | 是 | string | 0/10 * * * * ? * |
| retryCount | 重试次数 | 是 | integer | 3 |
| retryInterval | 重试间隔 | 是 | integer | 1000 |
| monitorTimeout | 监控超时时间 | 否 | integer | 1000 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除定时任务

- 分组：管理后台 - 定时任务
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/job/delete`
- operationId：`Job_deleteJob`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除定时任务

- 分组：管理后台 - 定时任务
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/job/delete-list`
- operationId：`Job_deleteJobList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出定时任务 Excel

- 分组：管理后台 - 定时任务
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/job/export-excel`
- operationId：`Job_exportJobExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 任务名称，模糊匹配 | 测试任务 |
| status | query | 否 | integer | 任务状态，参见 JobStatusEnum 枚举 | 1 |
| handlerName | query | 否 | string | 处理器的名字，模糊匹配 | sysUserSessionTimeoutJob |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得定时任务

- 分组：管理后台 - 定时任务
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/job/get`
- operationId：`Job_getJob`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultJobRespVO` |

### 6. 获得定时任务的下 n 次执行时间

- 分组：管理后台 - 定时任务
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/job/get_next_times`
- operationId：`Job_getJobNextTimes`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| count | query | 否 | integer | 数量 | 5 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListLocalDateTime` |

### 7. 获得定时任务分页

- 分组：管理后台 - 定时任务
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/job/page`
- operationId：`Job_getJobPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 任务名称，模糊匹配 | 测试任务 |
| status | query | 否 | integer | 任务状态，参见 JobStatusEnum 枚举 | 1 |
| handlerName | query | 否 | string | 处理器的名字，模糊匹配 | sysUserSessionTimeoutJob |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultJobRespVO` |

### 8. 同步定时任务

- 分组：管理后台 - 定时任务
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/job/sync`
- operationId：`Job_syncJob`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 9. 触发定时任务

- 分组：管理后台 - 定时任务
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/job/trigger`
- operationId：`Job_triggerJob`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 10. 更新定时任务

- 分组：管理后台 - 定时任务
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/job/update`
- operationId：`Job_updateJob`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`JobSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 任务编号 | 否 | integer | 1024 |
| name | 任务名称 | 是 | string | 测试任务 |
| handlerName | 处理器的名字 | 是 | string | sysUserSessionTimeoutJob |
| handlerParam | 处理器的参数 | 否 | string | yudao |
| cronExpression | CRON 表达式 | 是 | string | 0/10 * * * * ? * |
| retryCount | 重试次数 | 是 | integer | 3 |
| retryInterval | 重试间隔 | 是 | integer | 1000 |
| monitorTimeout | 监控超时时间 | 否 | integer | 1000 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 11. 更新定时任务的状态

- 分组：管理后台 - 定时任务
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/job/update-status`
- operationId：`Job_updateJobStatus`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| status | query | 是 | integer | 状态 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 定时任务日志

### 1. 导出定时任务日志 Excel

- 分组：管理后台 - 定时任务日志
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/job-log/export-excel`
- operationId：`JobLog_exportJobLogExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| jobId | query | 否 | integer | 任务编号 | 10 |
| handlerName | query | 否 | string | 处理器的名字，模糊匹配 |  |
| beginTime | query | 否 | string | 开始执行时间 |  |
| endTime | query | 否 | string | 结束执行时间 |  |
| status | query | 否 | integer | 任务状态，参见 JobLogStatusEnum 枚举 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获得定时任务日志

- 分组：管理后台 - 定时任务日志
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/job-log/get`
- operationId：`JobLog_getJobLog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultJobLogRespVO` |

### 3. 获得定时任务日志分页

- 分组：管理后台 - 定时任务日志
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/job-log/page`
- operationId：`JobLog_getJobLogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| jobId | query | 否 | integer | 任务编号 | 10 |
| handlerName | query | 否 | string | 处理器的名字，模糊匹配 |  |
| beginTime | query | 否 | string | 开始执行时间 |  |
| endTime | query | 否 | string | 结束执行时间 |  |
| status | query | 否 | integer | 任务状态，参见 JobLogStatusEnum 枚举 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultJobLogRespVO` |

## 管理后台 - 岗位

### 1. 创建岗位

- 分组：管理后台 - 岗位
- 请求方式：`POST`
- 接口路径：`/admin-api/system/post/create`
- operationId：`Post_createPost`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`PostSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 岗位编号 | 否 | integer | 1024 |
| name | 岗位名称 | 是 | string | 小土豆 |
| code | 岗位编码 | 是 | string | yudao |
| sort | 显示顺序 | 是 | integer | 1024 |
| status | 状态 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 快乐的备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除岗位

- 分组：管理后台 - 岗位
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/post/delete`
- operationId：`Post_deletePost`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除岗位

- 分组：管理后台 - 岗位
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/post/delete-list`
- operationId：`Post_deletePostList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 岗位管理

- 分组：管理后台 - 岗位
- 请求方式：`GET`
- 接口路径：`/admin-api/system/post/export-excel`
- operationId：`Post_export`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | query | 否 | string | 岗位编码，模糊匹配 | yudao |
| name | query | 否 | string | 岗位名称，模糊匹配 | 芋道 |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得岗位信息

- 分组：管理后台 - 岗位
- 请求方式：`GET`
- 接口路径：`/admin-api/system/post/get`
- operationId：`Post_getPost`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 岗位编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPostRespVO` |

### 6. 获取岗位全列表

- 分组：管理后台 - 岗位
- 请求方式：`GET`
- 接口路径：`/admin-api/system/post/list-all-simple`
- operationId：`Post_getSimplePostList`
- 描述：只包含被开启的岗位，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListPostSimpleRespVO` |

### 7. 获得岗位分页列表

- 分组：管理后台 - 岗位
- 请求方式：`GET`
- 接口路径：`/admin-api/system/post/page`
- operationId：`Post_getPostPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | query | 否 | string | 岗位编码，模糊匹配 | yudao |
| name | query | 否 | string | 岗位名称，模糊匹配 | 芋道 |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultPostRespVO` |

### 8. 获取岗位全列表

- 分组：管理后台 - 岗位
- 请求方式：`GET`
- 接口路径：`/admin-api/system/post/simple-list`
- operationId：`Post_getSimplePostList_1`
- 描述：只包含被开启的岗位，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListPostSimpleRespVO` |

### 9. 修改岗位

- 分组：管理后台 - 岗位
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/post/update`
- operationId：`Post_updatePost`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`PostSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 岗位编号 | 否 | integer | 1024 |
| name | 岗位名称 | 是 | string | 小土豆 |
| code | 岗位编码 | 是 | string | yudao |
| sort | 显示顺序 | 是 | integer | 1024 |
| status | 状态 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 快乐的备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 我的站内信

### 1. 获得站内信

- 分组：管理后台 - 我的站内信
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notify-message/get`
- operationId：`NotifyMessage_getNotifyMessage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNotifyMessageRespVO` |

### 2. 获得当前用户的未读站内信数量

- 分组：管理后台 - 我的站内信
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notify-message/get-unread-count`
- operationId：`NotifyMessage_getUnreadNotifyMessageCount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 3. 获取当前用户的最新站内信列表，默认 10 条

- 分组：管理后台 - 我的站内信
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notify-message/get-unread-list`
- operationId：`NotifyMessage_getUnreadNotifyMessageList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| size | query | 否 | integer | 10 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListNotifyMessageRespVO` |

### 4. 获得我的站内信分页

- 分组：管理后台 - 我的站内信
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notify-message/my-page`
- operationId：`NotifyMessage_getMyMyNotifyMessagePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| readStatus | query | 否 | boolean | 是否已读 | True |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultNotifyMessageRespVO` |

### 5. 获得站内信分页

- 分组：管理后台 - 我的站内信
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notify-message/page`
- operationId：`NotifyMessage_getNotifyMessagePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 25025 |
| userType | query | 否 | integer | 用户类型 | 1 |
| templateCode | query | 否 | string | 模板编码 | test_01 |
| templateType | query | 否 | integer | 模版类型 | 2 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultNotifyMessageRespVO` |

### 6. 标记所有站内信为已读

- 分组：管理后台 - 我的站内信
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/notify-message/update-all-read`
- operationId：`NotifyMessage_updateAllNotifyMessageRead`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 7. 标记站内信为已读

- 分组：管理后台 - 我的站内信
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/notify-message/update-read`
- operationId：`NotifyMessage_updateNotifyMessageRead`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 | 1024,2048 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 折扣

### 1. 启用/停用

- 分组：管理后台 - 折扣
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/discount/change-status`
- operationId：`Discount_updateDiscountStatus`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | ID |  |
| status | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 创建折扣

- 分组：管理后台 - 折扣
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/discount/create`
- operationId：`Discount_createDiscount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DiscountSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 折扣主键 | 是 | integer | 8592 |
| discountCode | 折扣编码 | 否 | string |  |
| discountName | 折扣名称 | 是 | string | 芋艿 |
| discountType | 折扣类型（product_discount-产品折扣、order_discount-订单折扣、buy_x_get_y-买X赠Y） | 是 | string | 1 |
| discountEffectType | 折扣生效类型（discount_code-折扣码、auto_discount-自动折扣） | 是 | string | 1 |
| discountCodeValue | 折扣码（折扣生效类型为"折扣码"时必填） | 否 | string |  |
| discountTitle | 折扣标题（折扣生效类型为"自动折扣"时必填） | 否 | string |  |
| status | 状态（active-有效、expired-已过期、disabled-已停用） | 否 | string |  |
| startTime | 开始时间 | 是 | string |  |
| endTime | 结束时间 | 否 | string |  |
| minRequirementType | 最低购买要求（none-无最低要求、min_purchase_amount-最低购买金额、min_product_quantity-最低购买产品数量） | 否 | string | 1 |
| minPurchaseAmount | 最低购买金额(购买要求为"最低购买金额"时必填) | 否 | number |  |
| minProductQuantity | 最低购买产品数量（购买要求为"最低购买产品数量"时必填） | 否 | integer |  |
| customerEligibility | 客户资格适用范围（all_customer-所有客户、specific_cate-特定客户分类、specific_customer-特定客户） | 否 | string |  |
| totalIssuanceLimit | 总发放量（0<x<=10000张,非必填） | 否 | integer |  |
| usageLimitPerPerson | 每人最多可使用(0<x<=10000张,非必填） | 否 | integer |  |
| discountMethod | 折扣方法（percentage-百分比、fixed_amount-固定金额） | 否 | string |  |
| discountPercentage | 折扣百分比 | 否 | number |  |
| discountFixedAmount | 折扣金额 | 否 | number |  |
| productApplyScope | 产品适用范围（specific_cate-特定产品分类、specific_product-特定产品) | 否 | string |  |
| purchaseType | 客户消费类型（min_purchase_amount-最低购买金额、min_product_quantity-最低购买数量） | 否 | string | 1 |
| purchaseMinAmount | 客户消费最低购买金额 | 否 | number |  |
| purchaseMinQuantity | 客户消费最低购买数量 | 否 | integer |  |
| purchaseProductSource | 客户消费商品来源（specific_cate-特定产品分类、specific_product-特定产品） | 否 | string |  |
| giftQuantity | 客户获得数量 | 否 | integer |  |
| giftProductSource | 客户获得商品来源（specific_cate-特定产品分类、specific_product-特定产品） | 否 | string |  |
| giftPriceType | 客户获得按折扣价类型（percentage-百分比、fixed_amount-每件减免金额） | 否 | string | 2 |
| giftDiscountPercentage | 客户获得按折扣价百分比 | 否 | number |  |
| giftDiscountAmount | 客户获得按折扣价每件减免金额 | 否 | number |  |
| giftUsageLimitType | 客户获得每笔订单最多可使用次数限制（unlimited-不限制、limited-限制） | 否 | string | 1 |
| giftMaxUsagePerOrder | 客户获得每笔订单最多可使用次数 | 否 | integer |  |
| discountProductCates | 折扣产品分类列表 | 否 | array[DiscountProductCateSaveReqVO] |  |
| discountProducts | 折扣产品列表 | 否 | array[DiscountProductSaveReqVO] |  |
| discountCustomerCates | 折扣特定客户分类列表 | 否 | array[DiscountCustomerCateSaveReqVO] |  |
| discountCustomers | 折扣特定客户列表 | 否 | array[DiscountCustomerSaveReqVO] |  |
| purchaseProductCates | 客户消费分类列表 | 否 | array[DiscountProductCateSaveReqVO] |  |
| purchaseProducts | 客户消费产品列表 | 否 | array[DiscountProductSaveReqVO] |  |
| giftProductCates | 客户获得分类列表 | 否 | array[DiscountProductCateSaveReqVO] |  |
| giftProducts | 客户获得产品列表 | 否 | array[DiscountProductSaveReqVO] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultInteger` |

### 3. 删除折扣

- 分组：管理后台 - 折扣
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/discount/delete`
- operationId：`Discount_deleteDiscount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 批量删除折扣

- 分组：管理后台 - 折扣
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/discount/delete-list`
- operationId：`Discount_deleteDiscountList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 获得折扣特定客户分类列表

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/discount-customer-cate/list-by-discount-id`
- operationId：`Discount_getDiscountCustomerCateListByDiscountId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| discountId | query | 是 | integer | 折扣主键 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDiscountCustomerCateDO` |

### 6. 获得APP客户分类

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/discount-customer/get_cate`
- operationId：`Discount_getDiscountCustomerCateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListTagInfo` |

### 7. 查询APP客户

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/discount-customer/get_customer`
- operationId：`Discount_getDiscountCustomerList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| keywords | query | 是 | string |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListUserInfo` |

### 8. 获得折扣特定客户列表

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/discount-customer/list-by-discount-id`
- operationId：`Discount_getDiscountCustomerListByDiscountId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| discountId | query | 是 | integer | 折扣主键 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDiscountCustomerDO` |

### 9. 获得折扣产品分类列表

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/discount-product-cate/list-by-discount-id`
- operationId：`Discount_getDiscountProductCateListByDiscountId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| discountId | query | 是 | integer | 折扣主键 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDiscountProductCateDO` |

### 10. 获得折扣产品列表

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/discount-product/list-by-discount-id`
- operationId：`Discount_getDiscountProductListByDiscountId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| discountId | query | 是 | integer | 折扣主键 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDiscountProductDO` |

### 11. 获得折扣

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/get`
- operationId：`Discount_getDiscount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDiscountSaveReqVO` |

### 12. 获得折扣分页

- 分组：管理后台 - 折扣
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount/page`
- operationId：`Discount_getDiscountPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| discountCode | query | 否 | string | 折扣编码 |  |
| discountName | query | 否 | string | 折扣名称 | 芋艿 |
| discountType | query | 否 | array[string] | 折扣类型（product_discount-产品折扣、order_discount-订单折扣、buy_x_get_y-买X赠Y） |  |
| discountEffectType | query | 否 | array[string] | 折扣生效类型（discount_code-折扣码、auto_discount-自动折扣） |  |
| discountCodeValue | query | 否 | string | 折扣码 |  |
| status | query | 否 | array[string] | 状态（active-有效、expired-已过期、disabled-已停用） |  |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDiscountRespVO` |

### 13. 更新折扣

- 分组：管理后台 - 折扣
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/discount/update`
- operationId：`Discount_updateDiscount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DiscountSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 折扣主键 | 是 | integer | 8592 |
| discountCode | 折扣编码 | 否 | string |  |
| discountName | 折扣名称 | 是 | string | 芋艿 |
| discountType | 折扣类型（product_discount-产品折扣、order_discount-订单折扣、buy_x_get_y-买X赠Y） | 是 | string | 1 |
| discountEffectType | 折扣生效类型（discount_code-折扣码、auto_discount-自动折扣） | 是 | string | 1 |
| discountCodeValue | 折扣码（折扣生效类型为"折扣码"时必填） | 否 | string |  |
| discountTitle | 折扣标题（折扣生效类型为"自动折扣"时必填） | 否 | string |  |
| status | 状态（active-有效、expired-已过期、disabled-已停用） | 否 | string |  |
| startTime | 开始时间 | 是 | string |  |
| endTime | 结束时间 | 否 | string |  |
| minRequirementType | 最低购买要求（none-无最低要求、min_purchase_amount-最低购买金额、min_product_quantity-最低购买产品数量） | 否 | string | 1 |
| minPurchaseAmount | 最低购买金额(购买要求为"最低购买金额"时必填) | 否 | number |  |
| minProductQuantity | 最低购买产品数量（购买要求为"最低购买产品数量"时必填） | 否 | integer |  |
| customerEligibility | 客户资格适用范围（all_customer-所有客户、specific_cate-特定客户分类、specific_customer-特定客户） | 否 | string |  |
| totalIssuanceLimit | 总发放量（0<x<=10000张,非必填） | 否 | integer |  |
| usageLimitPerPerson | 每人最多可使用(0<x<=10000张,非必填） | 否 | integer |  |
| discountMethod | 折扣方法（percentage-百分比、fixed_amount-固定金额） | 否 | string |  |
| discountPercentage | 折扣百分比 | 否 | number |  |
| discountFixedAmount | 折扣金额 | 否 | number |  |
| productApplyScope | 产品适用范围（specific_cate-特定产品分类、specific_product-特定产品) | 否 | string |  |
| purchaseType | 客户消费类型（min_purchase_amount-最低购买金额、min_product_quantity-最低购买数量） | 否 | string | 1 |
| purchaseMinAmount | 客户消费最低购买金额 | 否 | number |  |
| purchaseMinQuantity | 客户消费最低购买数量 | 否 | integer |  |
| purchaseProductSource | 客户消费商品来源（specific_cate-特定产品分类、specific_product-特定产品） | 否 | string |  |
| giftQuantity | 客户获得数量 | 否 | integer |  |
| giftProductSource | 客户获得商品来源（specific_cate-特定产品分类、specific_product-特定产品） | 否 | string |  |
| giftPriceType | 客户获得按折扣价类型（percentage-百分比、fixed_amount-每件减免金额） | 否 | string | 2 |
| giftDiscountPercentage | 客户获得按折扣价百分比 | 否 | number |  |
| giftDiscountAmount | 客户获得按折扣价每件减免金额 | 否 | number |  |
| giftUsageLimitType | 客户获得每笔订单最多可使用次数限制（unlimited-不限制、limited-限制） | 否 | string | 1 |
| giftMaxUsagePerOrder | 客户获得每笔订单最多可使用次数 | 否 | integer |  |
| discountProductCates | 折扣产品分类列表 | 否 | array[DiscountProductCateSaveReqVO] |  |
| discountProducts | 折扣产品列表 | 否 | array[DiscountProductSaveReqVO] |  |
| discountCustomerCates | 折扣特定客户分类列表 | 否 | array[DiscountCustomerCateSaveReqVO] |  |
| discountCustomers | 折扣特定客户列表 | 否 | array[DiscountCustomerSaveReqVO] |  |
| purchaseProductCates | 客户消费分类列表 | 否 | array[DiscountProductCateSaveReqVO] |  |
| purchaseProducts | 客户消费产品列表 | 否 | array[DiscountProductSaveReqVO] |  |
| giftProductCates | 客户获得分类列表 | 否 | array[DiscountProductCateSaveReqVO] |  |
| giftProducts | 客户获得产品列表 | 否 | array[DiscountProductSaveReqVO] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 折扣数据

### 1. 导出折扣数据 Excel

- 分组：管理后台 - 折扣数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount-usage-record/export-excel`
- operationId：`DiscountUsageRecord_exportDiscountUsageRecordExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| discountId | query | 否 | integer | 折扣ID |  |
| startTime | query | 是 | string | 开始时间 |  |
| endTime | query | 是 | string | 结束时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获取统计数据

- 分组：管理后台 - 折扣数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/discount-usage-record/get-data`
- operationId：`DiscountUsageRecord_getDiscountUsageRecordStatisticPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| discountId | query | 否 | integer | 折扣ID |  |
| startTime | query | 是 | string | 开始时间 |  |
| endTime | query | 是 | string | 结束时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDiscountUsageRecordListRespVO` |

## 管理后台 - 操作日志

### 1. 导出操作日志

- 分组：管理后台 - 操作日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/operate-log/export-excel`
- operationId：`OperateLog_exportOperateLog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 芋道 |
| bizId | query | 否 | integer | 操作模块业务编号 | 1 |
| type | query | 否 | string | 操作模块，模拟匹配 | 订单 |
| subType | query | 否 | string | 操作名，模拟匹配 | 创建订单 |
| action | query | 否 | string | 操作明细，模拟匹配 | 修改编号为 1 的用户信息 |
| createTime | query | 否 | array[string] | 开始时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 查看操作日志分页列表

- 分组：管理后台 - 操作日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/operate-log/page`
- operationId：`OperateLog_pageOperateLog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 芋道 |
| bizId | query | 否 | integer | 操作模块业务编号 | 1 |
| type | query | 否 | string | 操作模块，模拟匹配 | 订单 |
| subType | query | 否 | string | 操作名，模拟匹配 | 创建订单 |
| action | query | 否 | string | 操作明细，模拟匹配 | 修改编号为 1 的用户信息 |
| createTime | query | 否 | array[string] | 开始时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultOperateLogRespVO` |

## 管理后台 - 支付页产品推荐

### 1. 修改排序号

- 分组：管理后台 - 支付页产品推荐
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product-payment-recommend/change-rank-num`
- operationId：`ProductPaymentRecommend_updateProductPaymentRecommend`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductPaymentRecommendChangeRankNumReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer | 4527 |
| rankNum | 排序号 | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 修改推荐状态

- 分组：管理后台 - 支付页产品推荐
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/product-payment-recommend/change-status`
- operationId：`ProductPaymentRecommend_getProductPaymentRecommend`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductPaymentRecommendChangeStatusReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 是 | integer |  |
| recommendStatus | 推荐状态 | 是 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 创建支付页产品推荐

- 分组：管理后台 - 支付页产品推荐
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/product-payment-recommend/create`
- operationId：`ProductPaymentRecommend_createProductPaymentRecommend`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ProductPaymentRecommendSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键ID | 否 | integer |  |
| productIds | 产品ID列表 | 是 | array[integer] | [2265, 22] |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 4. 删除支付页产品推荐

- 分组：管理后台 - 支付页产品推荐
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-payment-recommend/delete`
- operationId：`ProductPaymentRecommend_deleteProductPaymentRecommend`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 批量删除支付页产品推荐

- 分组：管理后台 - 支付页产品推荐
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/product-payment-recommend/delete-list`
- operationId：`ProductPaymentRecommend_deleteProductPaymentRecommendList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 6. 获得支付页产品推荐分页

- 分组：管理后台 - 支付页产品推荐
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/product-payment-recommend/page`
- operationId：`ProductPaymentRecommend_getProductPaymentRecommendPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| productName | query | 否 | string | 产品名称 |  |
| productCateIdList | query | 否 | array[integer] | 产品类别 |  |
| status | query | 否 | integer | 产品状态 |  |
| recommendStatus | query | 否 | integer | 推荐状态 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultProductPaymentRecommendRespVO` |

## 管理后台 - 数据源配置

### 1. 创建数据源配置

- 分组：管理后台 - 数据源配置
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/data-source-config/create`
- operationId：`DataSourceConfig_createDataSourceConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DataSourceConfigSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键编号 | 否 | integer | 1024 |
| name | 数据源名称 | 是 | string | test |
| url | 数据源连接 | 是 | string | jdbc:mysql://127.0.0.1:3306/ruoyi-vue-pro |
| username | 用户名 | 是 | string | root |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除数据源配置

- 分组：管理后台 - 数据源配置
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/data-source-config/delete`
- operationId：`DataSourceConfig_deleteDataSourceConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除数据源配置

- 分组：管理后台 - 数据源配置
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/data-source-config/delete-list`
- operationId：`DataSourceConfig_deleteDataSourceConfigList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得数据源配置

- 分组：管理后台 - 数据源配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/data-source-config/get`
- operationId：`DataSourceConfig_getDataSourceConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDataSourceConfigRespVO` |

### 5. 获得数据源配置列表

- 分组：管理后台 - 数据源配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/data-source-config/list`
- operationId：`DataSourceConfig_getDataSourceConfigList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDataSourceConfigRespVO` |

### 6. 更新数据源配置

- 分组：管理后台 - 数据源配置
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/data-source-config/update`
- operationId：`DataSourceConfig_updateDataSourceConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DataSourceConfigSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键编号 | 否 | integer | 1024 |
| name | 数据源名称 | 是 | string | test |
| url | 数据源连接 | 是 | string | jdbc:mysql://127.0.0.1:3306/ruoyi-vue-pro |
| username | 用户名 | 是 | string | root |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 文件存储

### 1. 创建文件

- 分组：管理后台 - 文件存储
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/file/create`
- operationId：`File_createFile`
- 描述：模式二：前端上传文件：配合 presigned-url 接口，记录上传了上传的文件

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FileCreateReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| configId | 文件配置编号 | 是 | integer | 11 |
| path | 文件路径 | 是 | string | yudao.jpg |
| name | 原文件名 | 是 | string | yudao.jpg |
| url | 文件 URL | 是 | string | https://www.iocoder.cn/yudao.jpg |
| type | 文件 MIME 类型 | 否 | string | application/octet-stream |
| size | 文件大小 | 是 | integer | 2048 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除文件

- 分组：管理后台 - 文件存储
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/file/delete`
- operationId：`File_deleteFile`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除文件

- 分组：管理后台 - 文件存储
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/file/delete-list`
- operationId：`File_deleteFileList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得文件分页

- 分组：管理后台 - 文件存储
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/file/page`
- operationId：`File_getFilePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| path | query | 否 | string | 文件路径，模糊匹配 | yudao |
| type | query | 否 | string | 文件类型，模糊匹配 | jpg |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00, 2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultFileRespVO` |

### 5. 获取文件预签名地址（上传）

- 分组：管理后台 - 文件存储
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/file/presigned-url`
- operationId：`File_getFilePresignedUrl`
- 描述：模式二：前端上传文件：用于前端直接上传七牛、阿里云 OSS 等文件存储器

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 是 | string | 文件名称 |  |
| directory | query | 否 | string | 文件目录 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFilePresignedUrlRespVO` |

### 6. 上传文件

- 分组：管理后台 - 文件存储
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/file/upload`
- operationId：`File_uploadFile`
- 描述：模式一：后端上传文件

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| directory | query | 否 | string | 文件目录 | XXX/YYY |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 7. 下载文件

- 分组：管理后台 - 文件存储
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/file/{configId}/get/**`
- operationId：`File_getFileContent`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| configId | path | 是 | integer | 配置编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

## 管理后台 - 文件配置

### 1. 创建文件配置

- 分组：管理后台 - 文件配置
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/file-config/create`
- operationId：`FileConfig_createFileConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FileConfigSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1 |
| name | 配置名 | 是 | string | S3 - 阿里云 |
| storage | 存储器，参见 FileStorageEnum 枚举类 | 是 | integer | 1 |
| config | 存储配置,配置是动态参数，所以使用 Map 接收 | 是 | object |  |
| remark | 备注 | 否 | string | 我是备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除文件配置

- 分组：管理后台 - 文件配置
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/file-config/delete`
- operationId：`FileConfig_deleteFileConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除文件配置

- 分组：管理后台 - 文件配置
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/file-config/delete-list`
- operationId：`FileConfig_deleteFileConfigList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得文件配置

- 分组：管理后台 - 文件配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/file-config/get`
- operationId：`FileConfig_getFileConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultFileConfigRespVO` |

### 5. 获得文件配置分页

- 分组：管理后台 - 文件配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/file-config/page`
- operationId：`FileConfig_getFileConfigPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 配置名 | S3 - 阿里云 |
| storage | query | 否 | integer | 存储器 | 1 |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00, 2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultFileConfigRespVO` |

### 6. 测试文件配置是否正确

- 分组：管理后台 - 文件配置
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/file-config/test`
- operationId：`FileConfig_testFileConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 7. 更新文件配置

- 分组：管理后台 - 文件配置
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/file-config/update`
- operationId：`FileConfig_updateFileConfig`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`FileConfigSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1 |
| name | 配置名 | 是 | string | S3 - 阿里云 |
| storage | 存储器，参见 FileStorageEnum 枚举类 | 是 | integer | 1 |
| config | 存储配置,配置是动态参数，所以使用 Map 接收 | 是 | object |  |
| remark | 备注 | 否 | string | 我是备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 8. 更新文件配置为 Master

- 分组：管理后台 - 文件配置
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/file-config/update-master`
- operationId：`FileConfig_updateFileConfigMaster`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 权限

### 1. 赋予角色数据权限

- 分组：管理后台 - 权限
- 请求方式：`POST`
- 接口路径：`/admin-api/system/permission/assign-role-data-scope`
- operationId：`Permission_assignRoleDataScope`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`PermissionAssignRoleDataScopeReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| roleId | 角色编号 | 是 | integer | 1 |
| dataScope | 数据范围，参见 DataScopeEnum 枚举类 | 是 | integer | 1 |
| dataScopeDeptIds | 部门编号列表，只有范围类型为 DEPT_CUSTOM 时，该字段才需要 | 否 | array[integer] | 1,3,5 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 赋予角色菜单

- 分组：管理后台 - 权限
- 请求方式：`POST`
- 接口路径：`/admin-api/system/permission/assign-role-menu`
- operationId：`Permission_assignRoleMenu`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`PermissionAssignRoleMenuReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| roleId | 角色编号 | 是 | integer | 1 |
| menuIds | 菜单编号列表 | 否 | array[integer] | 1,3,5 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 赋予用户角色

- 分组：管理后台 - 权限
- 请求方式：`POST`
- 接口路径：`/admin-api/system/permission/assign-user-role`
- operationId：`Permission_assignUserRole`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`PermissionAssignUserRoleReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| userId | 用户编号 | 是 | integer | 1 |
| roleIds | 角色编号列表 | 否 | array[integer] | 1,3,5 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得角色拥有的菜单编号

- 分组：管理后台 - 权限
- 请求方式：`GET`
- 接口路径：`/admin-api/system/permission/list-role-menus`
- operationId：`Permission_getRoleMenuList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| roleId | query | 是 | integer | 角色编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultSetLong` |

### 5. 获得管理员拥有的角色编号列表

- 分组：管理后台 - 权限
- 请求方式：`GET`
- 接口路径：`/admin-api/system/permission/list-user-roles`
- operationId：`Permission_listAdminRoles`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 是 | integer | 用户编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultSetLong` |

## 管理后台 - 流量详情

### 1. 导出流量详情 Excel

- 分组：管理后台 - 流量详情
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/landing-page-tracker-detail/export-excel`
- operationId：`LandingPageTrackerDetail_exportLandingPageTrackerDetailExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pageUrl | query | 否 | string | 页面完整URL | https://www.iocoder.cn |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageUrls | query | 否 | array[string] | 页面完整URL数组 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获得流量详情分页

- 分组：管理后台 - 流量详情
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/landing-page-tracker-detail/page`
- operationId：`LandingPageTrackerDetail_getLandingPageTrackerDetailPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pageUrl | query | 否 | string | 页面完整URL | https://www.iocoder.cn |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageUrls | query | 否 | array[string] | 页面完整URL数组 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultLandingPageTrackerDetailRespVO` |

## 管理后台 - 用户

### 1. 新增用户

- 分组：管理后台 - 用户
- 请求方式：`POST`
- 接口路径：`/admin-api/system/user/create`
- operationId：`User_createUser`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`UserSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 用户编号 | 否 | integer | 1024 |
| username | 用户账号 | 是 | string | yudao |
| nickname | 用户昵称 | 是 | string | 芋艿 |
| remark | 备注 | 否 | string | 我是一个用户 |
| deptId | 部门编号 | 否 | integer | 我是一个用户 |
| postIds | 岗位编号数组 | 否 | array[integer] | 1 |
| email | 用户邮箱 | 否 | string | yudao@iocoder.cn |
| mobile | 手机号码 | 否 | string | 15601691300 |
| sex | 用户性别，参见 SexEnum 枚举类 | 否 | integer | 1 |
| avatar | 用户头像 | 否 | string | https://www.iocoder.cn/xxx.png |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除用户

- 分组：管理后台 - 用户
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/user/delete`
- operationId：`User_deleteUser`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除用户

- 分组：管理后台 - 用户
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/user/delete-list`
- operationId：`User_deleteUserList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出用户

- 分组：管理后台 - 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/export-excel`
- operationId：`User_exportUserList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 否 | array[integer] | ID集合 |  |
| username | query | 否 | string | 用户账号，模糊匹配 | yudao |
| mobile | query | 否 | string | 手机号码，模糊匹配 | yudao |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00, 2022-07-01 23:59:59] |
| deptId | query | 否 | integer | 部门编号，同时筛选子部门 | 1024 |
| roleId | query | 否 | integer | 角色编号 | 1024 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得用户详情

- 分组：管理后台 - 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/get`
- operationId：`User_getUser`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultUserRespVO` |

### 6. 获得导入用户模板

- 分组：管理后台 - 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/get-import-template`
- operationId：`User_importTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入用户

- 分组：管理后台 - 用户
- 请求方式：`POST`
- 接口路径：`/admin-api/system/user/import`
- operationId：`User_importExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 否 | boolean | 是否支持更新，默认为 false | True |
| file | query | 是 |  | Excel 文件 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultUserImportRespVO` |

### 8. 获取用户精简信息列表

- 分组：管理后台 - 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/list-all-simple`
- operationId：`User_getSimpleUserList`
- 描述：只包含被开启的用户，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListUserSimpleRespVO` |

### 9. 获得用户分页列表

- 分组：管理后台 - 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/page`
- operationId：`User_getUserPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 否 | array[integer] | ID集合 |  |
| username | query | 否 | string | 用户账号，模糊匹配 | yudao |
| mobile | query | 否 | string | 手机号码，模糊匹配 | yudao |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00, 2022-07-01 23:59:59] |
| deptId | query | 否 | integer | 部门编号，同时筛选子部门 | 1024 |
| roleId | query | 否 | integer | 角色编号 | 1024 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultUserRespVO` |

### 10. 重置指纹

- 分组：管理后台 - 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/reset-fingerprint`
- operationId：`User_resetFingerprint`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 11. 获取用户精简信息列表

- 分组：管理后台 - 用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/simple-list`
- operationId：`User_getSimpleUserList_1`
- 描述：只包含被开启的用户，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListUserSimpleRespVO` |

### 12. 修改用户

- 分组：管理后台 - 用户
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/user/update`
- operationId：`User_updateUser`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`UserSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 用户编号 | 否 | integer | 1024 |
| username | 用户账号 | 是 | string | yudao |
| nickname | 用户昵称 | 是 | string | 芋艿 |
| remark | 备注 | 否 | string | 我是一个用户 |
| deptId | 部门编号 | 否 | integer | 我是一个用户 |
| postIds | 岗位编号数组 | 否 | array[integer] | 1 |
| email | 用户邮箱 | 否 | string | yudao@iocoder.cn |
| mobile | 手机号码 | 否 | string | 15601691300 |
| sex | 用户性别，参见 SexEnum 枚举类 | 否 | integer | 1 |
| avatar | 用户头像 | 否 | string | https://www.iocoder.cn/xxx.png |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 13. 重置用户密码

- 分组：管理后台 - 用户
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/user/update-password`
- operationId：`User_updateUserPassword`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`UserUpdatePasswordReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 用户编号 | 是 | integer | 1024 |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 14. 修改用户状态

- 分组：管理后台 - 用户
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/user/update-status`
- operationId：`User_updateUserStatus`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`UserUpdateStatusReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 用户编号 | 是 | integer | 1024 |
| status | 状态，见 CommonStatusEnum 枚举 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 用户个人中心

### 1. 获得登录用户信息

- 分组：管理后台 - 用户个人中心
- 请求方式：`GET`
- 接口路径：`/admin-api/system/user/profile/get`
- operationId：`UserProfile_getUserProfile`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultUserProfileRespVO` |

### 2. 修改用户个人信息

- 分组：管理后台 - 用户个人中心
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/user/profile/update`
- operationId：`UserProfile_updateUserProfile`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`UserProfileUpdateReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| nickname | 用户昵称 | 否 | string | 芋艿 |
| email | 用户邮箱 | 否 | string | yudao@iocoder.cn |
| mobile | 手机号码 | 否 | string | 15601691300 |
| sex | 用户性别，参见 SexEnum 枚举类 | 否 | integer | 1 |
| avatar | 角色头像 | 否 | string | https://www.iocoder.cn/1.png |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 修改用户个人密码

- 分组：管理后台 - 用户个人中心
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/user/profile/update-password`
- operationId：`UserProfile_updateUserProfilePassword`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`UserProfileUpdatePasswordReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| oldPassword | 旧密码 | 是 | string | 123456 |
| newPassword | 新密码 | 是 | string | 654321 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 登录日志

### 1. 导出登录日志 Excel

- 分组：管理后台 - 登录日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/login-log/export-excel`
- operationId：`LoginLog_exportLoginLog`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userIp | query | 否 | string | 用户 IP，模拟匹配 | 127.0.0.1 |
| username | query | 否 | string | 用户账号，模拟匹配 | 芋道 |
| status | query | 否 | boolean | 操作状态 | True |
| createTime | query | 否 | array[string] | 登录时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获得登录日志分页列表

- 分组：管理后台 - 登录日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/login-log/page`
- operationId：`LoginLog_getLoginLogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userIp | query | 否 | string | 用户 IP，模拟匹配 | 127.0.0.1 |
| username | query | 否 | string | 用户账号，模拟匹配 | 芋道 |
| status | query | 否 | boolean | 操作状态 | True |
| createTime | query | 否 | array[string] | 登录时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultLoginLogRespVO` |

## 管理后台 - 短信回调

### 1. 阿里云短信的回调

- 分组：管理后台 - 短信回调
- 请求方式：`POST`
- 接口路径：`/admin-api/system/sms/callback/aliyun`
- operationId：`SmsCallback_receiveAliyunSmsStatus`
- 描述：参见 https://help.aliyun.com/document_detail/120998.html 文档

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 华为云短信的回调

- 分组：管理后台 - 短信回调
- 请求方式：`POST`
- 接口路径：`/admin-api/system/sms/callback/huawei`
- operationId：`SmsCallback_receiveHuaweiSmsStatus`
- 描述：参见 https://support.huaweicloud.com/api-msgsms/sms_05_0003.html 文档

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`string`

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 七牛云短信的回调

- 分组：管理后台 - 短信回调
- 请求方式：`POST`
- 接口路径：`/admin-api/system/sms/callback/qiniu`
- operationId：`SmsCallback_receiveQiniuSmsStatus`
- 描述：参见 https://developer.qiniu.com/sms/5910/message-push 文档

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`string`

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 腾讯云短信的回调

- 分组：管理后台 - 短信回调
- 请求方式：`POST`
- 接口路径：`/admin-api/system/sms/callback/tencent`
- operationId：`SmsCallback_receiveTencentSmsStatus`
- 描述：参见 https://cloud.tencent.com/document/product/382/52077 文档

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 短信日志

### 1. 导出短信日志 Excel

- 分组：管理后台 - 短信日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-log/export-excel`
- operationId：`SmsLog_exportSmsLogExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| channelId | query | 否 | integer | 短信渠道编号 | 10 |
| templateId | query | 否 | integer | 模板编号 | 20 |
| mobile | query | 否 | string | 手机号 | 15601691300 |
| sendStatus | query | 否 | integer | 发送状态，参见 SmsSendStatusEnum 枚举类 | 1 |
| sendTime | query | 否 | array[string] | 发送时间 |  |
| receiveStatus | query | 否 | integer | 接收状态，参见 SmsReceiveStatusEnum 枚举类 | 0 |
| receiveTime | query | 否 | array[string] | 接收时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 2. 获得短信日志分页

- 分组：管理后台 - 短信日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-log/page`
- operationId：`SmsLog_getSmsLogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| channelId | query | 否 | integer | 短信渠道编号 | 10 |
| templateId | query | 否 | integer | 模板编号 | 20 |
| mobile | query | 否 | string | 手机号 | 15601691300 |
| sendStatus | query | 否 | integer | 发送状态，参见 SmsSendStatusEnum 枚举类 | 1 |
| sendTime | query | 否 | array[string] | 发送时间 |  |
| receiveStatus | query | 否 | integer | 接收状态，参见 SmsReceiveStatusEnum 枚举类 | 0 |
| receiveTime | query | 否 | array[string] | 接收时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultSmsLogRespVO` |

## 管理后台 - 短信模板

### 1. 创建短信模板

- 分组：管理后台 - 短信模板
- 请求方式：`POST`
- 接口路径：`/admin-api/system/sms-template/create`
- operationId：`SmsTemplate_createSmsTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SmsTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| type | 短信类型，参见 SmsTemplateTypeEnum 枚举类 | 是 | integer | 1 |
| status | 开启状态，参见 CommonStatusEnum 枚举类 | 是 | integer | 1 |
| code | 模板编码 | 是 | string | test_01 |
| name | 模板名称 | 是 | string | yudao |
| content | 模板内容 | 是 | string | 你好，{name}。你长的太{like}啦！ |
| remark | 备注 | 否 | string | 哈哈哈 |
| apiTemplateId | 短信 API 的模板编号 | 是 | string | 4383920 |
| channelId | 短信渠道编号 | 是 | integer | 10 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除短信模板

- 分组：管理后台 - 短信模板
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/sms-template/delete`
- operationId：`SmsTemplate_deleteSmsTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除短信模板

- 分组：管理后台 - 短信模板
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/sms-template/delete-list`
- operationId：`SmsTemplate_deleteSmsTemplateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出短信模板 Excel

- 分组：管理后台 - 短信模板
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-template/export-excel`
- operationId：`SmsTemplate_exportSmsTemplateExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | query | 否 | integer | 短信签名 | 1 |
| status | query | 否 | integer | 开启状态 | 1 |
| code | query | 否 | string | 模板编码，模糊匹配 | test_01 |
| content | query | 否 | string | 模板内容，模糊匹配 | 你好，{name}。你长的太{like}啦！ |
| apiTemplateId | query | 否 | string | 短信 API 的模板编号，模糊匹配 | 4383920 |
| channelId | query | 否 | integer | 短信渠道编号 | 10 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得短信模板

- 分组：管理后台 - 短信模板
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-template/get`
- operationId：`SmsTemplate_getSmsTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultSmsTemplateRespVO` |

### 6. 获得短信模板分页

- 分组：管理后台 - 短信模板
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-template/page`
- operationId：`SmsTemplate_getSmsTemplatePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | query | 否 | integer | 短信签名 | 1 |
| status | query | 否 | integer | 开启状态 | 1 |
| code | query | 否 | string | 模板编码，模糊匹配 | test_01 |
| content | query | 否 | string | 模板内容，模糊匹配 | 你好，{name}。你长的太{like}啦！ |
| apiTemplateId | query | 否 | string | 短信 API 的模板编号，模糊匹配 | 4383920 |
| channelId | query | 否 | integer | 短信渠道编号 | 10 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultSmsTemplateRespVO` |

### 7. 发送短信

- 分组：管理后台 - 短信模板
- 请求方式：`POST`
- 接口路径：`/admin-api/system/sms-template/send-sms`
- operationId：`SmsTemplate_sendSms`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SmsTemplateSendReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| mobile | 手机号 | 是 | string | 15601691300 |
| templateCode | 模板编码 | 是 | string | test_01 |
| templateParams | 模板参数 | 否 | object |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 8. 更新短信模板

- 分组：管理后台 - 短信模板
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/sms-template/update`
- operationId：`SmsTemplate_updateSmsTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SmsTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| type | 短信类型，参见 SmsTemplateTypeEnum 枚举类 | 是 | integer | 1 |
| status | 开启状态，参见 CommonStatusEnum 枚举类 | 是 | integer | 1 |
| code | 模板编码 | 是 | string | test_01 |
| name | 模板名称 | 是 | string | yudao |
| content | 模板内容 | 是 | string | 你好，{name}。你长的太{like}啦！ |
| remark | 备注 | 否 | string | 哈哈哈 |
| apiTemplateId | 短信 API 的模板编号 | 是 | string | 4383920 |
| channelId | 短信渠道编号 | 是 | integer | 10 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 短信渠道

### 1. 创建短信渠道

- 分组：管理后台 - 短信渠道
- 请求方式：`POST`
- 接口路径：`/admin-api/system/sms-channel/create`
- operationId：`SmsChannel_createSmsChannel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SmsChannelSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| signature | 短信签名 | 是 | string | 芋道源码 |
| code | 渠道编码，参见 SmsChannelEnum 枚举类 | 是 | string | YUN_PIAN |
| status | 启用状态 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 好吃！ |
| apiKey | 短信 API 的账号 | 是 | string | yudao |
| apiSecret | 短信 API 的密钥 | 否 | string | yuanma |
| callbackUrl | 短信发送回调 URL | 否 | string | http://www.iocoder.cn |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除短信渠道

- 分组：管理后台 - 短信渠道
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/sms-channel/delete`
- operationId：`SmsChannel_deleteSmsChannel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除短信渠道

- 分组：管理后台 - 短信渠道
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/sms-channel/delete-list`
- operationId：`SmsChannel_deleteSmsChannelList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得短信渠道

- 分组：管理后台 - 短信渠道
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-channel/get`
- operationId：`SmsChannel_getSmsChannel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultSmsChannelRespVO` |

### 5. 获得短信渠道精简列表

- 分组：管理后台 - 短信渠道
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-channel/list-all-simple`
- operationId：`SmsChannel_getSimpleSmsChannelList_1`
- 描述：包含被禁用的短信渠道

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListSmsChannelSimpleRespVO` |

### 6. 获得短信渠道分页

- 分组：管理后台 - 短信渠道
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-channel/page`
- operationId：`SmsChannel_getSmsChannelPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| status | query | 否 | integer | 任务状态 | 1 |
| signature | query | 否 | string | 短信签名，模糊匹配 | 芋道源码 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultSmsChannelRespVO` |

### 7. 获得短信渠道精简列表

- 分组：管理后台 - 短信渠道
- 请求方式：`GET`
- 接口路径：`/admin-api/system/sms-channel/simple-list`
- operationId：`SmsChannel_getSimpleSmsChannelList`
- 描述：包含被禁用的短信渠道

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListSmsChannelSimpleRespVO` |

### 8. 更新短信渠道

- 分组：管理后台 - 短信渠道
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/sms-channel/update`
- operationId：`SmsChannel_updateSmsChannel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SmsChannelSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| signature | 短信签名 | 是 | string | 芋道源码 |
| code | 渠道编码，参见 SmsChannelEnum 枚举类 | 是 | string | YUN_PIAN |
| status | 启用状态 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 好吃！ |
| apiKey | 短信 API 的账号 | 是 | string | yudao |
| apiSecret | 短信 API 的密钥 | 否 | string | yuanma |
| callbackUrl | 短信发送回调 URL | 否 | string | http://www.iocoder.cn |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 示例分类

### 1. 创建示例分类

- 分组：管理后台 - 示例分类
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/demo02-category/create`
- operationId：`Demo02Category_createDemo02Category`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo02CategorySaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 10304 |
| name | 名字 | 是 | string | 芋艿 |
| parentId | 父级编号 | 是 | integer | 6080 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除示例分类

- 分组：管理后台 - 示例分类
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo02-category/delete`
- operationId：`Demo02Category_deleteDemo02Category`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 导出示例分类 Excel

- 分组：管理后台 - 示例分类
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo02-category/export-excel`
- operationId：`Demo02Category_exportDemo02CategoryExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| parentId | query | 否 | integer | 父级编号 | 6080 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 4. 获得示例分类

- 分组：管理后台 - 示例分类
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo02-category/get`
- operationId：`Demo02Category_getDemo02Category`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo02CategoryRespVO` |

### 5. 获得示例分类列表

- 分组：管理后台 - 示例分类
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo02-category/list`
- operationId：`Demo02Category_getDemo02CategoryList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 芋艿 |
| parentId | query | 否 | integer | 父级编号 | 6080 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDemo02CategoryRespVO` |

### 6. 更新示例分类

- 分组：管理后台 - 示例分类
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/demo02-category/update`
- operationId：`Demo02Category_updateDemo02Category`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo02CategorySaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 10304 |
| name | 名字 | 是 | string | 芋艿 |
| parentId | 父级编号 | 是 | integer | 6080 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 示例联系人

### 1. 创建示例联系人

- 分组：管理后台 - 示例联系人
- 请求方式：`POST`
- 接口路径：`/admin-api/infra/demo01-contact/create`
- operationId：`Demo01Contact_createDemo01Contact`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo01ContactSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 21555 |
| name | 名字 | 是 | string | 张三 |
| sex | 性别 | 是 | integer | 1 |
| birthday | 出生年 | 是 | string |  |
| description | 简介 | 是 | string | 你说的对 |
| avatar | 头像 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除示例联系人

- 分组：管理后台 - 示例联系人
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo01-contact/delete`
- operationId：`Demo01Contact_deleteDemo01Contact`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除示例联系人

- 分组：管理后台 - 示例联系人
- 请求方式：`DELETE`
- 接口路径：`/admin-api/infra/demo01-contact/delete-list`
- operationId：`Demo01Contact_deleteDemo0iContactList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出示例联系人 Excel

- 分组：管理后台 - 示例联系人
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo01-contact/export-excel`
- operationId：`Demo01Contact_exportDemo01ContactExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 张三 |
| sex | query | 否 | integer | 性别 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得示例联系人

- 分组：管理后台 - 示例联系人
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo01-contact/get`
- operationId：`Demo01Contact_getDemo01Contact`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDemo01ContactRespVO` |

### 6. 获得示例联系人分页

- 分组：管理后台 - 示例联系人
- 请求方式：`GET`
- 接口路径：`/admin-api/infra/demo01-contact/page`
- operationId：`Demo01Contact_getDemo01ContactPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名字 | 张三 |
| sex | query | 否 | integer | 性别 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultDemo01ContactRespVO` |

### 7. 更新示例联系人

- 分组：管理后台 - 示例联系人
- 请求方式：`PUT`
- 接口路径：`/admin-api/infra/demo01-contact/update`
- operationId：`Demo01Contact_updateDemo01Contact`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`Demo01ContactSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 是 | integer | 21555 |
| name | 名字 | 是 | string | 张三 |
| sex | 性别 | 是 | integer | 1 |
| birthday | 出生年 | 是 | string |  |
| description | 简介 | 是 | string | 你说的对 |
| avatar | 头像 | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 社交客户端

### 1. 创建社交客户端

- 分组：管理后台 - 社交客户端
- 请求方式：`POST`
- 接口路径：`/admin-api/system/social-client/create`
- operationId：`SocialClient_createSocialClient`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SocialClientSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 27162 |
| name | 应用名 | 是 | string | yudao商城 |
| socialType | 社交平台的类型 | 是 | integer | 31 |
| userType | 用户类型 | 是 | integer | 2 |
| clientId | 客户端编号 | 是 | string | wwd411c69a39ad2e54 |
| clientSecret | 客户端密钥 | 是 | string | peter |
| agentId | 授权方的网页应用编号 | 是 | string | 2000045 |
| status | 状态 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除社交客户端

- 分组：管理后台 - 社交客户端
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/social-client/delete`
- operationId：`SocialClient_deleteSocialClient`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除社交客户端

- 分组：管理后台 - 社交客户端
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/social-client/delete-list`
- operationId：`SocialClient_deleteSocialClientList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得社交客户端

- 分组：管理后台 - 社交客户端
- 请求方式：`GET`
- 接口路径：`/admin-api/system/social-client/get`
- operationId：`SocialClient_getSocialClient`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultSocialClientRespVO` |

### 5. 获得社交客户端分页

- 分组：管理后台 - 社交客户端
- 请求方式：`GET`
- 接口路径：`/admin-api/system/social-client/page`
- operationId：`SocialClient_getSocialClientPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 应用名 | yudao商城 |
| socialType | query | 否 | integer | 社交平台的类型 | 31 |
| userType | query | 否 | integer | 用户类型 | 2 |
| clientId | query | 否 | string | 客户端编号 | 145442115 |
| status | query | 否 | integer | 状态 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultSocialClientRespVO` |

### 6. 发送订阅消息

- 分组：管理后台 - 社交客户端
- 请求方式：`POST`
- 接口路径：`/admin-api/system/social-client/send-subscribe-message`
- operationId：`SocialClient_sendSubscribeMessage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SocialWxaSubscribeMessageSendReqDTO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| userId |  | 是 | integer |  |
| userType |  | 是 | integer |  |
| templateTitle |  | 是 | string |  |
| page |  | 否 | string |  |
| messages |  | 否 | object |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 更新社交客户端

- 分组：管理后台 - 社交客户端
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/social-client/update`
- operationId：`SocialClient_updateSocialClient`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SocialClientSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 27162 |
| name | 应用名 | 是 | string | yudao商城 |
| socialType | 社交平台的类型 | 是 | integer | 31 |
| userType | 用户类型 | 是 | integer | 2 |
| clientId | 客户端编号 | 是 | string | wwd411c69a39ad2e54 |
| clientSecret | 客户端密钥 | 是 | string | peter |
| agentId | 授权方的网页应用编号 | 是 | string | 2000045 |
| status | 状态 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 社交用户

### 1. 社交绑定，使用 code 授权码

- 分组：管理后台 - 社交用户
- 请求方式：`POST`
- 接口路径：`/admin-api/system/social-user/bind`
- operationId：`SocialUser_socialBind`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SocialUserBindReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| type | 社交平台的类型，参见 UserSocialTypeEnum 枚举值 | 是 | integer | 10 |
| code | 授权码 | 是 | string | 1024 |
| state | state | 是 | string | 9b2ffbc1-7425-4155-9894-9d5c08541d62 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 获得社交用户

- 分组：管理后台 - 社交用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/social-user/get`
- operationId：`SocialUser_getSocialUser`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultSocialUserRespVO` |

### 3. 获得绑定社交用户列表

- 分组：管理后台 - 社交用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/social-user/get-bind-list`
- operationId：`SocialUser_getBindSocialUserList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListSocialUserRespVO` |

### 4. 获得社交用户分页

- 分组：管理后台 - 社交用户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/social-user/page`
- operationId：`SocialUser_getSocialUserPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | query | 否 | integer | 社交平台的类型 | 30 |
| nickname | query | 否 | string | 用户昵称 | 李四 |
| openid | query | 否 | string | 社交 openid | oz-Jdt0kd_jdhUxJHQdBJMlOFN7w |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultSocialUserRespVO` |

### 5. 取消社交绑定

- 分组：管理后台 - 社交用户
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/social-user/unbind`
- operationId：`SocialUser_socialUnbind`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`SocialUserUnbindReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| type | 社交平台的类型，参见 UserSocialTypeEnum 枚举值 | 是 | integer | 10 |
| openid | 社交用户的 openid | 是 | string | IPRmJ0wvBptiPIlGEZiPewGwiEiE |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 租户

### 1. 创建租户

- 分组：管理后台 - 租户
- 请求方式：`POST`
- 接口路径：`/admin-api/system/tenant/create`
- operationId：`Tenant_createTenant`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`TenantSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 租户编号 | 否 | integer | 1024 |
| name | 租户名 | 是 | string | 芋道 |
| contactName | 联系人 | 是 | string | 芋艿 |
| contactMobile | 联系手机 | 否 | string | 15601691300 |
| status | 租户状态 | 是 | integer | 1 |
| websites | 绑定域名数组 | 否 | array[string] | https://www.iocoder.cn |
| packageId | 租户套餐编号 | 是 | integer | 1024 |
| expireTime | 过期时间 | 是 | string |  |
| accountCount | 账号数量 | 是 | integer | 1024 |
| username | 用户账号 | 是 | string | yudao |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除租户

- 分组：管理后台 - 租户
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/tenant/delete`
- operationId：`Tenant_deleteTenant`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除租户

- 分组：管理后台 - 租户
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/tenant/delete-list`
- operationId：`Tenant_deleteTenantList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出租户 Excel

- 分组：管理后台 - 租户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant/export-excel`
- operationId：`Tenant_exportTenantExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 租户名 | 芋道 |
| contactName | query | 否 | string | 联系人 | 芋艿 |
| contactMobile | query | 否 | string | 联系手机 | 15601691300 |
| status | query | 否 | integer | 租户状态（0正常 1停用） | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得租户

- 分组：管理后台 - 租户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant/get`
- operationId：`Tenant_getTenant`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultTenantRespVO` |

### 6. 使用域名，获得租户信息

- 分组：管理后台 - 租户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant/get-by-website`
- operationId：`Tenant_getTenantByWebsite`
- 描述：登录界面，根据用户的域名，获得租户信息

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| website | query | 是 | string | 域名 | www.iocoder.cn |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultTenantRespVO` |

### 7. 使用租户名，获得租户编号

- 分组：管理后台 - 租户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant/get-id-by-name`
- operationId：`Tenant_getTenantIdByName`
- 描述：登录界面，根据用户的租户名，获得租户编号

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 是 | string | 租户名 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 8. 获得租户分页

- 分组：管理后台 - 租户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant/page`
- operationId：`Tenant_getTenantPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 租户名 | 芋道 |
| contactName | query | 否 | string | 联系人 | 芋艿 |
| contactMobile | query | 否 | string | 联系手机 | 15601691300 |
| status | query | 否 | integer | 租户状态（0正常 1停用） | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultTenantRespVO` |

### 9. 获取租户精简信息列表

- 分组：管理后台 - 租户
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant/simple-list`
- operationId：`Tenant_getTenantSimpleList`
- 描述：只包含被开启的租户，用于【首页】功能的选择租户选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListTenantRespVO` |

### 10. 更新租户

- 分组：管理后台 - 租户
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/tenant/update`
- operationId：`Tenant_updateTenant`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`TenantSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 租户编号 | 否 | integer | 1024 |
| name | 租户名 | 是 | string | 芋道 |
| contactName | 联系人 | 是 | string | 芋艿 |
| contactMobile | 联系手机 | 否 | string | 15601691300 |
| status | 租户状态 | 是 | integer | 1 |
| websites | 绑定域名数组 | 否 | array[string] | https://www.iocoder.cn |
| packageId | 租户套餐编号 | 是 | integer | 1024 |
| expireTime | 过期时间 | 是 | string |  |
| accountCount | 账号数量 | 是 | integer | 1024 |
| username | 用户账号 | 是 | string | yudao |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 租户套餐

### 1. 创建租户套餐

- 分组：管理后台 - 租户套餐
- 请求方式：`POST`
- 接口路径：`/admin-api/system/tenant-package/create`
- operationId：`TenantPackage_createTenantPackage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`TenantPackageSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 套餐编号 | 否 | integer | 1024 |
| name | 套餐名 | 是 | string | VIP |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 好 |
| menuIds | 关联的菜单编号 | 是 | array[integer] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除租户套餐

- 分组：管理后台 - 租户套餐
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/tenant-package/delete`
- operationId：`TenantPackage_deleteTenantPackage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除租户套餐

- 分组：管理后台 - 租户套餐
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/tenant-package/delete-list`
- operationId：`TenantPackage_deleteTenantPackageList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得租户套餐

- 分组：管理后台 - 租户套餐
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant-package/get`
- operationId：`TenantPackage_getTenantPackage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultTenantPackageRespVO` |

### 5. 获取租户套餐精简信息列表

- 分组：管理后台 - 租户套餐
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant-package/get-simple-list`
- operationId：`TenantPackage_getTenantPackageList`
- 描述：只包含被开启的租户套餐，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListTenantPackageSimpleRespVO` |

### 6. 获得租户套餐分页

- 分组：管理后台 - 租户套餐
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant-package/page`
- operationId：`TenantPackage_getTenantPackagePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 套餐名 | VIP |
| status | query | 否 | integer | 状态 | 1 |
| remark | query | 否 | string | 备注 | 好 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultTenantPackageRespVO` |

### 7. 获取租户套餐精简信息列表

- 分组：管理后台 - 租户套餐
- 请求方式：`GET`
- 接口路径：`/admin-api/system/tenant-package/simple-list`
- operationId：`TenantPackage_getTenantPackageList_1`
- 描述：只包含被开启的租户套餐，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListTenantPackageSimpleRespVO` |

### 8. 更新租户套餐

- 分组：管理后台 - 租户套餐
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/tenant-package/update`
- operationId：`TenantPackage_updateTenantPackage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`TenantPackageSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 套餐编号 | 否 | integer | 1024 |
| name | 套餐名 | 是 | string | VIP |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 好 |
| menuIds | 关联的菜单编号 | 是 | array[integer] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 站内信模版

### 1. 创建站内信模版

- 分组：管理后台 - 站内信模版
- 请求方式：`POST`
- 接口路径：`/admin-api/system/notify-template/create`
- operationId：`NotifyTemplate_createNotifyTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NotifyTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 否 | integer | 1024 |
| name | 模版名称 | 是 | string | 测试模版 |
| code | 模版编码 | 是 | string | SEND_TEST |
| type | 模版类型，对应 system_notify_template_type 字典 | 是 | integer | 1 |
| nickname | 发送人名称 | 是 | string | 土豆 |
| content | 模版内容 | 是 | string | 我是模版内容 |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 我是备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除站内信模版

- 分组：管理后台 - 站内信模版
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/notify-template/delete`
- operationId：`NotifyTemplate_deleteNotifyTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除站内信模版

- 分组：管理后台 - 站内信模版
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/notify-template/delete-list`
- operationId：`NotifyTemplate_deleteNotifyTemplateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得站内信模版

- 分组：管理后台 - 站内信模版
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notify-template/get`
- operationId：`NotifyTemplate_getNotifyTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNotifyTemplateRespVO` |

### 5. 获得站内信模版分页

- 分组：管理后台 - 站内信模版
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notify-template/page`
- operationId：`NotifyTemplate_getNotifyTemplatePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | query | 否 | string | 模版编码 | test_01 |
| name | query | 否 | string | 模版名称 | 我是名称 |
| status | query | 否 | integer | 状态，参见 CommonStatusEnum 枚举类 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultNotifyTemplateRespVO` |

### 6. 发送站内信

- 分组：管理后台 - 站内信模版
- 请求方式：`POST`
- 接口路径：`/admin-api/system/notify-template/send-notify`
- operationId：`NotifyTemplate_sendNotify`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NotifyTemplateSendReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| userId | 用户id | 是 | integer | 1 |
| userType | 用户类型 | 是 | integer | 1 |
| templateCode | 模板编码 | 是 | string | 01 |
| templateParams | 模板参数 | 否 | object |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 7. 更新站内信模版

- 分组：管理后台 - 站内信模版
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/notify-template/update`
- operationId：`NotifyTemplate_updateNotifyTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NotifyTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 否 | integer | 1024 |
| name | 模版名称 | 是 | string | 测试模版 |
| code | 模版编码 | 是 | string | SEND_TEST |
| type | 模版类型，对应 system_notify_template_type 字典 | 是 | integer | 1 |
| nickname | 发送人名称 | 是 | string | 土豆 |
| content | 模版内容 | 是 | string | 我是模版内容 |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 我是备注 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 联系我们数据

### 1. 创建联系我们数据

- 分组：管理后台 - 联系我们数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/contact-us/create`
- operationId：`ContactUs_createContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ContactUsSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 26831 |
| name | 姓名 | 是 | string | 芋艿 |
| email | 邮箱 | 是 | string |  |
| address | 公司名称或地址 | 是 | string |  |
| questionType | 问题类型 | 是 | string | 2 |
| questionDetail | 问题详情 | 否 | string |  |
| files | 图片或视频 | 否 |  |  |
| lang | 语言 | 是 | string |  |
| ip | IP | 是 | string |  |
| requestStatus | 请求状态 | 是 | integer | 1 |
| requestResult | 请求结果 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除联系我们数据

- 分组：管理后台 - 联系我们数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/contact-us/delete`
- operationId：`ContactUs_deleteContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除联系我们数据

- 分组：管理后台 - 联系我们数据
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/contact-us/delete-list`
- operationId：`ContactUs_deleteContactUsList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出联系我们数据 Excel

- 分组：管理后台 - 联系我们数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/contact-us/export-excel`
- operationId：`ContactUs_exportContactUsExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 姓名 | 芋艿 |
| email | query | 否 | string | 邮箱 |  |
| address | query | 否 | string | 公司名称或地址 |  |
| lang | query | 否 | string | 语言 |  |
| createTime | query | 否 | array[string] | 提交时间 |  |
| requestStatus | query | 否 | integer | 请求状态 | 1 |
| ids | query | 否 | array[integer] | 查询id列表 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得联系我们数据

- 分组：管理后台 - 联系我们数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/contact-us/get`
- operationId：`ContactUs_getContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultContactUsRespVO` |

### 6. 获得导入联系我们数据模板

- 分组：管理后台 - 联系我们数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/contact-us/get-import-template`
- operationId：`ContactUs_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入联系我们数据Excel

- 分组：管理后台 - 联系我们数据
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/contact-us/import-excel`
- operationId：`ContactUs_importContactUsExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultContactUsImportRespVO` |

### 8. 获得联系我们数据分页

- 分组：管理后台 - 联系我们数据
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/contact-us/page`
- operationId：`ContactUs_getContactUsPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 姓名 | 芋艿 |
| email | query | 否 | string | 邮箱 |  |
| address | query | 否 | string | 公司名称或地址 |  |
| lang | query | 否 | string | 语言 |  |
| createTime | query | 否 | array[string] | 提交时间 |  |
| requestStatus | query | 否 | integer | 请求状态 | 1 |
| ids | query | 否 | array[integer] | 查询id列表 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultContactUsRespVO` |

### 9. 更新联系我们数据

- 分组：管理后台 - 联系我们数据
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/contact-us/update`
- operationId：`ContactUs_updateContactUs`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ContactUsSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 26831 |
| name | 姓名 | 是 | string | 芋艿 |
| email | 邮箱 | 是 | string |  |
| address | 公司名称或地址 | 是 | string |  |
| questionType | 问题类型 | 是 | string | 2 |
| questionDetail | 问题详情 | 否 | string |  |
| files | 图片或视频 | 否 |  |  |
| lang | 语言 | 是 | string |  |
| ip | IP | 是 | string |  |
| requestStatus | 请求状态 | 是 | integer | 1 |
| requestResult | 请求结果 | 是 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 菜单

### 1. 创建菜单

- 分组：管理后台 - 菜单
- 请求方式：`POST`
- 接口路径：`/admin-api/system/menu/create`
- operationId：`Menu_createMenu`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`MenuSaveVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 菜单编号 | 否 | integer | 1024 |
| name | 菜单名称 | 是 | string | 芋道 |
| permission | 权限标识,仅菜单类型为按钮时，才需要传递 | 否 | string | sys:menu:add |
| type | 类型，参见 MenuTypeEnum 枚举类 | 是 | integer | 1 |
| sort | 显示顺序 | 是 | integer | 1024 |
| parentId | 父菜单 ID | 是 | integer | 1024 |
| path | 路由地址,仅菜单类型为菜单或者目录时，才需要传 | 否 | string | post |
| icon | 菜单图标,仅菜单类型为菜单或者目录时，才需要传 | 否 | string | /menu/list |
| component | 组件路径,仅菜单类型为菜单时，才需要传 | 否 | string | system/post/index |
| componentName | 组件名 | 否 | string | SystemUser |
| status | 状态,见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| visible | 是否可见 | 否 | boolean | False |
| keepAlive | 是否缓存 | 否 | boolean | False |
| alwaysShow | 是否总是显示 | 否 | boolean | False |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除菜单

- 分组：管理后台 - 菜单
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/menu/delete`
- operationId：`Menu_deleteMenu`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 菜单编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除菜单

- 分组：管理后台 - 菜单
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/menu/delete-list`
- operationId：`Menu_deleteMenuList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获取菜单信息

- 分组：管理后台 - 菜单
- 请求方式：`GET`
- 接口路径：`/admin-api/system/menu/get`
- operationId：`Menu_getMenu`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultMenuRespVO` |

### 5. 获取菜单列表

- 分组：管理后台 - 菜单
- 请求方式：`GET`
- 接口路径：`/admin-api/system/menu/list`
- operationId：`Menu_getMenuList`
- 描述：用于【菜单管理】界面

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 菜单名称，模糊匹配 | 芋道 |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListMenuRespVO` |

### 6. 获取菜单精简信息列表

- 分组：管理后台 - 菜单
- 请求方式：`GET`
- 接口路径：`/admin-api/system/menu/list-all-simple`
- operationId：`Menu_getSimpleMenuList`
- 描述：只包含被开启的菜单，用于【角色分配菜单】功能的选项。在多租户的场景下，会只返回租户所在套餐有的菜单

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListMenuSimpleRespVO` |

### 7. 获取菜单精简信息列表

- 分组：管理后台 - 菜单
- 请求方式：`GET`
- 接口路径：`/admin-api/system/menu/simple-list`
- operationId：`Menu_getSimpleMenuList_1`
- 描述：只包含被开启的菜单，用于【角色分配菜单】功能的选项。在多租户的场景下，会只返回租户所在套餐有的菜单

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListMenuSimpleRespVO` |

### 8. 修改菜单

- 分组：管理后台 - 菜单
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/menu/update`
- operationId：`Menu_updateMenu`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`MenuSaveVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 菜单编号 | 否 | integer | 1024 |
| name | 菜单名称 | 是 | string | 芋道 |
| permission | 权限标识,仅菜单类型为按钮时，才需要传递 | 否 | string | sys:menu:add |
| type | 类型，参见 MenuTypeEnum 枚举类 | 是 | integer | 1 |
| sort | 显示顺序 | 是 | integer | 1024 |
| parentId | 父菜单 ID | 是 | integer | 1024 |
| path | 路由地址,仅菜单类型为菜单或者目录时，才需要传 | 否 | string | post |
| icon | 菜单图标,仅菜单类型为菜单或者目录时，才需要传 | 否 | string | /menu/list |
| component | 组件路径,仅菜单类型为菜单时，才需要传 | 否 | string | system/post/index |
| componentName | 组件名 | 否 | string | SystemUser |
| status | 状态,见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| visible | 是否可见 | 否 | boolean | False |
| keepAlive | 是否缓存 | 否 | boolean | False |
| alwaysShow | 是否总是显示 | 否 | boolean | False |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 角色

### 1. 创建角色

- 分组：管理后台 - 角色
- 请求方式：`POST`
- 接口路径：`/admin-api/system/role/create`
- operationId：`Role_createRole`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`RoleSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 角色编号 | 否 | integer | 1 |
| name | 角色名称 | 是 | string | 管理员 |
| code | 角色标志 | 是 | string | ADMIN |
| sort | 显示顺序 | 是 | integer | 1024 |
| status | 状态 | 是 | integer | 0 |
| remark | 备注 | 否 | string | 我是一个角色 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除角色

- 分组：管理后台 - 角色
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/role/delete`
- operationId：`Role_deleteRole`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 角色编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除角色

- 分组：管理后台 - 角色
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/role/delete-list`
- operationId：`Role_deleteRoleList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出角色 Excel

- 分组：管理后台 - 角色
- 请求方式：`GET`
- 接口路径：`/admin-api/system/role/export-excel`
- operationId：`Role_export`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 角色名称，模糊匹配 | 芋道 |
| code | query | 否 | string | 角色标识，模糊匹配 | yudao |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得角色信息

- 分组：管理后台 - 角色
- 请求方式：`GET`
- 接口路径：`/admin-api/system/role/get`
- operationId：`Role_getRole`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer |  |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultRoleRespVO` |

### 6. 获取角色精简信息列表

- 分组：管理后台 - 角色
- 请求方式：`GET`
- 接口路径：`/admin-api/system/role/list-all-simple`
- operationId：`Role_getSimpleRoleList`
- 描述：只包含被开启的角色，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListRoleRespVO` |

### 7. 获得角色分页

- 分组：管理后台 - 角色
- 请求方式：`GET`
- 接口路径：`/admin-api/system/role/page`
- operationId：`Role_getRolePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 角色名称，模糊匹配 | 芋道 |
| code | query | 否 | string | 角色标识，模糊匹配 | yudao |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| createTime | query | 否 | array[string] | 创建时间 | [2022-07-01 00:00:00,2022-07-01 23:59:59] |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultRoleRespVO` |

### 8. 获取角色精简信息列表

- 分组：管理后台 - 角色
- 请求方式：`GET`
- 接口路径：`/admin-api/system/role/simple-list`
- operationId：`Role_getSimpleRoleList_1`
- 描述：只包含被开启的角色，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListRoleRespVO` |

### 9. 修改角色

- 分组：管理后台 - 角色
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/role/update`
- operationId：`Role_updateRole`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`RoleSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 角色编号 | 否 | integer | 1 |
| name | 角色名称 | 是 | string | 管理员 |
| code | 角色标志 | 是 | string | ADMIN |
| sort | 显示顺序 | 是 | integer | 1024 |
| status | 状态 | 是 | integer | 0 |
| remark | 备注 | 否 | string | 我是一个角色 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 订单

### 1. 取消订单

- 分组：管理后台 - 订单
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/order/cancel`
- operationId：`Order_cancelOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OrderCancelReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 是 | integer | 1316 |
| cancelRemark | 取消订单备注 | 是 | string | 随便 |
| userId | 用户id | 否 | integer |  |
| itemDOList |  | 否 | array[OrderItemDO] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 2. 查询各状态订单数量

- 分组：管理后台 - 订单
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/order/count`
- operationId：`Order_getOrderCount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| isAnon | query | 否 | integer | 订单类型 | （游客支付=1，登录支付=2） |
| ids | query | 否 | array[integer] | 集合ID |  |
| orderNo | query | 否 | string | 订单号 |  |
| statusList | query | 否 | array[string] | 订单状态 | 2 |
| productName | query | 否 | string | 商品名称 |  |
| discountUsedAtTime | query | 否 | array[string] | 折扣使用时间 |  |
| discountId | query | 否 | integer | 折扣ID |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOrderCountRespVO` |

### 3. 导出订单 Excel

- 分组：管理后台 - 订单
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/order/export-excel`
- operationId：`Order_exportOrderExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| isAnon | query | 否 | integer | 订单类型 | （游客支付=1，登录支付=2） |
| ids | query | 否 | array[integer] | 集合ID |  |
| orderNo | query | 否 | string | 订单号 |  |
| statusList | query | 否 | array[string] | 订单状态 | 2 |
| productName | query | 否 | string | 商品名称 |  |
| discountUsedAtTime | query | 否 | array[string] | 折扣使用时间 |  |
| discountId | query | 否 | integer | 折扣ID |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 4. 获得订单

- 分组：管理后台 - 订单
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/order/get`
- operationId：`Order_getOrder`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultOrderRespVO` |

### 5. 获得订单分页

- 分组：管理后台 - 订单
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/order/page`
- operationId：`Order_getOrderPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| isAnon | query | 否 | integer | 订单类型 | （游客支付=1，登录支付=2） |
| ids | query | 否 | array[integer] | 集合ID |  |
| orderNo | query | 否 | string | 订单号 |  |
| statusList | query | 否 | array[string] | 订单状态 | 2 |
| productName | query | 否 | string | 商品名称 |  |
| discountUsedAtTime | query | 否 | array[string] | 折扣使用时间 |  |
| discountId | query | 否 | integer | 折扣ID |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultOrderRespVO` |

### 6. 设置订单备注

- 分组：管理后台 - 订单
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/order/set-remark`
- operationId：`Order_updateOrderRemark`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`OrderSetRemarkReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | ID | 是 | integer | 1316 |
| sellerRemark | 商家备注 | 是 | string |  |
| userId | 用户id | 否 | integer |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 认证

### 1. 获取登录用户的权限信息

- 分组：管理后台 - 认证
- 请求方式：`GET`
- 接口路径：`/admin-api/system/auth/get-permission-info`
- operationId：`Auth_getPermissionInfo`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAuthPermissionInfoRespVO` |

### 2. 使用账号密码登录

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/login`
- operationId：`Auth_login`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AuthLoginReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| captchaVerification | 验证码，验证码开启时，需要传递 | 是 | string | PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg== |
| username | 账号 | 是 | string | yudaoyuanma |
| password | 密码 | 是 | string | buzhidao |
| fingerprint | 指纹 | 是 | string | buzhidao |
| socialType | 社交平台的类型，参见 SocialTypeEnum 枚举值 | 是 | integer | 10 |
| socialCode | 授权码 | 是 | string | 1024 |
| socialState | state | 是 | string | 9b2ffbc1-7425-4155-9894-9d5c08541d62 |
| socialCodeValid |  | 否 | boolean |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAuthLoginRespVO` |

### 3. 使用账号密码登录

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/login-dev`
- operationId：`Auth_loginDev`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AuthLoginReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| captchaVerification | 验证码，验证码开启时，需要传递 | 是 | string | PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg== |
| username | 账号 | 是 | string | yudaoyuanma |
| password | 密码 | 是 | string | buzhidao |
| fingerprint | 指纹 | 是 | string | buzhidao |
| socialType | 社交平台的类型，参见 SocialTypeEnum 枚举值 | 是 | integer | 10 |
| socialCode | 授权码 | 是 | string | 1024 |
| socialState | state | 是 | string | 9b2ffbc1-7425-4155-9894-9d5c08541d62 |
| socialCodeValid |  | 否 | boolean |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAuthLoginRespVO` |

### 4. 登出系统

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/logout`
- operationId：`Auth_logout`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 5. 刷新令牌

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/refresh-token`
- operationId：`Auth_refreshToken`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| refreshToken | query | 是 | string | 刷新令牌 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAuthLoginRespVO` |

### 6. 注册用户

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/register`
- operationId：`Auth_register`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AuthRegisterReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| captchaVerification | 验证码，验证码开启时，需要传递 | 是 | string | PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg== |
| username | 用户账号 | 是 | string | yudao |
| nickname | 用户昵称 | 是 | string | 芋艿 |
| password | 密码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAuthLoginRespVO` |

### 7. 重置密码

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/reset-password`
- operationId：`Auth_resetPassword`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AuthResetPasswordReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| password | 密码 | 是 | string | 1234 |
| mobile | 手机号 | 是 | string | 13312341234 |
| code | 手机短信验证码 | 是 | string | 123456 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 8. 发送手机验证码

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/send-sms-code`
- operationId：`Auth_sendLoginSmsCode`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AuthSmsSendReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| captchaVerification | 验证码，验证码开启时，需要传递 | 是 | string | PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg== |
| mobile | 手机号 | 是 | string | yudaoyuanma |
| scene | 短信场景 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 9. 使用短信验证码登录

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/sms-login`
- operationId：`Auth_smsLogin`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AuthSmsLoginReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| mobile | 手机号 | 是 | string | yudaoyuanma |
| code | 短信验证码 | 是 | string | 1024 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAuthLoginRespVO` |

### 10. 社交授权的跳转

- 分组：管理后台 - 认证
- 请求方式：`GET`
- 接口路径：`/admin-api/system/auth/social-auth-redirect`
- operationId：`Auth_socialLogin`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | query | 是 | integer | 社交类型 |  |
| redirectUri | query | 是 | string | 回调路径 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 11. 社交快捷登录，使用 code 授权码

- 分组：管理后台 - 认证
- 请求方式：`POST`
- 接口路径：`/admin-api/system/auth/social-login`
- operationId：`Auth_socialQuickLogin`
- 描述：适合未登录的用户，但是社交账号已绑定用户

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`AuthSocialLoginReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| type | 社交平台的类型，参见 UserSocialTypeEnum 枚举值 | 是 | integer | 10 |
| code | 授权码 | 是 | string | 1024 |
| state | state | 是 | string | 9b2ffbc1-7425-4155-9894-9d5c08541d62 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultAuthLoginRespVO` |

## 管理后台 - 路由

### 1. 创建路由

- 分组：管理后台 - 路由
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/route/create`
- operationId：`Route_createRoute`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`RouteSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| route | 路由 | 是 | string |  |
| cate | 类别 | 是 | string |  |
| relationId | 关联的类别id | 是 | integer | 14255 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 2. 删除路由

- 分组：管理后台 - 路由
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/route/delete`
- operationId：`Route_deleteRoute`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | string | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除路由

- 分组：管理后台 - 路由
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/route/delete-list`
- operationId：`Route_deleteRouteList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[string] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出路由 Excel

- 分组：管理后台 - 路由
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/route/export-excel`
- operationId：`Route_exportRouteExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| route | query | 否 | string | 路由 |  |
| deptId | query | 否 | integer | 权限部门ID | 11390 |
| userId | query | 否 | integer | 权限用户ID | 24814 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 获得路由

- 分组：管理后台 - 路由
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/route/get`
- operationId：`Route_getRoute`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | string | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultRouteRespVO` |

### 6. 获得导入路由模板

- 分组：管理后台 - 路由
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/route/get-import-template`
- operationId：`Route_getImportTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 7. 导入路由Excel

- 分组：管理后台 - 路由
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/route/import-excel`
- operationId：`Route_importRouteExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| updateSupport | query | 是 | boolean | 是否支持更新 | True |
| userId | query | 否 | integer | 创建人-为空则取当前人 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultRouteImportRespVO` |

### 8. 获得路由分页

- 分组：管理后台 - 路由
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/route/page`
- operationId：`Route_getRoutePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| route | query | 否 | string | 路由 |  |
| deptId | query | 否 | integer | 权限部门ID | 11390 |
| userId | query | 否 | integer | 权限用户ID | 24814 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultRouteRespVO` |

### 9. 更新路由

- 分组：管理后台 - 路由
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/route/update`
- operationId：`Route_updateRoute`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`RouteSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| route | 路由 | 是 | string |  |
| cate | 类别 | 是 | string |  |
| relationId | 关联的类别id | 是 | integer | 14255 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 运费模板信息

### 1. 创建运费模板信息

- 分组：管理后台 - 运费模板信息
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/shipping-template/create`
- operationId：`ShippingTemplate_createShippingTemplate`
- 描述：创建运费模板信息，不包括创建运费规则。

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ShippingTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 8831 |
| templateName | 模板名称 | 是 | string | 芋艿 |
| isDefault | 是否为默认模板，1-是，2-否 | 是 | integer |  |
| calculationAlgorithm | 运费计算算法，fixed_amount-固定金额，percentage-百分比 | 是 | string |  |
| currency | 币种 | 是 | string |  |
| status | 状态 1-启用，2-停用 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除运费模板信息

- 分组：管理后台 - 运费模板信息
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/shipping-template/delete`
- operationId：`ShippingTemplate_deleteShippingTemplate`
- 描述：删除运费模板信息，包括删除运费规则。启用的不能删。

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除运费模板信息

- 分组：管理后台 - 运费模板信息
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/shipping-template/delete-list`
- operationId：`ShippingTemplate_deleteShippingTemplateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. ***获得运费模板详情（含规则与子表）

- 分组：管理后台 - 运费模板信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/shipping-template/get-detail`
- operationId：`ShippingTemplate_getShippingTemplateDetail`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultShippingTemplateDetailRespVO` |

### 5. ***获得运费模板信息分页

- 分组：管理后台 - 运费模板信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/shipping-template/page`
- operationId：`ShippingTemplate_getShippingTemplatePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| templateName | query | 否 | string | 模板名称 | 芋艿 |
| isDefault | query | 否 | integer | 是否为默认模板，1-是，2-否 |  |
| calculationAlgorithm | query | 否 | string | 运费计算算法，fixed_amount-固定金额，percentage-百分比 |  |
| currency | query | 否 | string | 币种 |  |
| status | query | 否 | integer | 状态 1-启用，2-停用 | 1 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| deptId | query | 否 | integer | 权限部门ID | 13022 |
| userId | query | 否 | integer | 权限用户ID | 18271 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultShippingTemplateRespVO` |

### 6. 保存运费模板信息（含规则与子表）

- 分组：管理后台 - 运费模板信息
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/shipping-template/save-with-children`
- operationId：`ShippingTemplate_saveShippingTemplateWithChildren`
- 描述：***保存运费模板信息（含规则与子表）。

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ShippingTemplateSaveWithChildrenReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键，新增为0，修改要保证存在 | 否 | integer | 8831 |
| templateName | 模板名称 | 是 | string | 模板A |
| isDefault | 是否为默认模板，1-是，2-否 | 是 | integer |  |
| calculationAlgorithm | 运费计算算法，fixed_amount-固定金额，percentage-百分比 | 是 | string |  |
| currency | 币种 | 是 | string |  |
| status | 状态 1-启用，2-停用 | 是 | integer | 1 |
| shippingRules | 运费规则列表（含国家与价格区间） | 否 | array[ShippingRuleSaveWithChildrenReqVO] |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 7. 获得运费规则列表

- 分组：管理后台 - 运费模板信息
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/shipping-template/shipping-rule/list-by-shipping-template-id`
- operationId：`ShippingTemplate_getShippingRuleListByShippingTemplateId`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| shippingTemplateId | query | 是 | integer | 关联的模板ID |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListShippingRuleDO` |

### 8. 更新运费模板信息

- 分组：管理后台 - 运费模板信息
- 请求方式：`PUT`
- 接口路径：`/admin-api/jh/shipping-template/update`
- operationId：`ShippingTemplate_updateShippingTemplate`
- 描述：更新运费模板信息，不包括更新运费规则。

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`ShippingTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 8831 |
| templateName | 模板名称 | 是 | string | 芋艿 |
| isDefault | 是否为默认模板，1-是，2-否 | 是 | integer |  |
| calculationAlgorithm | 运费计算算法，fixed_amount-固定金额，percentage-百分比 | 是 | string |  |
| currency | 币种 | 是 | string |  |
| status | 状态 1-启用，2-停用 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 通知公告

### 1. 创建通知公告

- 分组：管理后台 - 通知公告
- 请求方式：`POST`
- 接口路径：`/admin-api/system/notice/create`
- operationId：`Notice_createNotice`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NoticeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 岗位公告编号 | 否 | integer | 1024 |
| title | 公告标题 | 是 | string | 小博主 |
| type | 公告类型 | 是 | integer | 小博主 |
| content | 公告内容 | 是 | string | 半生编码 |
| status | 状态，参见 CommonStatusEnum 枚举类 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除通知公告

- 分组：管理后台 - 通知公告
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/notice/delete`
- operationId：`Notice_deleteNotice`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除通知公告

- 分组：管理后台 - 通知公告
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/notice/delete-list`
- operationId：`Notice_deleteNoticeList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得通知公告

- 分组：管理后台 - 通知公告
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notice/get`
- operationId：`Notice_getNotice`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultNoticeRespVO` |

### 5. 获取通知公告列表

- 分组：管理后台 - 通知公告
- 请求方式：`GET`
- 接口路径：`/admin-api/system/notice/page`
- operationId：`Notice_getNoticePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| title | query | 否 | string | 通知公告名称，模糊匹配 | 芋道 |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultNoticeRespVO` |

### 6. 推送通知公告

- 分组：管理后台 - 通知公告
- 请求方式：`POST`
- 接口路径：`/admin-api/system/notice/push`
- operationId：`Notice_push`
- 描述：只发送给 websocket 连接在线的用户

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 7. 修改通知公告

- 分组：管理后台 - 通知公告
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/notice/update`
- operationId：`Notice_updateNotice`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`NoticeSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 岗位公告编号 | 否 | integer | 1024 |
| title | 公告标题 | 是 | string | 小博主 |
| type | 公告类型 | 是 | integer | 小博主 |
| content | 公告内容 | 是 | string | 半生编码 |
| status | 状态，参见 CommonStatusEnum 枚举类 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 邮件日志

### 1. 获得邮箱日志

- 分组：管理后台 - 邮件日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-log/get`
- operationId：`MailLog_getMailTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultMailLogRespVO` |

### 2. 获得邮箱日志分页

- 分组：管理后台 - 邮件日志
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-log/page`
- operationId：`MailLog_getMailLogPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | query | 否 | integer | 用户编号 | 30883 |
| userType | query | 否 | integer | 用户类型，参见 UserTypeEnum 枚举 | 2 |
| toMail | query | 否 | string | 接收邮箱地址，模糊匹配 | 76854@qq.com |
| accountId | query | 否 | integer | 邮箱账号编号 | 18107 |
| templateId | query | 否 | integer | 模板编号 | 5678 |
| sendStatus | query | 否 | integer | 发送状态，参见 MailSendStatusEnum 枚举 | 1 |
| sendTime | query | 否 | array[string] | 发送时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultMailLogRespVO` |

## 管理后台 - 邮件模版

### 1. 创建邮件模版

- 分组：管理后台 - 邮件模版
- 请求方式：`POST`
- 接口路径：`/admin-api/system/mail-template/create`
- operationId：`MailTemplate_createMailTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`MailTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| name | 模版名称 | 是 | string | 测试名字 |
| code | 模版编号 | 是 | string | test |
| accountId | 发送的邮箱账号编号 | 是 | integer | 1 |
| nickname | 发送人名称 | 否 | string | 芋头 |
| title | 标题 | 是 | string | 注册成功 |
| content | 内容 | 是 | string | 你好，注册成功啦 |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 奥特曼 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除邮件模版

- 分组：管理后台 - 邮件模版
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/mail-template/delete`
- operationId：`MailTemplate_deleteMailTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除邮件模版

- 分组：管理后台 - 邮件模版
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/mail-template/delete-list`
- operationId：`MailTemplate_deleteMailTemplateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得邮件模版

- 分组：管理后台 - 邮件模版
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-template/get`
- operationId：`MailTemplate_getMailTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultMailTemplateRespVO` |

### 5. 获得邮件模版精简列表

- 分组：管理后台 - 邮件模版
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-template/list-all-simple`
- operationId：`MailTemplate_getSimpleTemplateList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListMailTemplateSimpleRespVO` |

### 6. 获得邮件模版分页

- 分组：管理后台 - 邮件模版
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-template/page`
- operationId：`MailTemplate_getMailTemplatePage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| status | query | 否 | integer | 状态，参见 CommonStatusEnum 枚举 | 1 |
| code | query | 否 | string | 标识，模糊匹配 | code_1024 |
| name | query | 否 | string | 名称，模糊匹配 | 芋头 |
| accountId | query | 否 | integer | 账号编号 | 2048 |
| createTime | query | 否 | array[string] | 创建时间 |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultMailTemplateRespVO` |

### 7. 发送邮件

- 分组：管理后台 - 邮件模版
- 请求方式：`POST`
- 接口路径：`/admin-api/system/mail-template/send-mail`
- operationId：`MailTemplate_sendMail`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`MailTemplateSendReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| toMails | 接收邮箱 | 是 | array[string] | [user1@example.com, user2@example.com] |
| ccMails | 抄送邮箱 | 是 | array[string] | [user3@example.com, user4@example.com] |
| bccMails | 密送邮箱 | 是 | array[string] | [user5@example.com, user6@example.com] |
| templateCode | 模板编码 | 是 | string | test_01 |
| templateParams | 模板参数 | 否 | object |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 8. 获得邮件模版精简列表

- 分组：管理后台 - 邮件模版
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-template/simple-list`
- operationId：`MailTemplate_getSimpleTemplateList_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListMailTemplateSimpleRespVO` |

### 9. 修改邮件模版

- 分组：管理后台 - 邮件模版
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/mail-template/update`
- operationId：`MailTemplate_updateMailTemplate`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`MailTemplateSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| name | 模版名称 | 是 | string | 测试名字 |
| code | 模版编号 | 是 | string | test |
| accountId | 发送的邮箱账号编号 | 是 | integer | 1 |
| nickname | 发送人名称 | 否 | string | 芋头 |
| title | 标题 | 是 | string | 注册成功 |
| content | 内容 | 是 | string | 你好，注册成功啦 |
| status | 状态，参见 CommonStatusEnum 枚举 | 是 | integer | 1 |
| remark | 备注 | 否 | string | 奥特曼 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 邮箱账号

### 1. 创建邮箱账号

- 分组：管理后台 - 邮箱账号
- 请求方式：`POST`
- 接口路径：`/admin-api/system/mail-account/create`
- operationId：`MailAccount_createMailAccount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`MailAccountSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| mail | 邮箱 | 是 | string | yudaoyuanma@123.com |
| username | 用户名 | 是 | string | yudao |
| password | 密码 | 是 | string | 123456 |
| host | SMTP 服务器域名 | 是 | string | www.iocoder.cn |
| port | SMTP 服务器端口 | 是 | integer | 80 |
| sslEnable | 是否开启 ssl | 是 | boolean | True |
| starttlsEnable | 是否开启 starttls | 是 | boolean | True |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除邮箱账号

- 分组：管理后台 - 邮箱账号
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/mail-account/delete`
- operationId：`MailAccount_deleteMailAccount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除邮箱账号

- 分组：管理后台 - 邮箱账号
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/mail-account/delete-list`
- operationId：`MailAccount_deleteMailAccountList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得邮箱账号

- 分组：管理后台 - 邮箱账号
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-account/get`
- operationId：`MailAccount_getMailAccount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultMailAccountRespVO` |

### 5. 获得邮箱账号精简列表

- 分组：管理后台 - 邮箱账号
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-account/list-all-simple`
- operationId：`MailAccount_getSimpleMailAccountList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListMailAccountSimpleRespVO` |

### 6. 获得邮箱账号分页

- 分组：管理后台 - 邮箱账号
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-account/page`
- operationId：`MailAccount_getMailAccountPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| mail | query | 是 | string | 邮箱 | yudaoyuanma@123.com |
| username | query | 是 | string | 用户名 | yudao |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultMailAccountRespVO` |

### 7. 获得邮箱账号精简列表

- 分组：管理后台 - 邮箱账号
- 请求方式：`GET`
- 接口路径：`/admin-api/system/mail-account/simple-list`
- operationId：`MailAccount_getSimpleMailAccountList_1`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListMailAccountSimpleRespVO` |

### 8. 修改邮箱账号

- 分组：管理后台 - 邮箱账号
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/mail-account/update`
- operationId：`MailAccount_updateMailAccount`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`MailAccountSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 编号 | 否 | integer | 1024 |
| mail | 邮箱 | 是 | string | yudaoyuanma@123.com |
| username | 用户名 | 是 | string | yudao |
| password | 密码 | 是 | string | 123456 |
| host | SMTP 服务器域名 | 是 | string | www.iocoder.cn |
| port | SMTP 服务器端口 | 是 | integer | 80 |
| sslEnable | 是否开启 ssl | 是 | boolean | True |
| starttlsEnable | 是否开启 starttls | 是 | boolean | True |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 部门

### 1. 创建部门

- 分组：管理后台 - 部门
- 请求方式：`POST`
- 接口路径：`/admin-api/system/dept/create`
- operationId：`Dept_createDept`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DeptSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 部门编号 | 否 | integer | 1024 |
| name | 部门名称 | 是 | string | 芋道 |
| parentId | 父部门 ID | 否 | integer | 1024 |
| sort | 显示顺序 | 是 | integer | 1024 |
| leaderUserId | 负责人的用户编号 | 否 | integer | 2048 |
| phone | 联系电话 | 否 | string | 15601691000 |
| email | 邮箱 | 否 | string | yudao@iocoder.cn |
| status | 状态,见 CommonStatusEnum 枚举 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除部门

- 分组：管理后台 - 部门
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/dept/delete`
- operationId：`Dept_deleteDept`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除部门

- 分组：管理后台 - 部门
- 请求方式：`DELETE`
- 接口路径：`/admin-api/system/dept/delete-list`
- operationId：`Dept_deleteDeptList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号列表 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 获得部门信息

- 分组：管理后台 - 部门
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dept/get`
- operationId：`Dept_getDept`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultDeptRespVO` |

### 5. 获取部门列表

- 分组：管理后台 - 部门
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dept/list`
- operationId：`Dept_getDeptList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 部门名称，模糊匹配 | 芋道 |
| status | query | 否 | integer | 展示状态，参见 CommonStatusEnum 枚举类 | 1 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDeptRespVO` |

### 6. 获取部门精简信息列表

- 分组：管理后台 - 部门
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dept/list-all-simple`
- operationId：`Dept_getSimpleDeptList`
- 描述：只包含被开启的部门，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDeptSimpleRespVO` |

### 7. 获取部门精简信息列表

- 分组：管理后台 - 部门
- 请求方式：`GET`
- 接口路径：`/admin-api/system/dept/simple-list`
- operationId：`Dept_getSimpleDeptList_1`
- 描述：只包含被开启的部门，主要用于前端的下拉选项

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultListDeptSimpleRespVO` |

### 8. 更新部门

- 分组：管理后台 - 部门
- 请求方式：`PUT`
- 接口路径：`/admin-api/system/dept/update`
- operationId：`Dept_updateDept`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`DeptSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 部门编号 | 否 | integer | 1024 |
| name | 部门名称 | 是 | string | 芋道 |
| parentId | 父部门 ID | 否 | integer | 1024 |
| sort | 显示顺序 | 是 | integer | 1024 |
| leaderUserId | 负责人的用户编号 | 否 | integer | 2048 |
| phone | 联系电话 | 否 | string | 15601691000 |
| email | 邮箱 | 否 | string | yudao@iocoder.cn |
| status | 状态,见 CommonStatusEnum 枚举 | 是 | integer | 1 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

## 管理后台 - 链接

### 1. 创建链接

- 分组：管理后台 - 链接
- 请求方式：`POST`
- 接口路径：`/admin-api/jh/landing-page-tracker/create`
- operationId：`LandingPageTracker_createLandingPageTracker`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`LandingPageTrackerSaveReqVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| id | 主键 | 是 | integer | 5995 |
| pagePath | 落地页url | 是 | string |  |
| utmSource | utm_source | 是 | string |  |
| utmAccount | utm_account | 是 | string | 17476 |
| utmMedium | utm_medium | 是 | string |  |
| utmCampaign | utm_campaign | 是 | string |  |
| utmContent | utm_content | 是 | string |  |
| pageUrl | 完整落地页链接 | 是 | string | https://www.iocoder.cn |
| remark | 备注 | 否 | string | 随便 |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLong` |

### 2. 删除链接

- 分组：管理后台 - 链接
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/landing-page-tracker/delete`
- operationId：`LandingPageTracker_deleteLandingPageTracker`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 3. 批量删除链接

- 分组：管理后台 - 链接
- 请求方式：`DELETE`
- 接口路径：`/admin-api/jh/landing-page-tracker/delete-list`
- operationId：`LandingPageTracker_deleteLandingPageTrackerList`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 编号 |  |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultBoolean` |

### 4. 导出引流统计明细 Excel

- 分组：管理后台 - 链接
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/landing-page-tracker/export-detail-excel`
- operationId：`LandingPageTracker_exportLandingPageTrackerDetailExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| ids | query | 是 | array[integer] | 选择ID |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 5. 导出引流统计列表 Excel

- 分组：管理后台 - 链接
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/landing-page-tracker/export-excel`
- operationId：`LandingPageTracker_exportLandingPageTrackerExcel`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pagePath | query | 否 | string | 落地页url |  |
| utmSource | query | 否 | string | utm_source |  |
| utmAccount | query | 否 | string | utm_account | 17476 |
| utmMedium | query | 否 | string | utm_medium |  |
| utmCampaign | query | 否 | string | utm_campaign |  |
| utmContent | query | 否 | string | utm_content |  |
| pageUrl | query | 否 | string | 完整落地页链接 | https://www.iocoder.cn |
| deptId | query | 否 | integer | 权限部门ID | 25612 |
| userId | query | 否 | integer | 权限用户ID | 11336 |
| ids | query | 否 | array[integer] | 选择ID |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `` |

### 6. 获得链接

- 分组：管理后台 - 链接
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/landing-page-tracker/get`
- operationId：`LandingPageTracker_getLandingPageTracker`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | integer | 编号 | 1024 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultLandingPageTrackerRespVO` |

### 7. 获得链接分页

- 分组：管理后台 - 链接
- 请求方式：`GET`
- 接口路径：`/admin-api/jh/landing-page-tracker/page`
- operationId：`LandingPageTracker_getLandingPageTrackerPage`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| pagePath | query | 否 | string | 落地页url |  |
| utmSource | query | 否 | string | utm_source |  |
| utmAccount | query | 否 | string | utm_account | 17476 |
| utmMedium | query | 否 | string | utm_medium |  |
| utmCampaign | query | 否 | string | utm_campaign |  |
| utmContent | query | 否 | string | utm_content |  |
| pageUrl | query | 否 | string | 完整落地页链接 | https://www.iocoder.cn |
| deptId | query | 否 | integer | 权限部门ID | 25612 |
| userId | query | 否 | integer | 权限用户ID | 11336 |
| ids | query | 否 | array[integer] | 选择ID |  |
| pageNo | query | 是 | integer | 页码，从 1 开始 | 1 |
| pageSize | query | 是 | integer | 每页条数，最大值为 999 | 10 |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultPageResultLandingPageTrackerRespVO` |

## 管理后台 - 领星订单同步调试

### 1. 手动触发领星订单同步

- 分组：管理后台 - 领星订单同步调试
- 请求方式：`GET`
- 接口路径：`/admin-api/admin-api/jh/lingxing-sync/execute`
- operationId：`LingXingOrderSync_execute`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 2. 手动触发自动完成订单同步

- 分组：管理后台 - 领星订单同步调试
- 请求方式：`GET`
- 接口路径：`/admin-api/admin-api/jh/lingxing-sync/execute/autocompilte`
- operationId：`LingXingOrderSync_executeAuto`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

### 3. 手动触发PayPal物流推送补偿任务

- 分组：管理后台 - 领星订单同步调试
- 请求方式：`GET`
- 接口路径：`/admin-api/admin-api/jh/lingxing-sync/execute/paypal-retry`
- operationId：`LingXingOrderSync_executePayPalRetry`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `CommonResultString` |

## 管理后台 - 验证码

### 1. 校验验证码

- 分组：管理后台 - 验证码
- 请求方式：`POST`
- 接口路径：`/admin-api/system/captcha/check`
- operationId：`Captcha_check`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CaptchaVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| captchaId |  | 否 | string |  |
| projectCode |  | 否 | string |  |
| captchaType |  | 否 | string |  |
| captchaOriginalPath |  | 否 | string |  |
| captchaFontType |  | 否 | string |  |
| captchaFontSize |  | 否 | integer |  |
| secretKey |  | 否 | string |  |
| originalImageBase64 |  | 否 | string |  |
| point |  | 否 | PointVO |  |
| jigsawImageBase64 |  | 否 | string |  |
| wordList |  | 否 | array[string] |  |
| pointList |  | 否 | array[object] |  |
| pointJson |  | 否 | string |  |
| token |  | 否 | string |  |
| result |  | 否 | boolean |  |
| captchaVerification |  | 否 | string |  |
| clientUid |  | 否 | string |  |
| ts |  | 否 | integer |  |
| browserInfo |  | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `ResponseModel` |

### 2. 获得验证码

- 分组：管理后台 - 验证码
- 请求方式：`POST`
- 接口路径：`/admin-api/system/captcha/get`
- operationId：`Captcha_get`

#### 请求参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tenant-id | header | 否 | integer | 租户编号 |  |
| Authorization | header | 否 | string | 认证 Token |  |

#### 请求体

- 必填：是
- Content-Type：`application/json`
- Schema：`CaptchaVO`

| 字段 | 说明 | 必填 | 类型 | 示例 |
| --- | --- | --- | --- | --- |
| captchaId |  | 否 | string |  |
| projectCode |  | 否 | string |  |
| captchaType |  | 否 | string |  |
| captchaOriginalPath |  | 否 | string |  |
| captchaFontType |  | 否 | string |  |
| captchaFontSize |  | 否 | integer |  |
| secretKey |  | 否 | string |  |
| originalImageBase64 |  | 否 | string |  |
| point |  | 否 | PointVO |  |
| jigsawImageBase64 |  | 否 | string |  |
| wordList |  | 否 | array[string] |  |
| pointList |  | 否 | array[object] |  |
| pointJson |  | 否 | string |  |
| token |  | 否 | string |  |
| result |  | 否 | boolean |  |
| captchaVerification |  | 否 | string |  |
| clientUid |  | 否 | string |  |
| ts |  | 否 | integer |  |
| browserInfo |  | 否 | string |  |

#### 响应

| 状态码 | 说明 | Schema |
| --- | --- | --- |
| 200 | OK | `ResponseModel` |