taijibaga/taiji-AI-PAD

Fork 0

forked from xiaohei/taiji-AI-PAD

Files

T

Ubuntu 23c84ea23e 更新接口文档

2026-01-05 10:09:07 +00:00

17 KiB

Raw Blame History

渠道端平台业务功能文档

本文档整理了渠道端平台（Channel Partner Portal）前端所展示的所有功能模块，供后端团队核对设计和完善API接口。

文档概述

平台名称: 渠道合作伙伴平台 (Channel Partner Portal)
访问路径: /channel/dashboard/
登录入口: /channel/login/
目标用户: 渠道合作伙伴（Channel Partner）、计费管理员（Billing Admin）、运营管理员（Operations Admin）

一、用户认证模块

1.1 渠道登录

功能项	说明
功能名称	渠道用户登录
功能描述	渠道合作伙伴通过邮箱和密码登录系统
前端路径	`/channel/login/`
API接口	`POST /api/auth/login`
请求参数	`email`: 邮箱地址 `password`: 密码 `role`: "channel"
返回数据	`token`: 认证令牌 `refreshToken`: 刷新令牌 `user`: 用户信息
Token存储	`channel_token` (localStorage + Cookie)

1.2 退出登录

功能项	说明
功能名称	退出登录
功能描述	清除认证状态，退出系统
API接口	`POST /api/auth/logout`
前端行为	清除所有本地存储的token，跳转到登录页

二、仪表板模块（Dashboard / Overview）

2.1 统计概览卡片

功能项	说明
功能名称	渠道统计概览
功能描述	展示渠道的核心业务指标
展示数据
- 总租户数	`totalTenants`: 该渠道下的租户总数
- 活跃租户	`activeTenants`: 状态为active的租户数量
- 月度收入	`monthlyRevenue`: 当月收入金额
- 已获佣金	`commission`: 累计佣金收入
API接口	`GET /api/channel/tenants` (从租户列表计算)
待完善	需要后端提供专门的统计接口，包含月度收入和佣金数据

2.2 可分配Agent概览

功能项	说明
功能名称	Agent资源概览
功能描述	展示渠道可分配给租户的Agent资源列表
展示数据
- Agent名称	`name`: Agent类型名称
- Agent描述	`description`: Agent功能描述
- 可分配数量	`quantity` / `available` / `maxInstances`: 可用实例数
API接口	`GET /api/admin/resources/agents`
备注	当前使用admin接口，建议后端提供渠道专用接口

三、租户管理模块（My Tenants）

3.1 租户列表

功能项	说明
功能名称	租户列表展示
功能描述	展示该渠道下所有租户的基本信息
API接口	`GET /api/channel/tenants`
展示字段
- 租户名称	`name`
- 状态	`status`: active/suspended
- 方案	`plan`: enterprise/professional/starter
- 用户数	`users`
- 月收入	`revenue`
搜索功能	支持按租户名称搜索（前端过滤）

3.2 创建租户

功能项	说明
功能名称	创建新租户
功能描述	渠道为其客户创建新的租户账号
API接口	`POST /api/channel/tenants/create`
请求参数
- 公司名称	`name`: 租户名称（必填）
- 联系邮箱	`email`: 登录邮箱（必填）
- 密码	`password`: 登录密码（必填）
- 订阅等级	`subscriptionTier`: free/pro/enterprise
角色映射	tenant→free, admin→pro, billing-admin→enterprise
备注	前端锁定为"租户"角色，避免渠道自行调整权限

3.3 查看租户详情

功能项	说明
功能名称	租户详情查看
功能描述	查看租户的详细信息
展示字段
- 租户名称	`name`
- 状态	`status`
- 方案	`plan`
- 用户数	`users`
- 月度收入	`revenue`
- 创建时间	`createdAt`

3.4 删除租户

功能项	说明
功能名称	删除租户（软删除）
功能描述	删除指定租户及其所有数据
API接口	`DELETE /api/channel/tenants/{tenantId}`
确认机制	二次确认弹窗，显示租户信息和警告提示

3.5 资源分配

功能项	说明
功能名称	为租户分配资源
功能描述	为租户分配Agent配额和模型配额
API接口	`PUT /api/channel/tenants/{tenantId}/resources`
请求参数
- Agent配额	`agents`: Array<{agentId, quantity}>
- 模型配额	`models`: Array<{modelName, rpm, tpm}>
- 自定义Agent资源	`customAgentResources`: {cpu, memory}

