AI 平台接口文档

本文档覆盖平台所有业务模块的 REST API 接口定义,包含请求参数、响应结构、数据模型和使用示例。


文档导航

基础规范

文件 说明
00-overview.md 通用规范:Base URL、认证方式、统一响应格式、错误码体系、分页规范
00b-portal-guide.md 双端说明:用户控制台 vs 平台管理端,功能页面与 API 映射
00c-tech-stack.md 技术栈方案(已选定方案 C:Python FastAPI 全栈)
00d-preparation-checklist.md 上线前准备清单(域名/备案/第三方凭证/基础设施)
00e-baofoo-sms-api.md 宝付短信渠道接口(三环境地址 + 参数说明 + Python 示例)

用户与认证

文件 模块 主要功能
01-user-api.md 用户模块 注册、个人信息、实名认证、企业认证、企业成员管理、API Key
02-auth-api.md 授权模块 登录/登出、Token 刷新、第三方 OAuth、账号绑定、企业 SSO、RBAC

财务

文件 模块 主要功能
03-wallet-api.md 钱包模块 余额查询、充值(支付宝/微信/宝付)、代金券、发票申请
04-transaction-api.md 交易模块 交易记录、交易详情、统计、导出
05-order-api.md 订单模块 创建订单、支付、取消、退款、状态查询
06-billing-api.md 计费模块 计费规则、用量统计、月度账单、费用预估
07-accounting-api.md 账务模块 收支报表、总账流水、对账管理、增值税发票审核

会员与营销

文件 模块 主要功能
08-member-api.md 会员模块 套餐列表、订阅、续费、取消、会员权益
14-marketing-api.md 营销模块 代金券活动、券类型、批量生成、自动发放规则、手动发放、统计

模型与 Token

文件 模块 主要功能
10-token-api.md Token 模块 用量仪表盘、API Key 统计、Top 10、平台定价、第三方比价
11-model-api.md 模型模块 提供商管理、模型管理、对话(SSE 流式)、限流、请求队列、降级策略

平台基础设施

文件 模块 主要功能
09-gateway-api.md API 网关 路由规则、全局限流、访问日志、Webhook、审计日志
12-notification-api.md 通知模块 通知记录、偏好设置、广播、模板管理
13-message-center-api.md 消息中心 收件箱、分类、搜索、SSE 实时推送、公告管理

快速开始

认证方式

所有接口(除登录/注册外)均需携带认证头:

# 用户界面操作(JWT Token)
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

# 程序调用模型接口(API Key)
Authorization: Bearer sk-prod-xxxxxxxxxxxxxxxx

基础 URL

Base URL
用户控制台 API https://api.example.com/api/v1
平台管理端 API https://api.example.com/admin/v1

统一响应格式

{
  "code": 0,
  "message": "success",
  "data": {},
  "request_id": "req_550e8400-e29b-41d4-a716",
  "timestamp": 1704067200
}

错误码速查

范围 分类
1xxx 认证 / 授权错误
2xxx 用户业务错误
3xxx 支付 / 钱包错误
4xxx 模型 / Token 错误
5xxx 网关 / 限流错误
6xxx 账务 / 计费错误

详见 00-overview.md


模块关系图

用户模块 ──── 授权模块(登录/OAuth/RBAC)
     │
     ├── 钱包模块 ──── 交易模块 ──── 账务模块
     │       └────── 订单模块 ──── 计费模块
     │
     ├── 会员模块 ──── 营销模块(代金券)
     │
     ├── Token 模块 ──── 计费模块
     │
     ├── 模型模块(提供商 → 模型 → 对话 → 限流/队列/降级)
     │
     ├── API 网关(路由 / 限流 / Webhook / 审计)
     │
     ├── 通知模块(邮件 / 短信 / 站内信)
     │
     └── 消息中心(收件箱 / 公告)

变更记录

版本 日期 说明
v1.0 2024-01 初始版本,覆盖 14 个业务模块