3.5.1 Agent配额分配

字段	说明
Agent类型	从可用Agent列表中选择
分配数量	0到可用数量之间的整数

3.5.2 自定义Agent资源配置

字段	说明
CPU	核数/Agent，推荐范围0.5-16核
Memory	GB/Agent，推荐范围0.5-64GB

3.5.3 模型配额分配

字段	说明
模型型号	`modelName`: 如gpt-4, claude-3
RPM	每分钟请求数限制
TPM	每分钟令牌数限制

3.6 租户充值

功能项	说明
功能名称	为租户充值
功能描述	为租户账户充值余额
API接口	`POST /api/channel/tenants/{tenantId}/recharge`
请求参数	`amount`: 充值金额（USD）
快捷金额	$50, $100, $500, $1000
展示信息	当前余额、充值后余额

3.7 授信额度设置

功能项	说明
功能名称	设置租户授信额度
功能描述	允许租户在余额不足时继续使用服务
API接口	`PUT /api/channel/tenants/{tenantId}/credit`
请求参数	`creditLimit`: 授信额度（USD）
快捷金额	$500, $1000, $5000, $10000

3.8 计费管理

功能项	说明
功能名称	管理租户计费设置
功能描述	设置租户的订阅层级和折扣比例
API接口	`PUT /api/channel/tenants/{tenantId}/billing`
请求参数
- 订阅层级	`subscriptionTier`: free/professional/enterprise
- 折扣比例	`discount`: 0-100的百分比

订阅层级说明

层级	价格	说明
免费版 (free)	$0/mo	基础功能
专业版 (professional)	$1,800/mo	适合中小企业
企业版 (enterprise)	$3,200/mo	无限制

四、资源管理模块（Resource Management）

4.1 Agent计算资源

功能项	说明
功能名称	Agent资源监控
功能描述	展示渠道已分配的Agent计算资源及使用情况
API接口	`GET /api/admin/resources/agents`
展示字段
- Agent名称	`name`
- 状态	`status`: active/idle
- CPU	`cpu`: 核心数
- 内存	`memory`: GB
- 可用配额	`quantity` / `available`
- CPU使用率	`usage.cpu`: 百分比
- 内存使用率	`usage.memory`: 百分比

4.2 模型管理

功能项	说明
功能名称	模型供应商管理
功能描述	展示渠道可用的模型供应商及授权状态
API接口	`GET /api/channel/providers`
展示字段
- 供应商名称	`name`
- 供应商类型	`provider` / `type`
- 授权状态	`status`: active(已授权)/pending(待审批)
- 支持模型数	`supportedModels.length`
- 授权RPM	`rpm`
- 授权TPM	`tpm`

4.3 资源申请

功能项	说明
功能名称	提交资源申请
功能描述	向超级管理员申请新的模型或Agent资源
API接口
- 模型申请	`POST /api/channel/providers/apply`
- 通用申请	`POST /api/channel/resources/apply`

4.3.1 模型供应商申请

请求参数	说明
`providerId`	供应商ID
`requestedRpm`	申请的RPM配额
`requestedTpm`	申请的TPM配额
`reason`	申请理由

4.3.2 Agent配额申请

请求参数	说明
`type`	"agent"
`agentType`	Agent类型名称
`quantity`	申请数量
`reason`	申请理由

五、计费管理模块（Billing）

5.1 租户计费统计

功能项	说明
功能名称	租户计费统计
功能描述	按租户维度展示计费统计数据
API接口	`GET /api/channel/billing/stats`
查询参数
- 开始时间	`startTime`: ISO 8601格式
- 结束时间	`endTime`: ISO 8601格式
- 租户名称	`tenantName`: 可选筛选
- 最小调用数	`minCalls`: 可选筛选
- 最大调用数	`maxCalls`: 可选筛选
- 导出格式	`export`: excel/csv/pdf
返回数据
- 租户统计	`tenantStats`: Array
- 调用记录	`callRecords`: Array

租户统计字段

字段	说明
`tenantId`	租户ID
`tenantName`	租户名称
`calls`	调用次数
`totalEU`	总EU消耗
`totalCost`	租户总价（¥）

5.2 调用记录明细

功能项	说明
功能名称	调用记录查询
功能描述	展示详细的调用记录
计费规则	1 EU = 10秒调用时长

调用记录字段

字段	说明
`timestamp` / `time`	调用时间戳
`tenantName` / `tenant`	租户名称
`agentType` / `agent`	Agent类型
`duration`	调用时长（秒）
`eu`	EU消耗
`price` / `cost`	单次调用价格（¥）

5.3 筛选功能

功能项	说明
功能名称	计费数据筛选
筛选条件
- 客户名称	按租户名称筛选
- 最小调用次数	筛选调用次数下限
- 最大调用次数	筛选调用次数上限

5.4 时间查询

功能项	说明
功能名称	时间范围查询
查询参数
- 开始时间	datetime-local格式
- 结束时间	datetime-local格式
默认范围	最近30天

5.5 数据导出

功能项	说明
功能名称	计费数据导出
支持格式
- Excel	.xlsx格式
- CSV	.csv格式
- PDF	.pdf格式

六、系统设置模块（Settings）

6.1 管理员列表

功能项	说明
功能名称	渠道管理员列表
功能描述	展示该渠道下的所有管理员
API接口	`GET /api/channel/admins`
展示字段
- 管理员名称	`name`
- 邮箱	`email`
- 角色	`role`: channel_admin/billing_admin/operations_admin
- 状态	`status`: active/inactive

6.2 创建管理员

功能项	说明
功能名称	创建渠道管理员
功能描述	创建计费管理员或运营管理员
API接口	`POST /api/channel/admins/create`
请求参数
- 姓名	`name`: 管理员姓名
- 邮箱	`email`: 登录邮箱
- 密码	`password`: 登录密码
- 角色	`role`: billing_admin/operations_admin

6.3 删除管理员

功能项	说明
功能名称	删除管理员
功能描述	删除指定的管理员账号
API接口	`DELETE /api/admin/admins/{adminId}`
确认机制	二次确认弹窗

6.4 角色权限配置

功能项	说明
功能名称	配置角色访问权限
功能描述	设置不同角色可访问的功能模块
可配置模块
- 概览	overview
- 租户管理	tenants
- 资源管理	resources
- 计费	billing
- 设置	settings

默认角色权限

角色	默认权限
计费管理员	overview, tenants, billing
运营管理员	overview, tenants, resources

七、通用功能

7.1 多语言支持

功能项	说明
功能名称	中英文切换
支持语言
- 英文	English (en)
- 中文	中文 (zh)
存储方式	Context状态管理

7.2 页面导航

Tab名称	路由标识	功能说明
仪表板	overview	统计概览和Agent资源
我的租户	tenants	租户管理
资源管理	resources	Agent和模型资源
计费	billing	计费统计和记录
设置	settings	管理员和权限配置

八、API接口汇总

8.1 认证相关

接口	方法	路径	说明
登录	POST	`/api/auth/login`	用户登录
登出	POST	`/api/auth/logout`	用户登出

8.2 租户管理

接口	方法	路径	说明
获取租户列表	GET	`/api/channel/tenants`	获取渠道下所有租户
创建租户	POST	`/api/channel/tenants/create`	创建新租户
删除租户	DELETE	`/api/channel/tenants/{tenantId}`	删除租户
分配资源	PUT	`/api/channel/tenants/{tenantId}/resources`	分配Agent和模型资源
充值	POST	`/api/channel/tenants/{tenantId}/recharge`	为租户充值
设置授信	PUT	`/api/channel/tenants/{tenantId}/credit`	设置授信额度
更新计费	PUT	`/api/channel/tenants/{tenantId}/billing`	更新计费设置
更新状态	PUT	`/api/channel/tenants/{tenantId}/status`	更新租户状态
更新权限	PUT	`/api/channel/tenants/{tenantId}/permissions`	更新租户权限

8.3 资源管理

接口	方法	路径	说明
获取供应商列表	GET	`/api/channel/providers`	获取可用模型供应商
申请供应商	POST	`/api/channel/providers/apply`	申请使用供应商
获取申请列表	GET	`/api/channel/providers/applications`	获取申请记录
申请资源	POST	`/api/channel/resources/apply`	通用资源申请
获取Agent资源	GET	`/api/admin/resources/agents`	获取Agent资源列表

8.4 计费统计

接口	方法	路径	说明
获取计费统计	GET	`/api/channel/billing/stats`	获取租户计费统计

8.5 管理员管理

接口	方法	路径	说明
获取管理员列表	GET	`/api/channel/admins`	获取渠道管理员
创建管理员	POST	`/api/channel/admins/create`	创建管理员
删除管理员	DELETE	`/api/admin/admins/{adminId}`	删除管理员

九、待后端完善的功能点

9.1 统计数据接口

需求	说明
月度收入统计	需要专门的接口返回渠道月度收入
佣金统计	需要接口返回渠道累计佣金
渠道专用Agent资源接口	当前使用admin接口，建议提供渠道专用接口

9.2 权限配置持久化

需求	说明
角色权限保存	当前权限配置仅在前端状态管理，需要后端接口持久化
权限验证	后端需要根据角色权限控制API访问

9.3 数据导出功能

需求	说明
导出接口	计费数据导出需要后端支持生成Excel/CSV/PDF文件

十、数据模型参考

10.1 租户数据结构

interface Tenant {
  id: string
  name: string
  email: string
  status: "active" | "suspended" | "inactive"
  plan: "enterprise" | "professional" | "starter" | "free"
  users: number
  revenue: string  // 如 "$3,200"
  balance?: string
  creditLimit?: string
  createdAt?: string
}

10.2 Agent资源数据结构

interface AgentResource {
  id: string
  name: string
  description?: string
  status: "active" | "idle"
  cpu?: number      // 核心数
  memory?: number   // GB
  quantity?: number // 可用数量
  available?: number
  maxInstances?: number
  usage?: {
    cpu: number     // 百分比
    memory: number  // 百分比
  }
}

10.3 模型供应商数据结构

interface ModelProvider {
  id: string
  name: string
  provider?: string  // openai, anthropic等
  type?: string
  status: "active" | "pending"
  isActive?: boolean
  supportedModels?: string[]
  rpm: number
  tpm: number
  hasAccess?: boolean
  pendingApplication?: boolean
}

10.4 计费统计数据结构

interface BillingStats {
  tenantStats: Array<{
    tenantId: string
    tenantName: string
    calls: number
    totalEU: number
    totalCost: number
  }>
  callRecords: Array<{
    timestamp: string
    tenantName: string
    agentType: string
    duration: number  // 秒
    eu: number
    price: number
  }>
}

10.5 管理员数据结构

interface ChannelAdmin {
  id: string
  name: string
  email: string
  role: "channel_admin" | "billing_admin" | "operations_admin"
  status?: "active" | "inactive"
}

附录：前端源文件参考

文件路径	说明
`app/channel/dashboard/page.tsx`	渠道仪表板主页面（约2900行）
`app/channel/login/page.tsx`	渠道登录页面
`app/channel/layout.tsx`	渠道布局组件
`lib/api-client.ts`	API客户端封装

文档生成时间: 2026-01-05 基于前端代码版本分析

17 KiB Raw Blame History Unescape Escape

渠道端平台业务功能文档

文档概述

一、用户认证模块

1.1 渠道登录

1.2 退出登录

二、仪表板模块（Dashboard / Overview）

2.1 统计概览卡片

2.2 可分配Agent概览

三、租户管理模块（My Tenants）

3.1 租户列表

3.2 创建租户

3.3 查看租户详情

3.4 删除租户

3.5 资源分配

3.5.1 Agent配额分配

3.5.2 自定义Agent资源配置

3.5.3 模型配额分配

3.6 租户充值

3.7 授信额度设置

3.8 计费管理

订阅层级说明

四、资源管理模块（Resource Management）

4.1 Agent计算资源

4.2 模型管理

4.3 资源申请

4.3.1 模型供应商申请

4.3.2 Agent配额申请

五、计费管理模块（Billing）

5.1 租户计费统计

租户统计字段

5.2 调用记录明细

调用记录字段

5.3 筛选功能

5.4 时间查询

5.5 数据导出

六、系统设置模块（Settings）

6.1 管理员列表

6.2 创建管理员

6.3 删除管理员

6.4 角色权限配置

默认角色权限

七、通用功能

7.1 多语言支持

7.2 页面导航

八、API接口汇总

8.1 认证相关

8.2 租户管理

8.3 资源管理

8.4 计费统计

8.5 管理员管理

九、待后端完善的功能点

9.1 统计数据接口

9.2 权限配置持久化

9.3 数据导出功能

十、数据模型参考

10.1 租户数据结构

10.2 Agent资源数据结构

10.3 模型供应商数据结构

10.4 计费统计数据结构

10.5 管理员数据结构

附录：前端源文件参考

17 KiB

Raw Blame History